Update Form

post

https://api.campaignrefinery.com/rest/forms/update_form/{form_uuid}

Updates name, campaign attachment, and/or form_code_* configuration on an existing form. The form is identified by form_uuid in the URL path. All body fields are optional -- only fields that are present are written. form_name must remain unique within the account (the duplicate check ignores the form being updated). Response is UUID-only.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

form_uuid

uuid

required

UUID of the form to update. Must belong to the authenticated account.

Body Params

form_name

string

length between 2 and 100

Optional. New display name. Must be unique within the authenticated account (excluding the form being updated).

campaign_uuid

uuid | null

Optional. UUID of a campaign in the authenticated account to attach the form to. Pass null to detach.

form_code_allow_duplicates

boolean

form_code_success_url

string | null

form_code_error_url

string | null

form_code_include_first_last_name

boolean

form_code_include_full_name

boolean

form_code_name_required

boolean

form_code_include_all_enabled

boolean

form_code_include_all_validation

boolean

form_code_pass_uuid_on_success

boolean

form_code_include_invisible_recaptcha

boolean

form_code_include_invisible_recaptcha_site_key

string | null

form_code_include_invisible_recaptcha_site_secret

string | null

Responses

401

Missing or invalid bearer token.

500

Internal server error.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Form updated.

404No form with the supplied UUID exists in the authenticated account.

422Validation error. Common causes: duplicate form_name (excluding self), invalid campaign_uuid, oversized recaptcha keys.