v1

OpenAPI 3.0.02026-08-04109109370.6 KB
Contacts (People)

Create a custom field

Creates a custom field to use for contacts.

post/contacts/customfield

Request body

{"stackTrail":"components:schemas:CustomFieldCreateInput:properties:name","oasType":"schema","type":"unknown","description":"The name of the custom fields"}
{"stackTrail":"components:schemas:CustomFieldCreateInput:properties:type","oasType":"schema","type":"unknown","description":"Email, location, phone, and URL are only applicable to leads."}
{"stackTrail":"components:schemas:CustomFieldCreateInput:properties:choices","oasType":"schema","type":"unknown","description":"For enums only. The possible values for the custom field."}
{"stackTrail":"components:schemas:CustomFieldCreateInput:properties:isMultiple","oasType":"schema","type":"unknown","description":"For enums only. Whether the custom field can have multiple values"}
idstring

The API ID of this entity, formatted {integer}-{entityType}

titlestring

Example request

{
  "id": "3-contacts",
  "title": "Custom Field Title"
}

Response

OK