Skip to main content

Remove subscribers from a topic

POST 
/api/v1/notifications/manage/remove-subscribers-from-topic

Removes the specified users from the topic's subscriber list.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Broadcast with topics

Request​

Responses​

Subscribers removed

Remove the selected application user from an existing topic.​

Section ID: DOC-CP-notifications-api-removeSubscribersFromTopic#example-notifications-removeSubscribersFromTopic-request

Request example

{
  "topicKey": "product-updates",
  "userIds": [
    "user-1"
  ]
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-removeSubscribersFromTopic#example-notifications-removeSubscribersFromTopic-response

Response example

{
  "result": {
    "totalCount": 1,
    "successful": 1,
    "failed": 1,
    "errors": [
      {
        "subscriberId": "example_123",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

Document ID: DOC-CP-notifications-api-removeSubscribersFromTopic. Section identities and revisions.

SectionStable reference
Remove subscribers from a topicDOC-CP-notifications-api-removeSubscribersFromTopic#overview
RequestDOC-CP-notifications-api-removeSubscribersFromTopic#request
ResponsesDOC-CP-notifications-api-removeSubscribersFromTopic#responses