Skip to main content
POST
Give members a rank

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Path Parameters

id
integer
required

Body

application/json

Exactly one of levelId and next.

contactIds
integer[]
required
Required array length: 1 - 100 elements
levelId
integer

The rank to give, a level of this track.

next
boolean

True for each member's own next rank, stripes back to zero.

stripes
integer

Stripes at levelId, up to the track's maxStripes.

Required range: x >= 0
earnedOn
string<date>

The calendar date it was earned; today when omitted. May be in the past.

notifyMember
boolean
default:true

Tell the member about a move forward. False when recording ranks they already hold.

Response

Who was ranked, skipped and failed

assigned
object[]
skipped
object[]

Left as they were by next: no rank on the track to move up from, or already at its top.

failed
object[]

Failed; everyone else was still ranked.