Subscribe Signal

Subscribe an array of users to a Signal. To subscribe an entire pod to a Signal, set the companyWide field in Create Signal.

Request Examples

curl -X POST \
https://acme.symphony.com/agent/v1/signals/5a6efc9db9d8210001b9960b/subscribe \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -H 'keymanagertoken: KEYMANAGER_TOKEN' \   
  -d '[68719476759, 68719476760, 68719476761]'

curl -X POST
  -H 'content-type: application/json'
  -H 'sessiontoken: SESSION_TOKEN'
  -H 'keymanagertoken: KEYMANAGER_TOKEN'  
  https://acme.symphony.com/agent/v1/signals/5a6efc9db9d8210001b9960b/subscribe

🚧 Required Permissions
To subscribe other users to a specific signal, the requesting user needs to have the canManageSignalSubscription entitlement.

Last updated 1 year ago

Was this helpful?

post

/v1/signals/{id}/subscribe

Path parameters

idstringrequired

The id of the signal.

Query parameters

pushedboolean

Prevent the user to unsubscribe (only for bulk subscription)

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstring

Key Manager authentication token.

Body

itemsinteger · int64

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'youragentURL.symphony.com/agent/v1/signals/{id}/subscribe' \
  --header 'sessionToken: text' \
  --header 'Content-Type: application/json' \
  --data '[null]'

200

400

401

403

500

{
  "requestedSubscription": 1,
  "successfulSubscription": 1,
  "failedSubscription": 1,
  "subscriptionErrors": [
    {
      "userId": 1,
      "code": "text",
      "message": "text"
    }
  ]
}

Signal subscribed.