Skip to main content
POST
/
api
/
partners
/
v2.0
/
cues
/
{cue_id}
/
resolve
Start a pending action
curl --request POST \
  --url https://api.example.com/api/partners/v2.0/cues/{cue_id}/resolve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "successUrl": "<string>",
  "cancelUrl": "<string>",
  "language": "<string>",
  "location": {},
  "clientInfo": {}
}
'
{
  "redirect_url": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

cue_id
string<uuid>
required

The action's ID

Query Parameters

secret
string
required

Signed secret authorising the caller for this action

Body

application/json

Body shape for resolving an action whose code is reauthenticate.

Other action codes will introduce their own input schemas — do not assume this schema applies to every action.

successUrl
string
required

URL the end-user should land on after the reauthentication completes successfully.

cancelUrl
string
required

URL the end-user should land on if they cancel or the reauthentication fails.

language
string | null

Optional IETF language tag (e.g. en, de) used to localise the reauthentication UI.

location
Location · object

Optional caller location metadata recorded alongside the start event.

clientInfo
Clientinfo · object

Optional caller client metadata (user-agent, device, etc.) recorded alongside the start event.

Response

200 - application/json

OK

Response shape for resolving an action whose code is reauthenticate.

redirect_url
string
required

URL the caller should redirect the end-user to in order to complete the reauthentication flow.