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

HTTPcURLJavaScriptPython

GET /lead/form/custom HTTP/1.1
Host: api.taag.co
Accept: */*

200

Successful retrieval of custom lead form fields.

{
  "status": "success",
  "form_fields": [
    {
      "id": 1,
      "type": "text",
      "value": "text",
      "required": true
    }
  ]
}

Create a Custom Lead Form Field

post

Body

application/json

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

HTTPcURLJavaScriptPython

POST /lead/form/custom/field HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "profile_id": 1,
  "company_id": 1,
  "type": "heading",
  "value": "text",
  "required": false
}

200

Successful creation of the custom lead form field.

{
  "status": "success",
  "form_fields": [
    {
      "id": 1,
      "type": "text",
      "value": "text",
      "required": true
    }
  ]
}

Update a Custom Lead Form Field

put

Body

application/json

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

HTTPcURLJavaScriptPython

PUT /lead/form/custom/field HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "company_id": 1,
  "field_id": 1,
  "required": true
}

200

Successful update of the custom lead form field.

{
  "status": "success",
  "form_fields": [
    {
      "id": 1,
      "type": "text",
      "value": "text",
      "required": true
    }
  ]
}

Delete a Custom Lead Form Field

delete

Body

application/json

anyOptional

or

anyOptional

Responses

200

Successful deletion of the custom lead form field.

application/json

delete

/lead/form/custom/field

HTTPcURLJavaScriptPython

DELETE /lead/form/custom/field HTTP/1.1
Host: api.taag.co
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "profile_id": 1,
  "company_id": 1,
  "formfield_id": 1
}

200

Successful deletion of the custom lead form field.

{
  "status": "success",
  "form_fields": [
    {
      "id": 1,
      "type": "text",
      "value": "text",
      "required": true
    }
  ]
}