Explore

Retrieve all custom fields

GET/engage/customfields

Gets information about all custom fields within your CRM configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 25,
  "count": 2,
  "offset": 23,
  "results": [
    {
      "id": "56b8767f46fc51070cb887f0",
      "name": "Wedding Date",
      "dataformat": "date",
      "values": []
    },
    {
      "id": "56b876bc46fc51070cb887f8",
      "name": "Wedding Show",
      "dataformat": "text",
      "values": []
    }
  ]
}

Lookup a specific custom field

GET/engage/customfields/{id}

Gets information about a specific custom field within your CRM configuration.

Parameters

The unique id for the custom field

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "56b8767f46fc51070cb887f0",
  "name": "Wedding Date",
  "dataformat": "date",
  "values": []
}

Create a new custom field

POST/engage/customfields

Creates a new custom field within your CRM configuration.

Request body

Custom Field

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female"
  ]
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac37dc49b04b313141b629b",
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female"
  ]
}

Update a custom field

PUT/engage/customfields/{id}

Updates the settings for a specific custom field.

Parameters	id	The unique id for the custom field
Request body	Custom Field

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female",
    "Unisex"
  ]
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5ac37dc49b04b313141b629b",
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female",
    "Unisex"
  ]
}

Delete a custom field

DELETE/engage/customfields/{id}

Deletes a custom field from your CRM configuration.

Parameters

The unique id for the custom field

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8