Skip to main content
PATCH
Change a group

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token for a non-impersonated rep or shopper. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of one of the member's groups.

Body

application/json

Fields to change.

name
string

Group name.

Required string length: 1 - 255
Pattern: ^[^\u0000]*[^\s\u0000][^\u0000]*$
color
string

Display color as #RRGGBB.

Pattern: ^#[0-9A-Fa-f]{6}$
avatar
string | null

The group's emoji avatar. Send null to clear it.

Required string length: 1 - 255
Pattern: ^[^\u0000]*[^\s\u0000][^\u0000]*$
Example:

"🔥"

Response

The changed group.

One group.

status
integer
required
data
object
required

A named set of the member's contacts.

meta
object
required

Envelope metadata present on every response.