Opt In/Out

Description

This document covers the basic API information for Opt In/Out of Mobile Apps.

The current applications supported are:

bloomingdales iphone

bloomingdales android

POST

https://api.bloomingdales.com/v2/utility/mobileoptinout

HTTP Header Parameters

Parameter	Description	Mandatory	Sample Value
Accept	Specifies the output format. Can be application/json or application/xml.	Yes	application/json application/xml
x-macys-webservice-client-id	Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys.	Yes	xmj9js4jkdpe1983fmwu98gh
Content-Type	Specifies the format of body sent. Can be application/json or application/xml.	Yes	application/json application/xml

Request Body Parameters

Parameter	Description	Mandatory	Example
deviceID	iphone UDID or Android ID if available	Y	12345678901234567890
bloomingdalesUID	bloomingdales or BCOM user ID	N	12345
optInOrOptOut	options are: IN or OUT	Y	IN

Sample Requests and Responses

Sample Request

Request URL:

POST

https://api.bloomingdales.com/v2/utility/mobileoptinout

HTTP Headers:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept:application/json
Content-Type: application/json

Body:

{"deviceID":"12345678901234567890",

"bloomingdalesUID":"12345",

"optInOrOptOut":"IN"}

Sample Response

{"success":true}

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

version 11 as of 9 years ago by Gaku Kelliher