Skip to main content
POST
Get form
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
type
enum<string>
required

The form type:

  • prechat and postchat — Survey forms.
  • offline, queued, email, ask_for_email, and ask_for_email_mm — Custom forms.
Available options:
prechat,
postchat,
offline,
queued,
email,
ask_for_email,
ask_for_email_mm
group_id
integer
default:0

The ID of the group that owns the form.

Response

200 - application/json

The requested form.

form
object
required