Sign in

v1

latestOpenAPI 3.0.32026-07-14490228.1 KB

Create Webform

This endpoint creates a new webform and associates it with the client.

post/webforms

Request body

namestring required

The name used to easily identify the segment. Allowed values are between 2 and 255 characters.

statusstring required

The status of the segment. Allowed values are active and inactive.

sequence_idinteger required

The associated sequence ID to trigger when the webform is submitted.

captcha_typestring

The type of captcha to include with the form. Allowed values are none, text, recaptcha.

button_textstring required

Text to display on the submit button for the webform. Allowed values are between 2 and 20 characters.

success_typestring required

The type of success handler to implement when the form is successfully submitted. Allowed values are send_message, redirect.

success_messagestring

The success message to return when the form is submitted. Required when success_type is set to send_message. Allowed values are between 2 and 255 characters.

success_redirect_urlstring

The success redirect implemented when the form is submitted. Required when success_type is set to redirect. Allowed values are between 2 and 255 characters.

Response

201

Example response

{
  "webform": {
    "name": "Test Webform 1",
    "guid": "8ca22d60-a1cb-11eb-9912-397dd439eff8",
    "button_text": "Test",
    "captcha_type": "none",
    "sequence_id": 1,
    "success_type": "send_message",
    "success_message": "Thanks!  You'll receive a call shortly from us running through the demo!",
    "status": "active",
    "id": 1
  }
}