Skip to content
PATCH /unified/marketing-automation/contacts/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

list_id
1 supported1 required
Mailchimp
required
Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

addressesobject[]

The contact's addresses

2 supported
Constant Contact
supported
Mailchimp
supported
citystring

The contact's city

countrystring

The contact's country

postal_codestring

The contact's postal code

statestring

The contact's state

street_1string

The contact's first line of street address

street_2string

The contact's second line of street address

typestring

The address type

campaignobject
1 supported
GetResponse
supported
idstring
emailstring

The contact's email

3 supported
Constant Contact
supported
GetResponse
supported
Mailchimp
supported
first_namestring

The contact's first name

2 supported
Constant Contact
supported
Mailchimp
supported
last_namestring

The contact's last name

2 supported
Constant Contact
supported
Mailchimp
supported
listsobject[]

The lists that the contact is subscribed to

References: Lists → id
1 supported
Constant Contact
supported
idstring

The list's unique identifier

phonesobject[]

The contact's phone numbers

2 supported
Constant Contact
supported
Mailchimp
supported
phonestring

The phone number

typestring

The phone number type

remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

statusstring

The contact's subscription status

2 supported
Constant Contact
supported
Mailchimp
supported
tagsobject[]

The contact's tags

References: Tags → id
2 supported
Constant Contact
supported
Mailchimp
supported
idstring

The tag's unique identifier

namestring

The tag's name

update_sourcestring

The source for the update

Possible values:
AccountContact
1 supported1 required
Constant Contact
required
AccountContact

Response Body

idstring
required·

The contact's unique identifier

3 supported
Constant Contact
supported
GetResponse
supported
Mailchimp
supported
addressesobject[]

The contact's addresses

2 supported
Constant Contact
supported
Mailchimp
supported
citystring

The contact's city

countrystring

The contact's country

postal_codestring

The contact's postal code

statestring

The contact's state

street_1string

The contact's first line of street address

street_2string

The contact's second line of street address

typestring

The address type

created_atstring · date-time

The date and time of the contact's creation

2 supported
Constant Contact
supported
GetResponse
supported
emailstring

The contact's email

3 supported
Constant Contact
supported
GetResponse
supported
Mailchimp
supported
first_namestring

The contact's first name

2 supported
Constant Contact
supported
Mailchimp
supported
last_namestring

The contact's last name

2 supported
Constant Contact
supported
Mailchimp
supported
listsobject[]

The lists that the contact is subscribed to

References: Lists → id
1 supported
Constant Contact
supported
idstring

The list's unique identifier

namestring

The contact's full name

3 supported
Constant Contact
supported
GetResponse
supported
Mailchimp
supported
phonesobject[]

The contact's phone numbers

2 supported
Constant Contact
supported
Mailchimp
supported
phonestring

The phone number

typestring

The phone number type

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The contact's subscription status

2 supported
Constant Contact
supported
Mailchimp
supported
tagsobject[]

The contact's tags

References: Tags → id
2 supported
Constant Contact
supported
Mailchimp
supported
idstring

The tag's unique identifier

namestring

The tag's name

updated_atstring · date-time

The date and time of the contact's last update

2 supported
Constant Contact
supported
Mailchimp
supported
truto unified marketing-automation contacts '<resource_id>' \
  -m update \
  -a '<integrated_account_id>' \
  -b '{
  "email": "your_email",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "phones": [],
  "addresses": [],
  "lists": [],
  "tags": [],
  "update_source": "Account",
  "campaign": {},
  "status": "your_status",
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.update(
  'marketing-automation',
  'contacts',
  '<resource_id>',
  {
  "email": "your_email",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "phones": [],
  "addresses": [],
  "lists": [],
  "tags": [],
  "update_source": "Account",
  "campaign": {},
  "status": "your_status",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.update(
        "marketing-automation",
        "contacts",
        "<resource_id>",
        {
        "email": "your_email",
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "phones": [],
        "addresses": [],
        "lists": [],
        "tags": [],
        "update_source": "Account",
        "campaign": {},
        "status": "your_status",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X PATCH 'https://api.truto.one/unified/marketing-automation/contacts/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "your_email",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "phones": [],
  "addresses": [],
  "lists": [],
  "tags": [],
  "update_source": "Account",
  "campaign": {},
  "status": "your_status",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "email": "your_email",
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "phones": [],
  "addresses": [],
  "lists": [],
  "tags": [],
  "update_source": "Account",
  "campaign": {},
  "status": "your_status",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/marketing-automation/contacts/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/marketing-automation/contacts/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "email": "your_email",
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "phones": [],
    "addresses": [],
    "lists": [],
    "tags": [],
    "update_source": "Account",
    "campaign": {},
    "status": "your_status",
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())