Create alert

PUT/accounts/{account_id}/alerts/create

Create a creator alert. These Alerts are used to notify users of a new livestream.

Path Parameters

account_id*number (double)

Request Body

Required

Configuration for the alert

unique_id*string

Responses

200Ok

Response Attributes

code*number (double)
messagestring
alertobject

Public, snake_case response shape for an alert.

The gRPC {@link LivePushAlert} model is camelCase; the public API has always exposed alerts in snake_case, so we convert before serializing. Only the field casing is changed here — types and field membership are left as-is.

||
Request
Response200

Retrieve alert

GET/accounts/{account_id}/alerts/{alert_id}/retrieve

Retrieve a specific alert by its ID

Path Parameters

account_id*number (double)
alert_id*number (double)

Responses

200Ok

Response Attributes

code*number (double)
messagestring
alertobject

Public, snake_case response shape for an alert.

The gRPC {@link LivePushAlert} model is camelCase; the public API has always exposed alerts in snake_case, so we convert before serializing. Only the field casing is changed here — types and field membership are left as-is.

creatorobject
||
Request
Response200

List alerts

GET/accounts/{account_id}/alerts/list

Path Parameters

account_id*number (double)

Query Parameters

pagenumber (double)= 0

Responses

200Ok

Response Attributes

code*number (double)
messagestring
alertsobject[]
hasMore*boolean
||
Request
Response200

Delete alert

DEL/accounts/{account_id}/alerts/{alert_id}/delete

Delete an alert from the Sign API

Path Parameters

account_id*number (double)
alert_id*number (double)

Responses

200Ok

Response Attributes

code*number (double)
messagestring
||
Request
Response200