Admin APIOperational

[BETA] Disables a signal endpoint.

View as Markdown

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

Disables an existing signal endpoint, identified by its id.

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Path parameters

idstringRequired

Response

#/components/schemas/signalEndpointSchema

idinteger>=1
The signal endpoint's ID. Signal endpoint IDs are incrementing integers. In other words, a more recently created signal endpoint will always have a higher ID than an older one.
enabledboolean
Whether the signal endpoint is currently enabled. If not specified, defaults to true.
namestring

The signal endpoint name. Must be URL-safe.

createdAtstringformat: "date-time"
The date and time of when the signal endpoint was created.
createdByUserIdinteger
The ID of the user that created this signal endpoint.
descriptionstring or null
A more detailed description of the signal endpoint and its intended use.
urlstring or null
The full URL that should be used to call the signal endpoint. This property is only returned for newly created or updated signal endpoints.
tokenslist of objects or null
The list of tokens associated with the signal endpoint.

Errors