Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Updated Mon Feb 6th 2023, 19:36 UTC

Create

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 '{
   "type": "url",
   "title": "Calendar Link",
   "description": "Your personal calend.ly url."
}'

Response

Status

201

Response Type

ContactField

Example Body

{
  "@type": "ContactField",
  "@context": "/contexts/ContactField.jsonld",
  "id": "/my_account/contact_schemas/bullhorn/Candidate/calendar-link",
  "slug": "calendar-link",
  "title": "Calendar Link",
  "type": "url",
  "description": "Your personal calend.ly url.",
  "externalId": false,
  "externalLink": false,
  "displayOrder": null
}

© 2023 TextUs