Skip to content
rowlab Docs

Invite Member

POST
/v1/settings/invites
curl --request POST \
  --url https://example.com/v1/settings/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "role": "verifier" }'

Invite an email address. Nobody is emailed: they join when they first sign in.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
InviteRequest
object
email
required
Email
string
role
Role
string
default: member
Allowed values: verifier member admin

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
Invite
object
id
required
Id
string
email
required
Email
string
role
required
Role
string
Allowed values: verifier member admin
created_at
required
Created At
string format: date-time

Example 

{
  "role": "verifier"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}