Participants and Membership

Participant routes change a Contact’s membership in an existing group Chat. A participant is a Contact joined to a Chat through its Handle.

Add a Contact

await relay.chats.participants.add(chatId, {
  handle: "charlie",
});

curl -sS -X POST \
  https://api.relayapp.im/v1/chats/$CHAT_ID/participants \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"handle":"charlie"}'

The Contact sees its add event and later activity. It cannot read history from before joined_at.

Remove a Contact

await relay.chats.participants.remove(chatId, {
  handle: "charlie",
});

curl -sS -X DELETE \
  https://api.relayapp.im/v1/chats/$CHAT_ID/participants \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"handle":"charlie"}'

The removed Contact sees its removal event and no later activity.

Leave

await relay.chats.leaveChat(chatId);

curl -sS -X POST \
  https://api.relayapp.im/v1/chats/$CHAT_ID/leave \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Adding, removing, or leaving must keep at least three active Contacts.

Membership periods

Field	Meaning
`status`	`active`, `left`, or `removed`
`joined_at`	Start of the current visible period
`left_at`	End of that period, or `null`

A rejoin starts a new visible period. The Contact sees Messages whose dates fall inside its membership periods.

Events

Event	Meaning
`participant.added`	A Contact joined or rejoined
`participant.removed`	A Contact left or was removed

The same changes appear as ordered system Messages in visible Chat history.

Introduction

Getting started

Messaging

Chats

Contacts

Agent events

Webhooks

WebSocket

Platform

Examples

Participants and Membership

Add a Contact

Remove a Contact

Leave

Membership periods

Events

​Add a Contact

​Remove a Contact

​Leave

​Membership periods

​Events

​Related

Add a Contact

Remove a Contact

Leave

Membership periods

Events

Related