TRtrycourier
User Preferences

Update or Create user preferences for a specific subscription topic

Changed on

Sets a user's opt-in status and channel choices for one subscription topic, overriding the tenant default for that topic only.

put/users/{user_id}/preferences/{topic_id}

Request

Path parameters

user_idstring required

A unique identifier associated with the user whose preferences you wish to retrieve.

topic_idstring required

A unique identifier associated with a subscription topic.

Query parameters

tenant_idstring nullable

Update the preferences of a user for this specific tenant context.

Request body

Response

messagestring required

Example response

{
  "message": "success"
}

Changes

  • f76bed79a913Revision changes
    • breaking

      added to the / request property allOf list

    • breaking

      removed the enum value OPTED_IN of the request property /

    • breaking

      removed the enum value OPTED_OUT of the request property /

    • breaking

      removed the enum value REQUIRED of the request property /

    • breaking

      the / request property type changed from string to no type

  • e67d02739533Revision changes
    • info

      api tag User Preferences added

    • info

      api tag UsersPreferences removed