Skip to main content
POST
Add a target

Authorizations

Authorization
string
header
required

An organization-scoped API key, minted in control under Settings → API keys. Every failure to authenticate answers one identical 401: "Provide a valid organization-scoped API key or an active session." Each operation names the one scope it is filed under, <resource>:<read|write>, where the resource is the first path segment after /api/v1/; a key minted today carries all 22 of them. Scopes are RECORDED — on the key and on every audit row — and are not yet enforced: no request is refused for want of one.

Headers

Idempotency-Key
string

Any unique string.

Path Parameters

id
string
required

The task id. A malformed id answers 404, exactly as another organization's well-formed id does.

Body

application/json
clientId
string
required

The Client this target fires for.

cronExpr
string

Override the task's expression for this target.

runAt
string

Override the task's instant for this target.

timezone
string

Override the task's zone for this target.

targetChannel
string

Override where this target posts.

Response

Success.

data
object
required