Add a new subscriber
Describes the request and response details of this Sitecore Send API endpoint to add a new subscriber to an email list.
Request
Parameter |
In |
Type |
Required |
Description |
---|---|---|---|---|
|
header |
string |
true |
Determines the expected format and data type to retrieve the response data. Value: |
|
path |
string |
true |
The ID of the email list where you want to add a new subscriber. |
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
query |
string |
true |
The API key of your account. |
|
body |
string |
false |
The name of the new subscriber. |
|
body |
string |
true |
The email address of the new subscriber. |
|
body |
Boolean |
false |
When |
|
body |
array |
false |
A list of name-value pairs that match the subscriber’s custom fields defined in the email list. For example, if you have two custom fields for |
POST https://{hostname}/v3/subscribers/{MailingListID}/subscribe.{Format}?apikey=
Request body:
{
"Name": "Paul",
"Email": "someEmail@email.com",
"HasExternalDoubleOptIn": false,
"CustomFields": [
"Age=25",
"Country=USA"
]
}
Response
Status |
Description |
Headers |
Schema |
---|---|---|---|
|
The request is successful. |
|
N/A |
{
"Code": 0,
"Error": null,
"Context": {
"ID": "f582c388-7916-4890-a9ab-b592615ef095",
"Name": "Paul",
"Email": "someemail@email.com",
"CreatedOn": "/Date(1465379934028)/",
"UpdatedOn": "/Date(1465379934028)/",
"UnsubscribedOn": null,
"UnsubscribedFromID": null,
"SubscribeType": 1,
"SubscribeMethod": 2,
"CustomFields": [
{
"CustomFieldID": "728f6774-37ea-4d81-8607-ce8308136760",
"Name": "Age",
"Value": "25"
},
{
"CustomFieldID": "b6380e04-c3a6-425b-9931-d25897fa4752",
"Name": "Country",
"Value": "USA"
}
],
"RemovedOn": null
}
}
-
Code
- the response code. This is0
if successful. -
Error
- the response error message. This isnull
if successful. -
Context
- an object that contains all the following information for the new subscriber added to the email list:-
ID
- the ID of the subscriber. -
Name
- the name of the subscriber. -
Email
- the email address of the subscriber. -
CreatedOn
- the date-time the subscriber was added to the email list. -
UnsubscribedOn
- the date-time the subscriber was unsubscribed from the email list. This isnull
if not unsubscribed from the list. -
UnsubscribedFromID
- the ID that the subscriber is unsubscribed from. -
SubscribeType
- the status of the subscriber. For subscribed, this is1
, for unsubscribed, this is2
, for bounced, this is3
, and for removed, this is4
. -
SubscribeMethod
- the method used to subscribe the member to the email list. For subscription forms, this is0
, for file imports, this is1
, for manually added, this is2
. -
CustomFields
- a list containing the custom fields of the new subscriber. Each custom field contains the following:-
CustomFieldID
- the ID of the custom field. -
Name
- the name of the custom field. -
Value
- the value of the custom field.
-
-
RemovedOn
- the date-time the subscriber was removed from the email list.
-