organizationUserInvitations

Invite a user to the organization

Invites an email address to join the authenticated organization. The identity provider sends the email and hosts acceptance; the membership is written on the invitee's first sign-in. Any email domain is accepted, which is the only way to add a teammate whose domain the organization does not claim.

post/v1/organization-user-invitations

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/organization-user-invitations
  • Auth: HTTP bearer

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Request body

emailstring email required

Address to invite. Any domain is accepted — this is the only way to add a teammate whose email domain the organization does not claim. For consumer domains the recipient must sign up with exactly this address.

Response

Changes

No recorded changes to this operation across all 1 revision of this API.