v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Contacts

Update a group

Update an existing group (Permitted scopes: fax:all:edit)

put/accounts/self/contact-groups/{group_id}

Path parameters

group_idstring required

Group ID

Request body

namestring

Group name

notesstring

Additional notes or description for the group

Example request

{
  "name": "Premium Clients",
  "notes": "Updated notes"
}

Response

Response containing a single group object

idstring

Group ID

namestring

Group name

notesstring

Additional notes or description for the group

is_sharedboolean

Whether group is shared with corporate members

creation_datestring

Date group was created

modification_datestring

Date group was last modified

Example response

{
  "id": "5f7a8b9c0d1e2f3a4b5c6d7f",
  "name": "VIP Clients",
  "notes": "Important clients only",
  "is_shared": true,
  "creation_date": "2024-01-10T09:00:00Z",
  "modification_date": "2024-02-15T11:20:00Z"
}