Follow

Overview

The Rest API supports the ability to manage Subscribers. The Rest API URI for Subscribers resource is in the format:

https://[siteurl]/rest/subscribers

Commands

API Commands for Subscriber management include:

Name

HTTP Method

Endpoint

Description

Create Subscriber POST /rest/subscribers Create a Subscriber
Update Subscriber PUT

/rest/subscribers/{subscriberId}
/rest/subscribers/{customerKey}
/rest/subscribers + Email and First Name in JSON

Update specific Subscriber by Subscriber ID, Customer Key, or Email and First Name
Delete Subscriber DELETE /rest/subscribers/{subscriberId}
/rest/subscribers/{customerKey}
/rest/subscribers + Email and First Name in JSON
Delete specific Subscriber by Subscriber ID, Customer Key, or Email and First Name
Get All Subscribers GET /rest/subscribers Get details for all Subscribers
Get Subscriber GET

/rest/subscribers/{subscriberId}
/rest/subscribers/{customerKey}
/rest/subscribers?filter

Get details for specific Subscriber by Subscriber ID, Customer Key, or any combination of Email, First Name, Last Name, Customer Key
Get Subscriptions  GET /rest/subscribers/{subscriberId}/subscriptions
/rest/subscribers/{customerKey}/subscriptions
Get all Subscriptions for a Subscriber by Subscriber ID or Customer Key
Report Subscriber Events GET /rest/subscribers/{subscriberId}/events?filter
/rest/subscribers/{customerKey}/events?filter
Get all Tracking Events for a Subscriber by Subscriber ID or Customer Key

Subscriber Data Fields

The following data fields may be set and viewed.  

Field Name

Methods

Description

Type

Example

Subscriber ID

PUT, GET, DELETE

Unique identifier of the Subscriber

Integer

"subscriberId": [subscriberId]

Account ID (Realm ID)

GET

Identifier of the Account in which the Subscriber exists.

Integer

"realmId": [realmId]

Email

POST, PUT, GET, DELETE

Email address of the Subscriber.

String 

"email": "[email]"

Customer Key

POST, PUT, GET, DELETE

Unique identifier for the Subscriber in Accounts in which Customer Key is required.

String 

"customerKey": "[customerKey]"

First Name

POST, PUT, GET, DELETE 

Subscriber first name

String 

"firstName": "[firstName]"

Last Name

POST, PUT, GET 

Subscriber last name.

String 

"lastName": "[lastName]"

Company

POST, PUT, GET 

Subscriber company.

String 

"company": "[company]"

Address 1

POST, PUT, GET

Subscriber address part 1.

String

"address1": "[address1]"

Address 2

POST, PUT, GET

Subscriber address part 2. 

String

"address": "[address2]"

City

POST, PUT, GET

Subscriber city.

String

"city": "[city]"

State

POST, PUT, GET

Subscriber state, four character limit.

String "state": "[stat]"

Zip

POST, PUT, GET

Subscriber zip or postal code.

String "zip": "[zip]"

Country

POST, PUT, GET

Subscriber country.

String

"country": "[country]"

Phone

POST, PUT, GET 

Subscriber phone number. 

String

"phone": "[phone]"

Fax

POST, PUT, GET 

Subscriber fax number.

String

"fax": "[fax]"

Created Date

GET 

Date Subscriber record first created.

Date/Time

"createdDate": "Mar 23, 2016 12:45:04 PM"

Updated Date

GET 

Date Subscriber record last updated.

Date/Time

"updatedDate": "Mar 23, 2016 12:45:04 PM"

MD5 Encryption

GET 

Encrypted Subscriber identifier.

String 

"md5Encryption": "[md5Encryption]"

SHA1 Encryption

GET 

Encrypted Subscriber identifier.

String 

"sha1Encryption": "[sha1Encryption]"

IP Address

GET 

Subscriber IP Address from last Open or Click tracking event.

String

"ipAddress": "[ipAddress]"

Custom Fields

POST, PUT, GET 

Custom data stored for Subscriber.

String, Integer, Float, Date

"customFieldName": "string"
"customFieldName": integer or float
"customFieldName": "date"

Skip

GET

Parameter to retrieve next set of results.  See Pagination for more details.

Integer 

"skip": 0

Max

GET

Max is not in use.

Integer 

"max": 0

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk