members

Invite a colleague to this firm by email (admin)

WorkOS creates the invitation, good for seven days, and THIS SERVICE emails it (D-76): the message names the firm, the role and the download page, and carries no accept link and no token, because the person's first sign-in accepts it and creates their rows with this role (D-73). An address that already has a membership in this firm is a 409 naming the patch that changes it. Without a mail key the route answers 503 before creating anything; a send that fails revokes the invitation and answers 502.

post/v1/members/invite

Request

  • Base URL
    https://api.sixminute.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

emailstring email required
role'timekeeper' | 'billing' | 'admin' required

Response

The invitation, created and emailed.

idstring required
emailstring email required
role'timekeeper' | 'billing' | 'admin' required
expires_atstring date-time required
created_atstring date-time required

Changes

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