Respond to User Action

Submits or declines a pending user action on an agent checkout. The actionId is the pendingUserAction.id from the checkout view, supplied in the path only — including it in the body is rejected.

A submit must carry values that satisfy the action’s responseSchema. The response is an acknowledgement; more actions may follow, so return to polling GET /{id} afterwards.

API scope required: agent-checkouts.update

POST /unstable/agent-checkouts/{id}/actions/{actionId}

cURL

Submit values

curl --request POST \
  --url https://www.crossmint.com/api/unstable/agent-checkouts/{id}/actions/{actionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "action": "submit",
  "values": {
    "fullName": "Ada Lovelace",
    "addressLine1": "12 Analytical Engine Way",
    "city": "London",
    "postalCode": "EC1A 1BB",
    "country": "GB"
  }
}
'

201

{
  "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "accepted",
  "acceptedAt": "2023-11-07T05:31:56Z"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-API-KEY · string · header · required

Client-side API key (ck_...) with the agent-checkouts.* scopes.

Authorization · string · header · required

JWT identifying the end user, issued by an external auth provider your project trusts.

Path Parameters

id · string<uuid> · required

The agent checkout id (returned by create).

actionId · string<uuid> · required

The id of the pending user action (pendingUserAction.id).

Body

application/json

Option 1

Option 2

action · enum<string> · required

Available options: submit

values · object · required

Values satisfying the action's responseSchema.

Response

201

application/json

The submission or decline was accepted.

checkoutId · string<uuid> · required

actionId · string<uuid> · required

status · enum<string> · required

Available options: accepted

acceptedAt · string<date-time> · required