Sign in
organizations

Create Active Organization Member

Changed on

Add a member to the caller's active organization, by email address.

Organization owners and admins only. The member is active immediately and the response says so: this edition has no invitation to send and no way to accept one, so it answers on the active arm of the result rather than the invited one the platform uses. An address that belongs to no identity yet creates one, which carries the address as the handle a future sign-in flow will claim it by, and can do nothing until then.

post/api/v1/organizations/me/members

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

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

Response

Successful Response

attribution_user_idstring nullable
created_atstring date-time nullable
emailstring required
expires_atstring date-time nullable
full_namestring nullable
invitation_idstring uuid nullable
organization_member_idstring uuid nullable
rolestring required
status'active' | 'invited' required
updated_atstring date-time nullable
user_idstring uuid nullable

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id create_active_organization_member_api_v1_organizations_me_members_post removed and replaced with organizations-create_active_organization_member