Last Updated: May 05, 2016
Fetching mail subscription status
The API returns mail subscription status for the given email address.
Request
HTTP Method | Resource URI |
---|---|
GET | https://{tenantName}.api.xomni.com/private/mail/subscription/{email}/status |
URI Parameters
Parameter Name | Description | Type | Conditions |
---|---|---|---|
Email Address | String |
Request Headers
Header Field Name | Description |
---|---|
Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-1, */*
|
Response
{ "PIIName":"XOMNI Guy" "StatusId":1, "PurposeTypeId":1, "IsSubscribable":false }
Response Body Description
Parameter Name | Description | Type |
---|---|---|
PIIName | If mail address is related to a valid PII, this field contains PII name. | String |
StatusId | Status of the mail address. See below for possible values. | Number |
PurposeTypeId | Last operation of the given email address. See below for the possible values. | Number |
IsSubscribable | Boolean field indicates that email address is subscribable again or not. If true, you can update email address status to subscribed state. | Boolean |
Possible values for StatusId
Value | Description |
---|---|
1 | User email is subscribed. User can recieve emails sent by XOMNI. |
2 | User is unsubscribed. You can update status to subscribed again if IsSubscribable field value is true. |
3 | You've reached the resubscribe limit for the current mail address. You can only resubscribe mail address again for a limited time. |
4 | A bounce mail notification recieved by XOMNI for the mail address. Mail address status is bounced. |
Possible values for PurposeTypeId
Value | Description |
---|---|
1 | Wishlist mailing is the last operation for the mail address. |
2 | Shopping cart mailing is the last operation for the mail address. |
Response Headers
Header Field Name | Description |
---|---|
Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Status Codes
A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:
Status Code | Description |
---|---|
400 (Bad Request) | Mail address is not valid. |
400 (Bad Request) | Mail address is required. |
404 (Not Found) | Mail subscription info not found. |