team

Invite Teammate

Invite a teammate onto the current user's business. Only an owner may invite (require_role(owner) above) -- editors/viewers can't grant access to others. Role is restricted to editor/viewer: an invite can never grant "owner" (there is exactly one owner per business -- the original account holder -- in this basic-scope version; ownership transfer isn't supported yet).

post/team/invite

Request

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

Request body

emailstring email required
rolestring

Response

Successful Response

idstring required
invited_emailstring required
rolestring required
statusstring required
member_user_idstring nullable
created_atstring nullable
accepted_atstring nullable

Changes

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