Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 13:14 UTC

Create a Custom Field for a Contact Schema

POST /:account/contact_schemas/:contact_schema_slug

Custom Fields denote the type, title, and description of attributes that belong to Contact Schemas. When data is imported from an external source, only attributes that exist as Custom Fields will be saved onto the Contact records.

Examples

Creating a Custom Field

Request

POST /my_account/contact_schemas/bullhorn/Candidate

Body

{
   "type": "url",
   "title": "Calendar Link",
   "description": "Your personal calend.ly url."
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/contact_schemas/bullhorn/Candidate
     -d '{json: "body"}' 

Response

Status

201

Response Type

CustomField

Example
{
  "@type": "CustomField",
  "@context": "/contexts/CustomField.jsonld",
  "id": "/my_account/contact_schemas/bullhorn/Candidate/calendar-link",
  "slug": "calendar-link",
  "title": "Calendar Link",
  "type": "url",
  "description": "Your personal calend.ly url.",
  "createdAt": "2020-10-15T20:07:20.862Z",
  "inUse": false
}

© 2021 TextUs