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
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 field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this member object |
created_at | string (date-time) | No | The date that this member object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this member object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The name of the member |
first_name | string | No | |
last_name | string | No | |
company | string | No | The name of the company/organization the member belongs to |
emails | MarketingEmail[] | No | An array of email addresses for this member |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
list_ids | string[] | No | An array of list IDs associated with this member |
tags | string[] | No | An array of tags associated with this member |
status | enum | No | Values: 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"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not 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