Skip to main content
POST
Create serial group

Authorizations

X-API-Key
string
header
required

Query Parameters

organization_id
string<shortuuid>

Organization to act on. Omit it: an API key acts on its own organization, and a session or OAuth caller on its single organization. Required only for a session or OAuth caller that belongs to more than one organization (400 without it).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Payload to create an empty lot group or serial group.

brand_id
string<shortuuid>
required

UUID of one of the organization's brands; the group belongs to it.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

The group's label (max 120 characters). It must be unique within the brand.

Required string length: 1 - 120
Pattern: ^[^\x00]{1,120}$

Response

Created

A serial group as read from the API.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
name
string
required

The group's label (max 120 characters), unique within its brand.

brand_id
string<shortuuid>
required

UUID of the brand that owns the group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
organization_id
string<shortuuid>
required

UUID of the organization that owns the group.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
member_count
integer
required

How many members the group has right now.

created
string<date-time>
required

ISO-8601 creation timestamp.

modified
string<date-time>
required

ISO-8601 last-modified timestamp.