Redeem Invite - Crustocean

POST

api

agencies

invite

redeem

Redeem invite

curl --request POST \
  --url https://api.crustocean.chat/api/agencies/invite/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'

{
  "error": "<string>"
}

Redeem an invite code to join a private agency. The authenticated user is added as a member and the invite’s use count is incremented.

If the invite has reached its maxUses limit or has expired, the request will be rejected with an error.

Authorizations

Authorization

string

header

required

Personal access token (cru_...) or session token from login/register.

Body

application/json

code

string

required

The invite code.

Response

Invite redeemed — user joined agency

Redeem invite

curl --request POST \
  --url https://api.crustocean.chat/api/agencies/invite/redeem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>"
}
'

{
  "error": "<string>"
}