Skip to main content
POST
Add tokens to group

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string<uuid>
required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

groupId
string<uuid>
required

The token group group_id

Body

application/json
token_ids
string<uuid>[]
required

The id of each token to add

Required array length: 1 - 1000 elements

Response

The updated group

group_id
string<uuid>
required

Stable token group id

tenant_id
string
required

Owning tenant, set by the platform

emsp_identity_id
string<uuid> | null
required

The EMSP identity the group belongs to. Null means the tenant's default identity

name
string
required
Required string length: 1 - 255
token_count
integer
required

Number of member tokens

Required range: x >= 0
status_summary
object
required

Number of member tokens in each status. The counts add up to token_count

audit
object
required
description
string | null
Maximum string length: 1000
external_id
string | null

Your own identifier for the group. Filterable, never interpreted, and not required to be unique

Maximum string length: 255
metadata
object | null

Name/value pairs you attach to the group

network_ids
string<uuid>[]

Networks assigned to the group. Managed through the network assignment operations