Skip to main content
POST
Add 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.

Headers

Idempotency-Key
string

Names this create so it can be resent safely after a lost response, 1 to 255 characters. A resend returns the first group, however late it is sent. Without it every create is a new group.

Required string length: 1 - 255

Body

application/json

A new group.

name
string
required

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

The group's emoji avatar. Omit it to start with the default emoji.

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

"🔥"

Response

The new 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.