Raw schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The person id to update."
},
"firstName": {
"description": "First name.",
"type": "string"
},
"lastName": {
"description": "Last name.",
"type": "string"
},
"fullName": {
"description": "Full name.",
"type": "string"
},
"description": {
"description": "Freeform description / notes.",
"type": "string"
},
"birthday": {
"description": "Birthday, formatted YYYY-MM-DD.",
"type": "string"
},
"gender": {
"type": "string",
"enum": [
"Male",
"Female",
"Unknown",
"Other"
],
"description": "Gender โ one of Male, Female, Unknown, Other."
},
"jobTitle": {
"description": "Job title.",
"type": "string"
},
"emails": {
"description": "Replace the person's email addresses.",
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"description": "Replace the person's phone numbers.",
"type": "array",
"items": {
"type": "string"
}
},
"addresses": {
"description": "Replace the person's addresses.",
"type": "array",
"items": {
"type": "string"
}
},
"urls": {
"description": "Replace the person's URLs.",
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"description": "Replace the person's groups (array of {id}).",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The group id."
}
},
"required": [
"id"
],
"description": "A reference to a group by id."
}
},
"companies": {
"description": "Replace the person's linked companies (array of {id} or {name}).",
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The company id."
}
},
"required": [
"id"
]
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The company name (creates/links by name)."
}
},
"required": [
"name"
]
}
],
"description": "A reference to a company by id or by name."
}
},
"customFieldValues": {
"description": "Custom field values, keyed by field.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}