Skip to content

Undo a hand-over

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/setup/takeovers/{id}/undo
curl --request POST \  --url https://api.xovris.ai/v1/setup/takeovers/example/undo \  --header 'Authorization: Bearer <token>'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

id
required
string

Done: something new was made, and the answer is it.

Media typeapplication/json
object
ok
required
boolean
id
required
string
integration
required
string
name
required
string
purpose
required
string
Allowed values: fix undo setup
undoOf
required
One of:
string
mode
required
string
Allowed values: guided takeover
state
required
string
preflight
required
One of:
object
go
required
string
Allowed values: takeover
policy
required
One of:
object
origin
required
string
terms
required
string
Allowed values: allowed allowed_with_consent guided_only objection
termsUrl
required
One of:
string
termsFingerprint
required
One of:
string
readAt
required
string
officialRoute
object
rung
required
number
Allowed values: 2 1 3 4
how
required
string
note
string
way
required
string
card
required
object
title
required
string
lines
required
Array<string>
digest
required
string
steps
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: fill select click goto catch_secret expect tab download upload mail_link
intent
required
string
consequence
required
string
Allowed values: none changes creates lowers_protection
done
required
boolean
kept
required
boolean
log
required
Array<object>
object
at
required
string
actor
required
string
Allowed values: person xovris agent
kind
required
string
target
required
One of:
object
role
required
string
name
required
string
url
required
One of:
string
verdict
required
string
Allowed values: done refused allowed handed_to_person asked_yes asked_no
why
string
waitingFor
required
One of:
string
question
required
One of:
string
waitingKind
required
One of:
string
takenBack
required
boolean
questionKind
required
One of:
string
Allowed values: go_ahead already_done
resumable
required
boolean
handover
required
One of:
object
available
required
boolean
why
string
handedTo
required
One of:
string
handedFrom
required
One of:
string
yourTurn
required
boolean
liveView
required
One of:
string
stay
required
One of:
object
state
required
string
Allowed values: refused second_factor with_person captcha not_accepted left_plan stalled has_what_it_needs expired wrong_account wrong_page
line
required
string
next
required
string
pressWhat
required
One of:
string
since
required
string
act
One of:
string
Allowed values: payment password security_control
carriesOnByItself
required
boolean
doItYourself
required
One of:
object
label
required
string
method
required
string
path
required
string
body
required
object
integration
required
string
guided
required
boolean
secret
required
One of:
object
saved
required
boolean
ending
required
string
keyCheck
required
One of:
object
provider
required
string
proved
required
boolean
keyCatch
required
One of:
object
label
required
string
method
required
string
path
required
string
unverified
required
boolean
tests
required
One of:
object
url
required
string
expectStatus
required
number
before
object
status
required
One of:
number
at
required
string
error
string
after
object
status
required
One of:
number
at
required
string
error
string
passed
boolean
connection
object
status
required
One of:
number
at
required
string
error
string
url
required
string
passed
required
boolean
undo
required
object
job
string
available
required
boolean
source
required
One of:
object
docs
required
string
readAt
required
string
createdAt
required
string
approvedAt
required
One of:
string
endedAt
required
One of:
string
run
required
object
id
required
string
startedAt
required
string

Example

{  "ok": true,  "id": "string",  "integration": "string",  "name": "string",  "purpose": "fix",  "undoOf": "string",  "mode": "guided",  "state": "string",  "preflight": {    "go": "takeover",    "policy": {      "origin": "string",      "terms": "allowed",      "termsUrl": "string",      "termsFingerprint": "string",      "readAt": "string",      "officialRoute": {        "rung": 2,        "how": "string"      },      "note": "string"    }  },  "way": "string",  "card": {    "title": "string",    "lines": [      "string"    ],    "digest": "string"  },  "steps": [    {      "id": "string",      "kind": "fill",      "intent": "string",      "consequence": "none",      "done": true,      "kept": true    }  ],  "log": [    {      "at": "string",      "actor": "person",      "kind": "string",      "target": {        "role": "string",        "name": "string"      },      "url": "string",      "verdict": "done",      "why": "string"    }  ],  "waitingFor": "string",  "question": "string",  "waitingKind": "string",  "takenBack": true,  "questionKind": "go_ahead",  "resumable": true,  "handover": {    "available": true,    "why": "string"  },  "handedTo": "string",  "handedFrom": "string",  "yourTurn": true,  "liveView": "string",  "stay": {    "state": "refused",    "line": "string",    "next": "string",    "pressWhat": "string",    "since": "string",    "act": "payment"  },  "carriesOnByItself": true,  "doItYourself": {    "label": "string",    "method": "string",    "path": "string",    "body": {      "integration": "string",      "guided": true    }  },  "secret": {    "saved": true,    "ending": "string"  },  "keyCheck": {    "provider": "string",    "proved": true  },  "keyCatch": {    "label": "string",    "method": "string",    "path": "string"  },  "unverified": true,  "tests": {    "url": "string",    "expectStatus": 1,    "before": {      "status": 1,      "at": "string",      "error": "string"    },    "after": {      "status": 1,      "at": "string",      "error": "string"    },    "passed": true,    "connection": {      "status": 1,      "at": "string",      "error": "string",      "url": "string",      "passed": true    }  },  "undo": {    "job": "string",    "available": true  },  "source": {    "docs": "string",    "readAt": "string"  },  "createdAt": "string",  "approvedAt": "string",  "endedAt": "string",  "run": {    "id": "string",    "startedAt": "string"  }}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.