> For the complete documentation index, see [llms.txt](https://hub.equipme.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hub.equipme.io/development/api-reference-app/group.md).
# Group
A **group** is an internal team — support, second level, a department. Groups are what tickets get routed to when no single person is meant to own them yet.
Creating a group also creates its **group contact**: the face the group shows to the rest of the system, so a ticket can be assigned to the group the same way it is assigned to a person. That contact is managed with the group and never by hand.
Who belongs to a group, and with which role, is described under *Group Members*.
## List groups
> Returns the tenant's groups, ordered by \`id\` unless \`sort\` says otherwise.\
> \
> \*\*Filterable\*\* — \`id\`, \`tenantId\`, \`name\`, \`description\`.\
> \
> \*\*Sortable\*\* — \`id\`, \`name\`.\
> \
> \*\*Searchable\*\* — nothing yet; use \`filter\` with \`contains\` on \`name\`.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **group** is an internal team — support, second level, a department. Groups are what tickets get\nrouted to when no single person is meant to own them yet.\n\nCreating a group also creates its **group contact**: the face the group shows to the rest of the\nsystem, so a ticket can be assigned to the group the same way it is assigned to a person. That contact\nis managed with the group and never by hand.\n\nWho belongs to a group, and with which role, is described under *Group Members*.\n","name":"group"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.ListGroupsResponse-domain_Group":{"properties":{"count":{"type":"integer"},"data":{"items":{"$ref":"#/components/schemas/domain.Group"},"type":"array","uniqueItems":false}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups":{"get":{"description":"Returns the tenant's groups, ordered by `id` unless `sort` says otherwise.\n\n**Filterable** — `id`, `tenantId`, `name`, `description`.\n\n**Sortable** — `id`, `name`.\n\n**Searchable** — nothing yet; use `filter` with `contains` on `name`.\n","operationId":"listGroups","parameters":[{"description":"JSON filter expression","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Free-text term — no effect here","in":"query","name":"search","schema":{"type":"string"}},{"description":"Comma-separated field:direction terms","in":"query","name":"sort","schema":{"type":"string"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}},{"description":"Number of entries to skip","in":"query","name":"offset","schema":{"default":0,"type":"integer"}},{"description":"Page size, 1 to 100","in":"query","name":"limit","schema":{"default":100,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.ListGroupsResponse-domain_Group"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"List groups","tags":["group"]}}}}
```
## Create a group
> Creates a group together with its group contact, in one transaction — the group is routable from the\
> moment it exists.\
> \
> \`email\` and \`phone\` belong to that contact and are how the group is reached from the outside.\
> \`autoAssign\` opens the group to automatic ticket routing; when it is switched on, \`assignmentContext\`\
> has to describe what the group is responsible for, otherwise the request is answered with \`400\` — the\
> classification reads that text.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **group** is an internal team — support, second level, a department. Groups are what tickets get\nrouted to when no single person is meant to own them yet.\n\nCreating a group also creates its **group contact**: the face the group shows to the rest of the\nsystem, so a ticket can be assigned to the group the same way it is assigned to a person. That contact\nis managed with the group and never by hand.\n\nWho belongs to a group, and with which role, is described under *Group Members*.\n","name":"group"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.AddGroupRequest":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"type":"boolean"},"description":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"},"v1.AddGroupResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.Group"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups":{"post":{"description":"Creates a group together with its group contact, in one transaction — the group is routable from the\nmoment it exists.\n\n`email` and `phone` belong to that contact and are how the group is reached from the outside.\n`autoAssign` opens the group to automatic ticket routing; when it is switched on, `assignmentContext`\nhas to describe what the group is responsible for, otherwise the request is answered with `400` — the\nclassification reads that text.\n","operationId":"addGroup","requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.AddGroupRequest","summary":"request","description":"Group to create"}]}}},"description":"Group to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.AddGroupResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create a group","tags":["group"]}}}}
```
## Get a group
> Returns a single group by its id. A group of another tenant is answered with \`404\`.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **group** is an internal team — support, second level, a department. Groups are what tickets get\nrouted to when no single person is meant to own them yet.\n\nCreating a group also creates its **group contact**: the face the group shows to the rest of the\nsystem, so a ticket can be assigned to the group the same way it is assigned to a person. That contact\nis managed with the group and never by hand.\n\nWho belongs to a group, and with which role, is described under *Group Members*.\n","name":"group"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.GetGroupResponse-domain_Group":{"properties":{"data":{"$ref":"#/components/schemas/domain.Group"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}":{"get":{"description":"Returns a single group by its id. A group of another tenant is answered with `404`.\n","operationId":"getGroup","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}},{"description":"Selection of fields and relations","in":"query","name":"fields","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.GetGroupResponse-domain_Group"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Get a group","tags":["group"]}}}}
```
## Delete a group
> Deletes a group along with its group contact.\
> \
> A group that still has \*\*tickets assigned\*\* to it is refused with \`409\` — reassign them first.\
> Historic thread participation of the group contact is detached automatically, so a group that merely\
> took part in past conversations can be removed.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **group** is an internal team — support, second level, a department. Groups are what tickets get\nrouted to when no single person is meant to own them yet.\n\nCreating a group also creates its **group contact**: the face the group shows to the rest of the\nsystem, so a ticket can be assigned to the group the same way it is assigned to a person. That contact\nis managed with the group and never by hand.\n\nWho belongs to a group, and with which role, is described under *Group Members*.\n","name":"group"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}":{"delete":{"description":"Deletes a group along with its group contact.\n\nA group that still has **tickets assigned** to it is refused with `409` — reassign them first.\nHistoric thread participation of the group contact is detached automatically, so a group that merely\ntook part in past conversations can be removed.\n","operationId":"deleteGroup","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"No Content"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Conflict"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Delete a group","tags":["group"]}}}}
```
## Change a group
> Changes a group. The body follows JSON Merge Patch semantics: an absent field stays as it is, \`null\`\
> clears it, a value sets it. \`email\` and \`phone\` are applied to the group contact.
```json
{"openapi":"3.1.0","info":{"title":"Solvio REST API","version":"1.0.0-beta"},"tags":[{"description":"A **group** is an internal team — support, second level, a department. Groups are what tickets get\nrouted to when no single person is meant to own them yet.\n\nCreating a group also creates its **group contact**: the face the group shows to the rest of the\nsystem, so a ticket can be assigned to the group the same way it is assigned to a person. That contact\nis managed with the group and never by hand.\n\nWho belongs to a group, and with which role, is described under *Group Members*.\n","name":"group"}],"servers":[{"description":"The host serving this document","url":"/api"}],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"description":"Token issued by the central equipme authentication, sent as `Bearer `.","scheme":"bearer","type":"http"},"ApiKeyAuth":{"description":"Static key for machine-to-machine access. Alternative to BearerAuth.","in":"header","name":"X-API-Key","type":"apiKey"}},"schemas":{"v1.PatchGroupRequest":{"properties":{"description":{"type":"string"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"}},"type":"object"},"v1.PatchGroupResponse":{"properties":{"data":{"$ref":"#/components/schemas/domain.Group"}},"type":"object"},"domain.Group":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext / ContactID are read-through from the group's\nGROUP-kind Contact (like Email/Phone); they are not stored on the group table.","type":"boolean"},"contactId":{"type":"integer"},"description":{"type":"string"},"email":{"type":"string"},"id":{"type":"integer"},"members":{"items":{"$ref":"#/components/schemas/domain.GroupMember"},"type":"array","uniqueItems":false},"name":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"}},"type":"object"},"domain.GroupMember":{"properties":{"contact":{"$ref":"#/components/schemas/domain.Contact"},"contactId":{"type":"integer"},"group":{"$ref":"#/components/schemas/domain.Group"},"groupId":{"description":"The composite PK (groupId, contactId) is the by-id analogue for this join\ntable: both key columns are filter+sort (the codegen sort-minimum + what a\nby-key Query(And(Eq,Eq)).Get needs). role reproduces the old GroupMemberFilter.Role.","type":"integer"},"role":{"$ref":"#/components/schemas/domain.GroupMemberRole"}},"type":"object"},"domain.Contact":{"properties":{"assignmentContext":{"type":"string"},"autoAssign":{"description":"AutoAssign / AssignmentContext drive automated ticket routing. Set today only on\nGROUP-kind contacts via the group endpoints; nil/empty on ordinary contacts.","type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"description":{"type":"string"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"type":"integer"},"kind":{"$ref":"#/components/schemas/domain.ContactKind"},"lastName":{"type":"string"},"mobile":{"type":"string"},"phone":{"type":"string"},"tenant":{"$ref":"#/components/schemas/domain.Tenant"},"tenantId":{"type":"integer"},"title":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"type":"object"},"domain.ContactKind":{"enum":["","PERSON","INTAKE","GROUP"],"type":"string"},"domain.Tenant":{"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"},"domain.GroupMemberRole":{"enum":["","MEMBER","ADMIN","OBSERVER"],"type":"string"},"middleware.ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/middleware.ErrorBody"}},"type":"object"},"middleware.ErrorBody":{"properties":{"code":{"description":"Code is the stable, machine-readable reason. Clients match on this, not on the message.","type":"string"},"details":{"description":"Details carries structured context where an error has any — a conflict names what it\ncollided with. Absent otherwise."},"message":{"type":"string"}},"type":"object"}}},"paths":{"/v1/groups/{groupId}":{"patch":{"description":"Changes a group. The body follows JSON Merge Patch semantics: an absent field stays as it is, `null`\nclears it, a value sets it. `email` and `phone` are applied to the group contact.\n","operationId":"patchGroup","parameters":[{"description":"Group id","in":"path","name":"groupId","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"type":"object"},{"$ref":"#/components/schemas/v1.PatchGroupRequest","summary":"request","description":"Fields to change"}]}}},"description":"Fields to change","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1.PatchGroupResponse"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/middleware.ErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Change a group","tags":["group"]}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://hub.equipme.io/development/api-reference-app/group.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.