Workspace member invite

post/organizations/{id}/members

Invite a member by address with a role, and an optional language for the invitation mail. An address with no account gets a link to set a password. An account token needs account:members and can invite approver, editor, member or viewer, never admin or owner.

Before you call

Credential: Authorization: Bearer $KEY
Scope: workspace:admin
Graphql: Mutation.workspaceMemberInvite
Sdk: workspace.member.invite
Cli: workspace org member invite

Parameters

idstring (uuid)required
In the path

Request bodyapplication/json, required

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

Example request

curl -X POST 'https://api.rivier.ai/organizations/{id}/members' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown