Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

Authorization-code grant with PKCE S256, exact scopes, explicit resource audience and a persisted consent grant. Obtain endpoint URLs from server discovery in the target environment. Refresh tokens remain client-bound.

Scopes

Turn the backlink exchange on or off and submit quests.

Headers

Idempotency-Key
string
required

Opaque client command key of 1 to 128 visible ASCII characters. UUID recommended; reuse only for the same command.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Path Parameters

profile_id
string<uuid>
required

Profile UUID; must be in the grant allowlist and currently accessible to the actor.

Body

application/json
enabled
boolean
required

true makes the site take part in the backlink exchange; false takes it out.

Response

Updated backlink exchange state and its durable receipt.

data
object
required
meta
object
required