Skip to main content
POST
/
v1
/
customer-seats
/
claim
Claim Seat
curl --request POST \
  --url https://api.spairehq.com/v1/customer-seats/claim \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitation_token": "<string>"
}
'
{
  "seat": {
    "created_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "member_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "member": {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "Jane Doe",
      "external_id": "usr_1337"
    },
    "email": "<string>",
    "customer_email": "<string>",
    "invitation_token_expires_at": "2023-11-07T05:31:56Z",
    "claimed_at": "2023-11-07T05:31:56Z",
    "revoked_at": "2023-11-07T05:31:56Z",
    "seat_metadata": {}
  },
  "customer_session_token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.spairehq.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
invitation_token
string
required

Invitation token to claim the seat

Response

Successful Response

Response after successfully claiming a seat.

​
seat
CustomerSeat · object
required

The claimed seat

​
customer_session_token
string
required

Session token for immediate customer portal access