XOMNI: Experience Omni-Channel

Last Updated: May 05, 2016

The API provides updating mail subscription status to subscribed and unsubscribed state.

Request

{
	"StatusId":2
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/private/mail/subscription/{email}/status

URI Parameters

Parameter Name Description Type Conditions
email Email Address String

Request Body Description

Parameter Name Description Type Conditions
StatusId Status ID for the mail address. See below for the possible values. Number
Required: Yes

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.

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

The response does not contain any response entity if the status is successful.

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 PUT operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) Mail address is not valid.
400 (Bad Request) You've reached to resubscribe limit for the given mail address.
400 (Bad Request) Invalid statusId.
404 (Not Found) Mail address not found.