Raw schema
{
"type": "object",
"properties": {
"identifier": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "The contact's UID or current email address."
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"email": {
"description": "New primary email.",
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"send_welcome_email": {
"description": "Send the portal invitation email if it was never sent.",
"type": "boolean"
},
"name_prefix": {
"type": "string",
"enum": [
"Mr.",
"Ms.",
"Mrs.",
"Miss",
"Mx.",
"Dr.",
"Prof.",
"Rev."
]
},
"home_email": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
]
},
"work_email": {
"anyOf": [
{
"type": "string",
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
{
"type": "null"
}
]
},
"phone": {
"description": "Primary phone (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"home_phone": {
"description": "Home phone (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"work_phone": {
"description": "Work phone (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"shop_phone": {
"description": "Shop phone (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"title": {
"description": "Job title (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"website": {
"description": "Website (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"background_info": {
"description": "Background info (null clears it).",
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"address_line_2": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"country": {
"description": "Country name, e.g. \"United States of America\".",
"anyOf": [
{
"type": "string",
"maxLength": 100
},
{
"type": "null"
}
]
},
"zip": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
]
}
},
"description": "Postal address; only the parts you pass are sent."
},
"tags": {
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": "Tags (replaces the record's tag list)."
},
"company_name": {
"description": "Link the contact to the CRM company with this name.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"create_company_if_not_exists": {
"description": "With company_name: create the company when none matches (default false).",
"type": "boolean"
},
"custom_fields": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"maxItems": 100,
"type": "array",
"items": {
"type": "string",
"maxLength": 500
}
},
{
"type": "null"
}
]
},
"description": "Custom field values keyed by the custom field UID (from the *_fields tool); text/date as a string, numbers as numbers, multi-select as an array."
}
},
"required": [
"identifier"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}