MOmoengage
Opt-in Management

Update User Email Opt-in Preferences

This API updates a user's overall email opt-in status and/or category-level subscription preferences within MoEngage. This API is typically used after a user submits the second confirmation through MoEngage consent-seeking emails (Double Opt-in).

put/v1.0/opt-in-management/user-preferences

Request

Headers

MOE-APPKEYstring required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

MOE-PROJECT-CODEstring

This is the project ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > Portfolio > Project ID. Note: This parameter is mandatory for workspaces with the Portfolio feature enabled.

Request body

Example request

{
  "user_preferences": {
    "customer_id": "ID_uid",
    "email_id": "john@example.com",
    "categories": {
      "category_1": true,
      "category_2": false
    },
    "opt_in_status": "DOUBLE_OPTED_IN",
    "channel": "email"
  }
}

Response

The request has been processed successfully.

messagestring

The success message denoting the request was processed successfully.

Example response

{
  "message": "Your request has been processed successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.