Unsubscribe Signal
Unsubscribes an array of users from the specified Signal.
Unsubscribe to a Signal.
POSTyouragentURL.symphony.com/agent/v1/signals/{id}/unsubscribe
Path parameters
id*string
The id of the signal.
Header parameters
Body
UserIds to unsubscribe (only for bulk unsubscription)
itemsinteger (int64)
Response
Signal unsubscribed.
Body
requestedSubscriptioninteger (int64)
The number of requested userIds to subscribe
successfulSubscriptioninteger (int64)
The number of successful subscriptions done
failedSubscriptioninteger (int64)
The number of subscription failures
subscriptionErrorsarray of ChannelSubscriptionError (object)
Request
Response
🚧 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.
Last updated