Create an invitation

Creates a User and invites User to Workspace

post/{workspace}/invites

Request

Path parameters

workspacestring required

Workspace username

Request body

Example request

{
  "invite": {
    "invitee": {
      "email": "harold.ceramicist@example.com"
    },
    "message": "You are an analyst, Harry!"
  }
}

Response

WorkspaceInvite response

emailstring required
messagestring required
inviter_idstring required
invitee_idstring required
organization_idstring required
limitedstring required
sent_atstring
resent_atstring
clicked_atstring
accepted_atstring
expires_atstring required
created_atstring required
_embeddedunknown

Changes

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