Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
john.doe@example.com | null | body | string(100) | ||||
first_name | John | null | First name | body | string(50) | ||
last_name | Doe | null | Last name | body | string(50) | ||
reactivate | true | false | Reactivates subscriber | body | boolean | ||
company | Example | null | Company name | body | string(50) | ||
salutation | Mr. | null | Salutation | body | string(100) | ||
alias | John | null | Alias | body | string(100) | ||
anniversary | 2016-01-07T00:00:00+01:00 | null | Anniversary | body | ISO 8601 | ||
vip | true | false | VIP subscriber | body | boolean | ||
preferred_com | 1 | 1 | Prefferred communication | body | reference: preferred_com | ||
contacts | null | Contacts - others | body | array | |||
contacts: | contact | City 1 | null | Contact | body | string(50) | |
contacts: | contact_type | 99 | 99 | Contact type | body | reference: contact_type | |
tags | null | Tags | body | array | |||
tags: | tag | my-group | null | Tag | body | string(50) | |
lists | null | Distribution lists | body | array | |||
lists: | list | 82eaba02-1c49-48d1-942d-7eb32a3722d7 | null | List ID | body | string(38) | |
fields | null | Custom fields | body | array | |||
fields: | field_id | 591f290e-a2ee-7210-e77b-9245c9290dfc | null | Custom field ID or Custom field code | body | string(50) | |
fields: | auto_create_value | false | true | Automatically creates new value for 'list' and 'select' custom field type | body | boolean | |
fields: | values | null | Custom field values | body | array | ||
fields: | values: value | Lorem ipusm | null | Custom field value | body | mixed |
{
"email": "mike.johnson@example.com",
"first_name": "Mike",
"last_name": "Johnson",
"company": "My Company",
"lists": [
"c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
"5d16b01e-6927-651b-ef08-548485a0fd55"
],
"contacts": [
{
"contact": "My City",
"contact_type": 1
}
],
"tags": [
"my-tag"
],
"fields": [
{
"field_id": "591f290e-a2ee-7210-e77b-9245c9290dfc",
"values": [
10
]
}
]
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
record_status | integer(3) | record_status | Subscriber creation status | |
contacts | array | Contacts - others | ||
contacts: | contact | string(50) | Contact | |
contacts: | record_status | integer(3) | record_status | Contact creation status |
tags | array | Tags | ||
tags: | tag | string(50) | Tag | |
tags: | record_status | integer(3) | record_status | Tag creation status |
lists | array | Distribution lists | ||
lists: | list_id | string(38) | List ID | |
lists: | record_status | integer(3) | record_status | List creation status |
fields | array | Custom fields | ||
fields: | field_id | string(38) | Custom field ID | |
fields: | code | string(30) | Custom field code | |
fields: | record_status | integer(3) | record_status | Custom field record status |
fields: | values | array | Custom field values | |
fields: | values: value | mixed | Custom field value | |
fields: | values: value_status | integer(3) | record_status | Custom field value assignment Status |
Code | Status | Example Body |
---|---|---|
201 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
john.doe@example.com | null | Email or Email ID | body | string(100) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(100) | Email ID | ||
first_name | string(50) | First name | ||
last_name | string(50) | Last name | ||
email_status | integer(2) | contact_status | Email status | |
subscriber_status | integer(2) | contact_status | Subscriber status | |
company | string(50) | Company name | ||
salutation | string(100) | Salutation | ||
alias | string(100) | Alias | ||
anniversary | ISO 8601 | Anniversary | ||
vip | boolean | VIP subscriber | ||
preferred_com | integer(3) | preferred_com | Prefferred communication | |
contacts | array | Contacts - others | ||
contacts: | contact | string(50) | Contact | |
contacts: | contact_type | integer(2) | contact_type | Contact type |
tags | array | Tags | ||
tags: | tag | string(50) | Tag | |
lists | array | Distribution lists | ||
lists: | list | string(38) | List ID | |
lists: | name | string(100) | List name | |
lists: | date_from | ISO 8061 | Assigned since | |
fields | array | Custom fields | ||
fields: | field_id | string(50) | Custom field ID | |
fields: | code | string(30) | Custom field code | |
fields: | values | array | Custom field values | |
fields: | values: value | mixed | Custom field value |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
john.doe@example.com | null | Email or Email ID | path | string(100) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
john.doe@example.com | null | Email or Email ID | path | string(100) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
contact_status | 99 | 1 | Contact status | Query | reference: contact_status | ||
status_change | 2016-01-29T00:00:00+01:00 | null | Contacts with status changes after this date | Query | ISO 8061 | ||
count | 10 | 100 | Count of records | Query | integer(4) max(1.000) | ||
offset | 0 | 0 | Offset | Query | integer(4) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(100) | Email ID | ||
first_name | string(50) | First name | ||
last_name | string(50) | Last name | ||
email_status | integer(2) | contact_status | Email status | |
email_status_change | ISO 8061 | Email status changed | ||
subscriber_status | integer(2) | contact_status | Subscriber status | |
subscriber_status_change | ISO 8061 | Subscriber status changed | ||
company | string(50) | Company name | ||
salutation | string(100) | Salutation | ||
alias | string(100) | Alias | ||
anniversary | ISO 8601 | Anniversary | ||
vip | boolean | VIP subscriber | ||
preferred_com | integer(3) | preferred_com | Prefferred communication | |
contacts | array | Contacts - others | ||
contacts: | contact | string(50) | Contact | |
contacts: | contact_type | integer(2) | contact_type | Contact type |
tags | array | Tags | ||
tags: | tag | string(50) | Tag | |
lists | array | Distribution lists | ||
lists: | list | string(38) | List ID | |
lists: | name | string(100) | List name | |
lists: | date_from | ISO 8061 | Assigned since | |
fields | array | Custom fields | ||
fields: | field_id | string(50) | Custom field ID | |
fields: | code | string(30) | Custom field code | |
fields: | values | array | Custom field values | |
fields: | values: value | mixed | Custom field value |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
5ff42ca6-1965-49ed-97d0-b2b568c88bfd | null | Email or Email ID | body | string(100) | |||
first_name | Mike | null | First name | body | string(50) | ||
last_name | Johnson | null | Last name | body | string(50) | ||
salutation | Mr. | null | Salutation | body | string(100) | ||
alias | John | null | Alias | body | string(100) | ||
anniversary | 2016-01-07T00:00:00+01:00 | null | Anniversary | body | ISO 8601 | ||
vip | true | false | VIP subscriber | body | boolean | ||
preferred_com | 1 | 1 | Prefferred communication | body | reference: preferred_com | ||
contacts | null | Contacts - others | body | array | |||
contacts: | contact | City 1 | null | Contact | body | string(50) | |
contacts: | contact_type | 99 | 99 | Contact type | body | reference: contact_type | |
tags | null | Tags | body | array | |||
tags: | tag | my-group | null | Tag | body | string(50) | |
lists | null | Distribution lists | body | array | |||
lists: | list | 82eaba02-1c49-48d1-942d-7eb32a3722d7 | null | List ID | body | string(38) | |
fields | null | Custom fields | body | array | |||
fields: | field_id | 591f290e-a2ee-7210-e77b-9245c9290dfc | null | Custom field ID or Custom field code | body | string(50) | |
fields: | merge | false | true | Replace already assigned values with those in request | body | boolean | |
fields: | auto_create_value | false | true | Automatically creates new value(s) for 'list' and 'select' type | body | boolean | |
fields: | values | null | Custom field values | body | array | ||
fields: | values: value | Lorem ipusm | null | Custom field value | body | mixed |
{
"first_name": "Mike",
"last_name": "Johnson",
"company": "My Company",
"lists": [
"c2d73a4d-b66b-17c3-801e-8769f22e1fc2",
"5d16b01e-6927-651b-ef08-548485a0fd55"
],
"contacts": [
{
"contact": "My City",
"contact_type": 1
}
],
"tags": [
"my-tag"
],
"fields": [
{
"field_id": "591f290e-a2ee-7210-e77b-9245c9290dfc",
"merge": false,
"values": [
10
]
}
]
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
record_status | integer(3) | record_status | Subscriber creation status | |
contacts | array | Contacts | ||
contacts: | contact | string(50) | Contact | |
contacts: | record_status | integer(3) | record_status | Contact creation status |
tags | array | Contacts | ||
tags: | tag | string(50) | Tag | |
tags: | record_status | integer(3) | record_status | Tag creation status |
lists | array | Contacts | ||
lists: | list_id | string(38) | List ID | |
lists: | record_status | integer(3) | record_status | List creation status |
fields | array | Custom fields | ||
fields: | field_id | string(50) | Custom field ID | |
fields: | code | string(30) | Custom field code | |
fields: | record_status | integer(3) | record_status | Custom field record status |
fields: | values | array | Custom field values | |
fields: | values: value | mixed | Custom field value | |
fields: | values: value_status | integer(3) | record_status | Custom field value assignment status |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c | null | Email or Email ID | path | string(100) | |||
list_id | 882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c | null | List ID | path | string(38) |
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
list_id | string(38) | List ID | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c | null | Email or Email ID | path | string(100) | |||
tag | example_tag | null | Tag | body | string(100) |
{
"tag": "example_tag"
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
string(100) | ||||
email_id | string(38) | Email ID | ||
tag | string(100) | Tag | ||
message | string | Message |
Code | Status | Example Body |
---|---|---|
200 | OK |
|
Name | Example Value | Default Value | Description | Type | Data Type | Required | |
---|---|---|---|---|---|---|---|
john@doe.com | null | Email or Email ID | path | string(100) | |||
fields | empty | Custom fields | body | array | |||
fields: | field_id | 882f7ed8-0eaf-4d36-6f0d-ea91b1bd239c | null | Custom field ID | body | string(36) | |
fields: | code | lorem_ipsum | null | Custom field code | body | string(30) | |
fields: | type | 1 | null | Custom field type (required only if it's a new custom field) | body | reference: field_type | |
fields: | merge | false | true | Merge values | body | boolean | |
fields: | values | empty | Custom field values | body | array | ||
fields: | values: value | 100 | null | Subscriber value | body | mixed |
{
"fields": [
{
"code": "lorem_ipsum",
"merge": false,
"type": 1,
"values": [
100
]
}
]
}
Name | Data Type | Reference | Description | |
---|---|---|---|---|
email_id | string(36) | Email ID | ||
string(100) | ||||
fields | array | Custom fields | ||
fields: | field_id | string(36) | Custom field ID | |
fields: | code | string(30) | Custom field code | |
fields: | values | array | Subscriber values | |
fields: | values: value | mixed | Value | |
fields: | values: value_status | integer(3) | record_status | Value status |
Code | Status | Example Body |
---|---|---|
200 | OK |
|