Unsubscribe Signal
Unsubscribes an array of users from the specified Signal.
Path parameters
idstringRequired
The id of the signal.
Header parameters
sessionTokenstringRequired
Session authentication token.
keyManagerTokenstringOptional
Key Manager authentication token.
Body
integer · int64[]Optional
Responses
200
Signal unsubscribed.
application/json
400
Client error, see response body for further details.
application/json
401
Unauthorized: Session tokens invalid.
application/json
403
Forbidden: Caller lacks necessary entitlement.
application/json
500
Server error, see response body for further details.
application/json
post
POST /agent/v1/signals/{id}/unsubscribe HTTP/1.1
Host: youragentURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 3
[
1
]
{
"requestedSubscription": 1,
"successfulSubscription": 1,
"failedSubscription": 1,
"subscriptionErrors": [
{
"userId": 1,
"code": "text",
"message": "text"
}
]
}
🚧 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
Was this helpful?