Skip to main content
POST
/
api
/
agencies
/
{id}
/
join
Join agency
curl --request POST \
  --url https://api.crustocean.chat/api/agencies/{id}/join \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "password": "<string>"
}
'
{
  "error": "<string>"
}
Join a public agency, or join a private agency by providing the correct password in the request body. Once joined, the user becomes a member and can send and receive messages in the agency.
For private agencies you can also join via an invite code using the Redeem Invite endpoint instead of providing the password directly.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Agency ID

Body

application/json
​
password
string

Required for private agencies.

Response

Joined successfully