API reference

API reference · Organizations

Invite a wallet

POST/api/orgs/{id}/membersSigned in session

The invitation names an address, because a wallet is the identity here and the invitee may not have an account yet. They accept explicitly.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredintegerThe organization id.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
addressrequiredstring0x plus 40 hex characters.
roleOrgRoleowner does everything. admin does everything but delete the organization, and never acts on an owner. member uses the keys. billing reads the money and the trail and changes nothing. One of "owner", "admin", "member", "billing".

Example

{
  "address": "string",
  "role": "owner"
}

Answer 201

Invitation open.

Fields of the 201 answer
FieldTypeWhat it is
okboolean
inviteIdinteger

Errors

  • 400OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter