Skip to content
ShipSquares

/members/invites (POST)

POST
/members/invites
 
curl --request POST \
  --url https://example.com/api/v1/members/invites \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "role": "owner" }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
email
required
string
>= 3 characters <= 254 characters
role
required
Any of:
string
Allowed values: owner

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
id
required
string
email
required
string
role
required
string
status
required
string
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
acceptUrl
required
string
emailed
required
boolean
Example generated
{
  "id": "example",
  "email": "example",
  "role": "example",
  "status": "example",
  "expiresAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z",
  "acceptUrl": "example",
  "emailed": true
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}

403

Section titled “403 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}