ExternalFormFillSessions: CreateExternalFormFillSession

Returns a URL for a new external form fill session, based on the roomId and formId that you specify in the formFillSessionForCreate request body.

Request

HTTP request

POST /v2/accounts/{accountId}/external_form_fill_sessions

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
201

Created

ExternalFormFillSession
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Forms::CreateExternalFormFillSession

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

ExternalFormFillSession

Contains the URL for the new form fill session.

urlstring

The URL for the new form fill session.

ExternalFormFillSessionForCreate

Contains the details required to create a form fill session.

formIdstring

(Required) The id of the form.

Example: 5be324eb-8e0c-4f45-adc1-208065181be9

roomIdinteger

(Required) The id of the room.

xFrameAllowedUrlstring

(Optional) This property specifies the origin on which the page is allowed to display in a frame.

}} />