Invite a person with a role

Before you call

Credential

Authorization: Bearer $KEY

Scope

workspace:admin

Graphql

Mutation.workspacePeopleInvite

Sdk

workspace.people.invite

Cli

workspace people invite

Request bodyapplication/json, required

• emailstring (email)required
  At most 320 characters.
• rolestringrequired
  One of: owner, manager, approver, editor, agent, viewer, accountant.
• expires_atstring (date-time)

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring