Admin APIOperational

[BETA] Update a signal endpoint token.

View as Markdown

Enterprise feature

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

Updates an existing signal endpoint token 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

signalEndpointIdstringRequired
idstringRequired

Request

#/components/schemas/createSignalEndpointTokenSchema

namestringRequired
The signal endpoint token name.

Response

#/components/schemas/signalEndpointTokenSchema

idinteger>=1
The signal endpoint token's ID. Signal endpoint token IDs are incrementing integers. In other words, a more recently created signal endpoint token will always have a higher ID than an older one.
namestring
The signal endpoint token name.
signalEndpointIdinteger
The signal endpoint ID that this token belongs to.
createdAtstringformat: "date-time"
The date and time of when the signal endpoint token was created.
createdByUserIdinteger
The ID of the user that created this signal endpoint token.
tokenstring or null
The token used for authentication. It is automatically generated by Unleash when the token is created and that is the only time this property is returned.

Errors