Skip to main content
PUT
Update a Custom Signal Definition

Authorizations

Authorization
string
header
required

API key authentication. Include as Bearer token in Authorization header.

Path Parameters

slug
string
required

The definition's slug, as returned when it was created or by the catalogue.

Pattern: ^[a-z][a-z0-9_]{2,39}$

Body

application/json
active
boolean
required

true starts a ready or paused definition (a first start makes its test leads its first signals); false pauses an active one. Other transitions are a 400.

Response

The definition after the change.

success
boolean
data
object

One of your team's own definitions, as the Custom signals page shows it.

meta
object