organizations

Add or invite a member by email (admin+; owner required to grant owner). Unknown emails get an invite link.

post/organizations/{id}/members

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/organizations/{id}/members
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

emailstring email required
role'owner' | 'admin' | 'member'

Example request

{
  "$schema": "/api/v1/schemas/AddMemberInputBody.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

invitedboolean required

An invite email was sent (pending account).

Example response

{
  "$schema": "/api/v1/schemas/AddMemberOutputBody.json",
  "member": {
    "$schema": "/api/v1/schemas/MemberJSONView.json"
  }
}

Changes

No recorded changes to this operation across all 13 revisions of this API.