The list of supported fields for contact update is the same as fields for Patch Contact
endpoint from OnVoard API.
- For creating a new contact,
email
is the only required field that must be provided. - For updating existing contact, OnVoard will only update provided fields.
These are the supported fields:
Field | Type | Description |
string | Email of contact. Must be unique within account. | |
name | string | Name of contact. |
phone | string | Phone for contact. |
email_unsubscribed | boolean | If contact has unsubscribed from your emails. |
lists[] | string array | Array of list IDs to assign contact. |
tags[] | string array | List of tag names to assign contact. For example: ["tag-1", "tag-2"] . Our system will automatically create new tag if name doesn't exist. |
properties[] | object array | List of contact properties. |
Here's a sample payload. Keep in mind that payload must be a valid JSON object.
{
"name": "John Doe",
"phone": "+1-202-555-0172",
"tags": ["Customer"],
"properties": [{
"type": "country",
"value": "US"
}]
}