Skip to main content

Add subscribers to a topic

POST 
/api/v1/notifications/manage/add-subscribers-to-topic

Adds the selected users as subscribers to the specified topic.

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 added

Add existing application users to an existing topic.​

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

Request example

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

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

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

Response example

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

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

SectionStable reference
Add subscribers to a topicDOC-CP-notifications-api-addSubscribersToTopic#overview
RequestDOC-CP-notifications-api-addSubscribersToTopic#request
ResponsesDOC-CP-notifications-api-addSubscribersToTopic#responses