Opt in Opt Out V2

Description

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

The current applications supported are:

macys iphone

macys android

POST

https://api.macys.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	Sample Value
deviceID	iphone UDID or Android ID if available	Yes	12345678901234567890
macysUID	macys or MCOM user ID	No	12345
optInOrOptOut	options are: IN or OUT	Yes	IN

Sample Request

Request URL:

POST

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

HTTP Headers:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh

Accept:application/json

Content-Type: application/json

Body:

{"deviceID":"12345678901234567890",
"macysUID":"12345",
"optInOrOptOut":"IN"}

Sample Response

{"success":true}

Call Specific Error Codes:

NONE

General Error Handling Documentation:

Click Here

version 21 as of 9 years ago by Gaku Kelliher