Skip to main content
PUT /v1/groups/:id

{
  "id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "name": "Annature group",
  "business": "Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "Level 38, 71 Eagle Street, Brisbane 4000",
  "website": "www.annature.com.au",
  "color": "#5469d4",
  "logo": "https://annature..",
  "created": "2019-12-17T05:30:00Z"
}
Updates the details of an existing group. This endpoint allows you to modify a group’s branding, contact information, or business identity. Updates will apply to all future envelopes sent by accounts in the group and may affect the recipient-facing appearance of previously sent envelopes if branding settings are reused or cached. To update the logo, supply a new base64-encoded image string. Contact and branding changes will take effect immediately.

​
Parameters

​
id
required
The unique identifier of the group to update.
​
name
required
The display name for the group, as shown in the Annature dashboard.
​
business
optional
The business name to display to recipients. Overrides the organisation’s default name.
​
email
optional
Email address to use in place of the sender’s or organisation’s.
​
number
optional
Contact number to display to recipients.
​
address
optional
Street address to display in place of the organisation’s.
​
website
optional
Website URL used in recipient-facing emails and branding.
A base64-encoded logo image.The image must decode to a valid image/jpeg, image/png, or image/gif format. Maximum size: 5MB.
​
color
optional
Hex colour code for the group’s branding theme.Must be a 6-digit code prefixed with # (e.g. #5469d4).
PUT /v1/groups/:id

{
  "id": "a5a885caee6286a54ad7bbd4ab5400e9",
  "name": "Annature group",
  "business": "Annature",
  "email": "ted@annature.com.au",
  "number": "1300 000 000",
  "address": "Level 38, 71 Eagle Street, Brisbane 4000",
  "website": "www.annature.com.au",
  "color": "#5469d4",
  "logo": "https://annature..",
  "created": "2019-12-17T05:30:00Z"
}