Component schema

InviteMemberRequest

object1 direct reference

Definition

stringrequired

The address the invitation is sent to. An address that the organization's sign-up restrictions do not permit is rejected with 403, and an address that already belongs to the organization, or already has a pending invitation, with 409.

stringrequired

The role the invited member receives. The built-in roles are admin and basic_member; an organization with custom roles configured may use those instead. An unknown role is rejected with 400.

Used by 1

These schemas and endpoints reference this type directly.

EndpointPOST /api/members

json

OpenAPI source{
  "properties": {
    "emailAddress": {
      "description": "The address the invitation is sent to. An address that the organization's sign-up\nrestrictions do not permit is rejected with `403`, and an address that already belongs\nto the organization, or already has a pending invitation, with `409`.\n",
      "type": "string"
    },
    "role": {
      "description": "The role the invited member receives. The built-in roles are `admin` and\n`basic_member`; an organization with custom roles configured may use those instead.\nAn unknown role is rejected with `400`.\n",
      "type": "string"
    }
  },
  "required": [
    "emailAddress",
    "role"
  ]
}