Lead Custom Form Fields

Get Custom Lead Form Fields

get
Query parameters
profile_idintegerOptional

The ID of the profile for which to get the custom lead form fields (cannot be provided together with company_id)

company_idintegerOptional

The ID of the company for which to get the custom lead form fields (cannot be provided together with profile_id)

Responses
200

Successful retrieval of custom lead form fields.

application/json
get
/lead/form/custom
200

Successful retrieval of custom lead form fields.

Create a Custom Lead Form Field

post
Body
profile_idintegerOptional

The ID of the profile for which to create the custom lead form field (cannot be provided together with company_id)

company_idintegerOptional

The ID of the company for which to create the custom lead form field (cannot be provided together with profile_id)

typestring · enumRequired

The type of the custom lead form field

Possible values:
valuestringOptional

The value of the custom lead form field

requiredbooleanOptional

Whether the custom lead form field is required

Default: false
Responses
200

Successful creation of the custom lead form field.

application/json
post
/lead/form/custom/field
200

Successful creation of the custom lead form field.

Update a Custom Lead Form Field

put
Body
company_idintegerOptional

The ID of the company associated with the custom lead form field

field_idintegerRequired

The ID of the field to update

requiredbooleanRequired

Whether the field is required

Responses
200

Successful update of the custom lead form field.

application/json
put
/lead/form/custom/field
200

Successful update of the custom lead form field.

Delete a Custom Lead Form Field

delete
Body
anyOptional
or
anyOptional
Responses
200

Successful deletion of the custom lead form field.

application/json
delete
/lead/form/custom/field
200

Successful deletion of the custom lead form field.

Last updated