Unsubscribe Signal

Unsubscribes an array of users from the specified Signal.

Unsubscribe to a Signal.

post

Path parameters

idstringrequired

The id of the signal.

Header parameters

sessionTokenstringrequired

Session authentication token.

keyManagerTokenstringoptional

Key Manager authentication token.

Body

integer · int64[]optional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

401

403

500

200

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

Signal unsubscribed.

🚧 Permissions

• To unsubscribe from a signal, the requesting user cannot be the owner of the signal.

• To unsubscribe other users from a signal, the requesting user needs to have the canManageSignalSubscription entitlement and the signal cannot be a company-wide signal.