Join chat

POST /actions/user/chats/{entity_id}/join
Jwt authorization

Join a chat for a specific entity by adding the current user as a participant. The user will be listed as a participant in the chat.

Path parameters

  • entity_id string(uuid) Required

    Entity unique identifier

Responses

  • 201 application/json

    Chat joined successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Chat unique identifier

    • entity_id string(uuid)

      Entity identifier

    • entity_type string

      Entity type

    • participants array[string(uuid)]

      List of participant person identifiers

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Last update timestamp
POST /actions/user/chats/{entity_id}/join 
curl \
 --request POST 'http://api.example.com/actions/user/chats/a24a6ea4-ce75-4665-a070-57453082c25/join' \
 --header "Authorization: $API_KEY"
Response examples (201) 
{
  "id": "b35b7fb5-df86-5776-b181-68564193d36",
  "entity_id": "c46c8gc6-eg97-6887-c292-79675204e47",
  "entity_type": "Asset",
  "participants": [
    "d57d9hd7-fh08-7998-d403-80786315f58"
  ],
  "created_at": "2023-01-01T12:00:00Z",
  "updated_at": "2023-01-01T12:30:00Z"
}