Skip to main content
PATCH
Update an integration

Authorizations

Authorization
string
header
required

Session token as Authorization: Bearer (the CLI and scripts).

Path Parameters

orgSlug
string
required
workspaceSlug
string
required
id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 100
returnUrl
string | null

Null clears it

Maximum string length: 2048
settings
object

Replaces the whole object

status
enum<string>

disabled switches the integration off (credentials kept, connect link voided); active switches it back on after a successful verification. Not from pending.

Available options:
active,
disabled

Response

Updated

id
string<uuid>
required
workspaceId
string
required
provider
string
required
Example:

"google_ads"

providerName
string
required
Example:

"Google Ads"

category
enum<string> | null
required
Available options:
dsp,
ssp,
wg,
null
authMethod
enum<string> | null
required
Available options:
oauth,
credentials,
null
name
string
required
Example:

"Acme Google Ads"

status
enum<string>
required
Available options:
pending,
active,
error,
disabled
statusDetail
string | null
required

Why the status is error

statusCheckedAt
string | null
required
lastError
string | null
required

Last transient failure, if any

lastErrorAt
string | null
required
settings
object
required

Non-secret provider configuration, validated against the provider's settings fields: GET /v1/integrations/providers/{provider} lists them, and the <Provider>Settings schemas describe each shipped provider

connectedAt
string | null
required
connectedAccount
string | null
required

The external account that authorized access

returnUrl
string | null
required

The live connect link; null when none was issued or it was used

createdByEmail
string | null
required
createdAt
string
required
updatedAt
string
required