Marketing consent

Update marketing email consent

get

Sets the user's email marketing consent status via a GET request. Intended for use with email links where users confirm their subscription choice. Accepts the user's email and a subscribe flag ('true' or 'false'). If one or more user accounts are found with the email, their consent preference is updated.

Query parameters

subscribestring · enumRequired

Indicates whether the user consents to marketing emails

Possible values:

emailstring · emailRequired

The user's email address

Responses

200

Consent successfully updated

application/json

404

No user found with the given email

application/json

get

/external/v1/marketing_consent

HTTPcURLJavaScriptPython

GET /external/v1/marketing_consent?subscribe=true&email=name%40gmail.com HTTP/1.1
Host: 
Accept: */*

{
  "message": {
    "email_marketing_consent": "[email protected] subscribed"
  }
}