Skip to main content
POST
Accept a team invitation

What this endpoint does

Uses a valid invitation token to set the first administrator’s permanent console password and activate the account the invitation was issued to.

When to use it

Submit it once after the recipient has reviewed the invitation and chosen a password.

Before you call

Pass a valid, unused invitation token and a request that meets the credential requirements. No API key is required.

Money and balance effect

This changes a resource or configuration but does not directly reserve, debit, credit, or settle wallet money.

States and completion

A successful response consumes the token. Expired or previously used tokens must be replaced by a new invitation.

Safe retries

Do not submit concurrently. If the response is lost, validate the token again before retrying; a consumed token means activation already completed. Read Team and roles for the complete workflow.

Path Parameters

token
string
required

Body

application/json
password
string
required
Required string length: 12 - 256

Response

Account activated; includes the login URL.

ok
boolean
required
loginUrl
string<uri>
required