Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Ocoya brand id from ocoya_list_brands. |
contacts | object[] | Yes | — |
consentConfirmed | boolean | Yes | Must be true: confirms everyone in the list agreed to receive emails. Ask the user; never assume it. |
groups | string[] | No | Group names to put every contact in; missing groups are created. |
consentText | string | No | Where the list came from, kept as the consent record. |
runWorkflows | boolean | No | Start workflows triggered by new or tagged contacts. Defaults to false. |
Request example
{
"name": "ocoya_import_contacts",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"contacts": [
{
"email": "jane@example.com",
"firstName": "Jane"
}
],
"consentConfirmed": true
}
}Returns
Returns the result of the call as JSON.