Groups
Create a group
Create a client group through the Quenza API, with an optional group chat and automatic sending of earlier activities to new members.
Creates the group with the professional who owns the API token as its professional. Then add clients to it.
enable_chatcreates a group chat for the group’s clients.auto_send_assignments_to_new_memberssends the group’s earlier activities and programs to clients who join later. See New group members.
Store the returned id: the API cannot list groups, and you need it to add members.
Request body
namestringRequiredName of the group.
Up to 255 characters.
descriptionstringor nullShort description of the group, or
null.Up to 255 characters.
enable_chatbooleanor nullCreate a group chat for the group’s clients. Defaults to
false.auto_send_assignments_to_new_membersbooleanor nullSend the group’s earlier activities and programs to clients who join later. Defaults to
false.
Response
201 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.