Set Opt-in Status for an Account

PUT 
/client/users/:correlation_id/profile/optin

Request

Used to set opt-in status associated with a member account for member communications.

Body

Attribute	Description	Format	Note
LOYALTY_OPTIN	Sets user opt-in status on the user account	Enum: "accepted" or "declined"

Response

Attribute	Description	Format	Note
message	Returns results of opt-in request	String	Value: "Opt-in updated."

Error Responses

statusCode	errorMessage	errorCode	Definition
400 Bad Request	Invalid opt-in response provided	INVALID_REQUEST	The response from the system does not conform to acceptable values
400 Bad Request	LOYALTY_OPTIN missing from body	INVALID_REQUEST	LOYALTY_OPTIN value is not provided in request

Request

Responses

200

200 - Opt-in Status Set

Response Headers

Date
Example: Wed, 20 May 2020 23:58:38 GMT
Content-Length
Example: 29
Connection
Example: keep-alive
x-amzn-RequestId
Example: e0d10bd0-fecd-45bd-b9f8-22e4995e38f2
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: M2uXLFP2oAMF80w=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-5ec5c42d-e25aadfed1d668d9a29a06a2;Sampled=0

400

400 - Invalid Response

Response Headers

Date
Example: Wed, 20 May 2020 23:58:38 GMT
Content-Length
Example: 29
Connection
Example: keep-alive
x-amzn-RequestId
Example: e0d10bd0-fecd-45bd-b9f8-22e4995e38f2
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: M2uXLFP2oAMF80w=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-5ec5c42d-e25aadfed1d668d9a29a06a2;Sampled=0