Appearance

Create Contacts ​

Endpoint ​

http
POST /unified/marketing-automation/contacts
Integrations supported
  • Constant Contact
  • GetResponse
  • Mailchimp

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

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
list_id
string

The list's unique identifier

Required in
  • Mailchimp

Request Body ​

Refer Writing data using Unified APIs

email
string

The contact's email

Required in
  • Constant Contact
  • GetResponse
  • Mailchimp
first_name
string

The contact's first name

Supported in
  • Constant Contact
  • Mailchimp
last_name
string

The contact's last name

Supported in
  • Constant Contact
  • Mailchimp
phones
object[]

The contact's phone numbers

Supported in
  • Constant Contact
  • Mailchimp
phone
string

The phone number

type
string

The phone number type

addresses
object[]

The contact's addresses

Supported in
  • Constant Contact
  • Mailchimp
street_1
string

The contact's first line of street address

street_2
string

The contact's second line of street address

city
string

The contact's city

state
string

The contact's state

country
string

The contact's country

postal_code
string

The contact's postal code

type
string

The address type

lists
object[]

The lists that the contact is subscribed to

Supported in
  • Constant Contact
id
string

The list's unique identifier

campaign
object
Required in
  • GetResponse
id
string
status
string

The status of the contact if it is new

Supported in
  • Mailchimp
tags
object[]

The contact's tags

Supported in
  • Mailchimp
id
string

The tag's unique identifier

name
string

The tag's name

remote_data
object

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.

Response Body ​

id
string
REQUIRED · 

The contact's unique identifier

Supported in
  • GetResponse
  • Mailchimp
first_name
string

The contact's first name

Supported in
  • Mailchimp
last_name
string

The contact's last name

Supported in
  • Mailchimp
name
string

The contact's full name

Supported in
  • GetResponse
  • Mailchimp
email
string

The contact's email

Supported in
  • GetResponse
  • Mailchimp
phones
object[]

The contact's phone numbers

Supported in
  • Mailchimp
phone
string

The phone number

type
string

The phone number type

addresses
object[]

The contact's addresses

Supported in
  • Mailchimp
street_1
string

The contact's first line of street address

street_2
string

The contact's second line of street address

city
string

The contact's city

state
string

The contact's state

country
string

The contact's country

postal_code
string

The contact's postal code

type
string

The address type

lists
object[]

The lists that the contact is subscribed to

id
string

The list's unique identifier

tags
object[]

The contact's tags

Supported in
  • Mailchimp
id
string

The tag's unique identifier

name
string

The tag's name

status
string

The contact's subscription status

Supported in
  • Mailchimp
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • Mailchimp
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • GetResponse
remote_data
object

Raw data returned from the remote API call.