Skip to content

Identity: pending

View as Markdown

Answer a request an integration parked for a person (SPEC §6.8)

Section titled “Answer a request an integration parked for a person (SPEC §6.8)”

POST /v1/identities/{slug}/pending/{id} · operation answerPendingRequest

Requires the batondeck:requests:answer permission (action requests:answer).

Refused while the workspace is suspended or on deletion hold.

Parameters

Name In Type Required Notes
slug path string yes
id path string yes

Request body (application/json)

Field Type Required Notes
answer yes the reply payload
Request schema
{
"type": "object",
"properties": {
"answer": {
"description": "the reply payload"
}
},
"required": [
"answer"
],
"additionalProperties": false
}

Responses

Status Meaning
200 Answer a request an integration parked for a person (SPEC §6.8)
400 The arguments did not validate.
401 No portal session, and no live API key.
403 The policy refused, or the request was cross-site.
404 No such resource, or none this session may see.
200 response schema
{
"type": "object",
"properties": {
"relayed": {
"type": "boolean"
}
},
"required": [
"relayed"
],
"additionalProperties": false
}
Terminal window
curl -X POST 'https://api.batondeck.com/v1/identities/:slug/pending/:id' \
-H "Authorization: Bearer $BATONDECK_API_KEY" \
-H 'content-type: application/json' \
-d @body.json

Agent-answered requests a caller is waiting on (SPEC §6.8)

Section titled “Agent-answered requests a caller is waiting on (SPEC §6.8)”

GET /v1/identities/{slug}/pending · operation listPendingRequests

Requires the batondeck:messages:read permission (action message:read).

Parameters

Name In Type Required Notes
slug path string yes

Responses

Status Meaning
200 Agent-answered requests a caller is waiting on (SPEC §6.8)
401 No portal session, and no live API key.
403 The policy refused, or the request was cross-site.
404 No such resource, or none this session may see.
200 response schema
{
"type": "object",
"properties": {
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"contact_fpr": {
"type": "string"
},
"capability": {
"type": "string"
},
"args": {
"type": "string"
},
"trust_flag": {
"type": "string"
},
"created_at": {
"type": "number"
},
"expires_at": {
"type": "number"
}
},
"required": [
"id",
"contact_fpr",
"capability",
"args",
"trust_flag",
"created_at",
"expires_at"
],
"additionalProperties": false
}
}
},
"required": [
"requests"
],
"additionalProperties": false
}
Terminal window
curl -X GET 'https://api.batondeck.com/v1/identities/:slug/pending' \
-H "Authorization: Bearer $BATONDECK_API_KEY"