Invitations
Invite someone into the current tenant
A live invitation for the same address is retired and replaced, so a retry or a "send it again" is this same call. ALREADY_EXISTS when the address is already a member. INVALID_ARGUMENT for OWNER, which moves by transfer, never by invitation.
Scope: user:write
Authorization
bearerAuth AuthorizationBearer <token>
An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
CreateInvitationRequest invites one address into the caller's tenant.
Response Body
application/json
curl -X POST "https://example.com/v1/invitations" \ -H "Content-Type: application/json" \ -d '{ "invitation": {} }'{ "invitation": { "id": "string", "email": "user@example.com", "role": "USER_ROLE_ADMIN", "status": "STATUS_UNSPECIFIED", "invited_by": { "id": "string", "display_name": "string", "email": "string" }, "created_at": "2023-01-15T01:30:15.01Z", "expires_at": "2023-01-15T01:30:15.01Z", "accepted_at": "2023-01-15T01:30:15.01Z", "accepted_by": { "id": "string", "display_name": "string", "email": "string" }, "revoked_at": "2023-01-15T01:30:15.01Z" }}