Opt out of emails

POST

/user/mail/optout/

User

Opt a user out of all newsletter email lists. The user will still receive system and attendee-specific emails.
Even though the value is updated, this change is not reflected in the member details in the Chapter dashboard.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/user/mail/optout/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user_id": "1234"
}'

Response Example

400 - Example 1

{
    "details": "The request is invalid. The rational will be in the response body."
}

Request

Body Params application/json

user_id

string

optional

The ID of the user to opt out of emails.

Example:

1234

Examples

Responses

🟢200OK

User opted out of emails.

This response does not have a body.

🟠400Bad Request

🟠403Forbidden

Create Prospective User

Get User Counts