Approve agent login

Approves a pending agent login request for the signed-in customer and selected workspace.

POST/api/v1/agent/auth/requests/{userCode}/approve

Approves a pending agent login request for the signed-in customer and selected workspace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

workspaceHandle?nonEmptyString

a non empty string

Length1 <= length

Response Body

`application/json`

curl -X POST "https://loading/api/v1/agent/auth/requests/{userCode}/approve" \  -H "Content-Type: application/json" \  -d '{    "workspaceHandle": "acme-growth-team"  }'

{
  "status": "approved",
  "workspace": {
    "handle": "acme-growth-team",
    "name": "Acme Growth Team",
    "createdAt": "2026-03-05T18:00:00.000Z",
    "updatedAt": "2026-03-05T18:00:00.000Z",
    "deletedAt": null
  },
  "approvedAt": "2026-03-07T18:05:00.000Z"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

{
  "code": "authentication_required",
  "message": "Authentication required. Send Authorization: Bearer <api-key>, x-api-key, or a signed-in session."
}

{
  "code": "internal_error",
  "message": "An unexpected server error occurred."
}

Approve agent login

Request Body

Response Body

200application/json

400application/json

401application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`