Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Invite a user

POST
/api/v1/users
curl --request POST \
  --url https://api.pitch2sale.com/api/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "first_name": "example", "last_name": "example", "role_id": "example", "password": "example" }'

Creates a pending user and emails an invitation; email_configured is false when no email provider is set up, so share the invite link instead.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string format: email
first_name
required
string
>= 1 characters <= 100 characters
last_name
required
string
>= 1 characters <= 100 characters
role_id
required
string
>= 1 characters
password
/[a-z]/
/[A-Z]/
/[0-9]/
Examplegenerated
{
  "email": "hello@example.com",
  "first_name": "example",
  "last_name": "example",
  "role_id": "example",
  "password": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

The invited user

Media typeapplication/json
object
user
required
object
_id
required
string
email
required
string
key
additional properties
any
email_configured
required
boolean
Examplegenerated
{
  "user": {
    "_id": "example",
    "email": "example"
  },
  "email_configured": true
}

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Section titled “403”

Role permission or token scope missing

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}