Chat

Add members to a group chat

Adds creators to a manual group (orgCreatorIds, up to 500). Every id must be an active creator of your organization, or nothing is added (404). Creators who already are members are skipped. Creators not yet invited to the platform join the roster but see the group only once invited (POST /creators/{id}/invite); pendingOrgCreatorIds names them. The members of campaign and all groups follow their roster: editing them returns 400 MANUAL_ONLY.

post/chat/groups/{chatId}/members

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/chat/groups/{chatId}/members
  • Auth: API key in header x-api-key

Path parameters

chatIdstring required

Request body

orgCreatorIdsstring[] required

Org creator ids (the id of GET /creators rows), at most 500

Response

OK

chatIdstring required
memberCountinteger required

Creators who can read the group: they joined, or hold a pending invitation

pendingMemberCountinteger required

Creators on the roster who have not been invited to the platform yet

addedOrgCreatorIdsstring[] required

The ids this call added; creators who already were members are left out

pendingOrgCreatorIdsstring[] required

Added creators not invited to the platform yet: on the roster, but they see the group only once invited

Changes

No recorded changes to this operation across all 1 revision of this API.