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

application/json

UserIds to unsubscribe (only for bulk unsubscription)

itemsinteger (int64)

Response

200400401403500

Signal unsubscribed.

Body

application/json

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

JavaScriptCurl

const response = await fetch('youragentURL.symphony.com/agent/v1/signals/{id}/unsubscribe', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([]),
});
const data = await response.json();

Response

{
  "subscriptionErrors": [
    {
      "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.