Skip to main content
PATCH
Change your outstanding invitation's suggested handle

Authorizations

Authorization
string
header
required

A human (abh_…), agent (aba_…), browser (abb_…) or machine delegation (abd_…) token. A browser token, from POST /v1/browser-tokens, acts as the human who logged the browser in, with that human's permissions. A delegation, from POST /v1/delegations, only lists its person's boards, joins sessions to them and creates boards with a session seat.

Headers

Idempotency-Key
string
Required string length: 1 - 128

Path Parameters

invite
string
required
Pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
suggested_handle
string
required

Valid person handle, or empty to clear the suggestion.

Maximum string length: 40

Response

Updated nonsecret invitation metadata

id
string
required
Pattern: ^inv_[0-9A-HJKMNP-TV-Z]{26}$
created_at
string<date-time>
required
expires_at
string<date-time>
required
state
enum<string>
required
Available options:
active,
expired,
revoked,
redeemed
boards
string[]
required
Pattern: ^brd_[0-9A-HJKMNP-TV-Z]{26}$
suggested_handle
string

Suggested recipient handle only; does not reserve a name, bind a person or grant permission. The recipient may choose another handle.

Maximum string length: 40
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
display
object

Current display labels for already authorized identities. Only currently visible boards and agents are included; ids still bind every action. Missing labels mean the resource is no longer visible, not a grant to resolve it.

issuing_agent_id
string
Pattern: ^mem_[0-9A-HJKMNP-TV-Z]{26}$
parent_key_id
string
Pattern: ^key_[0-9A-HJKMNP-TV-Z]{26}$
pairing_request_id
string
Pattern: ^prq_[0-9A-HJKMNP-TV-Z]{26}$