invites

Invite an email to the org with a role (owner/admin only; the invite email is sent for you)

post/v1/orgs/{org_id}/invites

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/orgs/{org_id}/invites
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer

Path parameters

org_idstring required

Headers

Idempotency-Keystring

A unique value you choose per logical request (a random UUID). A retry with the same key and the same request within 24 hours returns the first response, marked Idempotency-Replayed: true, instead of acting twice. The same key with a different request is refused with 422; one sent while the first is still running gets 409.

Request body

emailstring email required

Email to invite

role'owner' | 'admin' | 'member' required

Org role to grant on accept

Response

Created

accept_urlstring
created_atstring date-time
emailstring required
expires_atstring date-time
invite_idstring required
org_idstring required
rolestring required
statusstring required

Changes

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