Error
A valid request URL is required to generate request examples{
"id": "act_M4qT8YH7xW2pL9nB",
"status": "pending",
"url": "<string>",
"method": "GET",
"attempts": 1,
"retries": 50,
"created_at": "2023-11-07T05:31:56Z",
"approve": true,
"body": {},
"headers": {},
"dedupe": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"next_retry_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"response_code": 123,
"response_body": null,
"duration_ms": 123,
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": "<string>",
"callback": "<string>",
"idempotency_key": "<string>",
"retries_remaining": 1,
"next_retry_in_seconds": 1,
"actions": [
"approve"
],
"error": {
"source": "target",
"message": "<string>",
"response_code": 123,
"response_body": "<unknown>"
},
"receipt_url": "<string>",
"deduplicated": true
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}Actions
Get Action
GET
/
v1
/
actions
/
{id}
Error
A valid request URL is required to generate request examples{
"id": "act_M4qT8YH7xW2pL9nB",
"status": "pending",
"url": "<string>",
"method": "GET",
"attempts": 1,
"retries": 50,
"created_at": "2023-11-07T05:31:56Z",
"approve": true,
"body": {},
"headers": {},
"dedupe": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"next_retry_at": "2023-11-07T05:31:56Z",
"last_error": "<string>",
"response_code": 123,
"response_body": null,
"duration_ms": 123,
"approved_at": "2023-11-07T05:31:56Z",
"approved_by": "<string>",
"callback": "<string>",
"idempotency_key": "<string>",
"retries_remaining": 1,
"next_retry_in_seconds": 1,
"actions": [
"approve"
],
"error": {
"source": "target",
"message": "<string>",
"response_code": 123,
"response_body": "<unknown>"
},
"receipt_url": "<string>",
"deduplicated": true
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}{
"error": {
"code": "missing_body",
"message": "<string>",
"request_id": "<string>",
"details": [
{
"field": "<string>",
"message": "<string>",
"code": "invalid"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Optional client request ID. Echoed back on response.
Path Parameters
Pattern:
^act_[A-Za-z0-9_-]+$Example:
"act_M4qT8YH7xW2pL9nB"
Response
Action
Pattern:
^act_[A-Za-z0-9_-]+$Example:
"act_M4qT8YH7xW2pL9nB"
Available options:
pending, active, awaiting_approval, completed, failed, cancelled Available options:
GET, POST, PUT, PATCH, DELETE Required range:
x >= 0Required range:
1 <= x <= 100Show child attributes
Show child attributes
Required range:
x >= 0Required range:
x >= 0Allowed operations for the current status.
Available options:
approve, cancel, retry Structured error detail present when status is failed.
Show child attributes
Show child attributes
Shareable URL for this action's receipt page (e.g. /r/rcpt_...). No authentication required — secured by the unguessable receipt token.