Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:49 UTC

Update a Custom Field for a Contact Schema

PUT /:account/contact_schemas/:contact_schema_slug/: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

Updating a Custom Field

Request

PUT /my_account/contact_schemas/bullhorn/Candidate/name

Body

{
  "title": "New title",
  "description": "My new field description"
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X PUT /my_account/contact_schemas/bullhorn/Candidate/name
     -d '{json: "body"}' 

Response

Status

200

Response Type

CustomField

Example
{
  "@type": "CustomField",
  "@context": "/contexts/CustomField.jsonld",
  "id": "/my_account/contact_schemas/bullhorn/Candidate/name",
  "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