Create a member

POST/martech/{connection_id}/member

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

A member represents a person

idstring
Unique identifier for this member object
created_atdate-time
The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The name of the member
first_namestring
last_namestring
companystring
The name of the company/organization the member belongs to
emails array
An array of email addresses for this member
list_idsstring array
An array of list IDs associated with this member
tagsstring array
An array of tags associated with this member
status enum
Valid values:
"SUBSCRIBED"
"UNSUBSCRIBED"
"CLEANED"
"PENDING"
"TRANSACTIONAL"

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this member object
created_atstring (date-time)NoThe date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the member
first_namestringNo
last_namestringNo
companystringNoThe name of the company/organization the member belongs to
emailsMarketingEmail[]NoAn array of email addresses for this member
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
list_idsstring[]NoAn array of list IDs associated with this member
tagsstring[]NoAn array of tags associated with this member
statusenumNoValues: SUBSCRIBED, UNSUBSCRIBED, CLEANED, PENDING, TRANSACTIONAL

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/martech/5de520f96e439b002043d8dc/member',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?