Skip to main content
POST
Update integration status

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

integration_id
string
required
Maximum string length: 256
Pattern: ^[a-zA-Z0-9._-]+$

Body

application/json
status
enum<integer>
required

Desired state. Only 0 (paused) and 1 (active) are accepted; 2 (error) is set exclusively by the delivery worker. To remove an integration, use DELETE /v4/integrations/{integration_id}.

Available options:
0,
1
Example:

1

Response

Integration status updated.

A single integration record. Credentials (API keys, webhook secrets) are configured out-of-band after creation and are not exposed in this shape.

object
string
required
Example:

"integration"

id
string
required

Integration identifier. Stable for the lifetime of the record (soft-deleted records keep their ID).

Example:

"gNl6hyM6"

url
string
required

Canonical API path.

Example:

"/v4/integrations/gNl6hyM6"

title
string
required

Caller-supplied display title.

Example:

"Amplitude — Production iOS"

integration
string
required

Provider display title (not the lowercase slug used on create). Use for UI; for references in other requests use id.

Example:

"Amplitude"

target_platform
enum<string>
required

Store the integration forwards events for. Case-sensitive.

Available options:
iOS,
Android,
Stripe
active
enum<integer>
required

Integration state.

  • 0 — paused / draft (no events forwarded).
  • 1 — active (events forwarded).
  • 2 — error (delivery worker suspended the pipeline; inspect last_error_message/last_error_at). Cannot be set by callers.
Available options:
0,
1,
2
created_at
string<date-time>
required

ISO 8601 creation timestamp.

Example:

"2026-02-26T16:03:09Z"

updated_at
string<date-time>
required

ISO 8601 last-update timestamp.

Example:

"2026-02-26T16:03:09Z"

last_delivery_at
string<date-time> | null
required

ISO 8601 timestamp of the most recent successful delivery, or null if never delivered.

Example:

"2026-04-22T10:12:33Z"

last_error_at
string<date-time> | null
required

ISO 8601 timestamp of the most recent delivery failure, or null.

last_error_message
string | null
required

Human-readable description of the most recent delivery failure, or null.

delivery_error_count
integer
required

Running count of delivery failures since the last successful delivery.

Required range: x >= 0