Groups
Add members to a group
Add one or more clients to a Quenza group through the API. They join the group chat and can get the activities the group already received.
Send the IDs of the clients in members. For each client who is not in the group yet:
- They join the group’s chat, if it has one.
- When the group sends earlier activities and programs to new members, they get them now.
Clients who are already in the group, and IDs that match no client, are skipped. If nobody new was added, the answer is 204 without a body. That makes the request safe to repeat, for example when your shop sends a payment notification twice.
Add buyers to a group shows the whole flow from purchase to group.
Path parameters
groupstringRequiredThe group’s ID.
Request body
membersarray of stringsRequiredIDs of the clients to add. Clients who are already in the group, and IDs that match no client, are skipped.
Response
200 with the group in data:
idstringThe group’s ID. Use it to add members.
namestringName of the group.
descriptionstringor nullShort description, or
null.picturestringor nullAddress of the group picture, or
null.auto_send_assignments_to_new_membersbooleanWhether clients who join later get the group’s earlier activities and programs.
file_collection_idstringID of the folder that holds the group’s resources.
is_chat_enabledbooleanWhether the group has a group chat that is switched on.
statusstringactive, orarchivedafter the group was archived.One of
active,archived.archived_atstringor nullWhen it was archived, or
null.ISO 8601 date and time in UTC.
created_atstringWhen it was created.
ISO 8601 date and time in UTC.
updated_atstringWhen it was last changed.
ISO 8601 date and time in UTC.
Status codes
Was this article helpful?
Thanks for letting us know.
Thank you. We read every answer and use it to improve this article.