Skip to main content
POST
/
v1
/
admin
/
partners
Create a partner
curl --request POST \
  --url http://localhost:3000/v1/admin/partners \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "contact_email": "jsmith@example.com",
  "plan_tier": "starter",
  "healthcare": false,
  "notes": "<string>",
  "settings": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "contact_email": "<string>",
  "plan_tier": "starter",
  "healthcare": true,
  "suspended_at": "<string>",
  "settings": {},
  "notes": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Required string length: 1 - 200
contact_email
string<email>
required
plan_tier
enum<string>
default:starter
Available options:
starter,
growth,
scale,
premier,
internal
healthcare
boolean
default:false
notes
string
Maximum string length: 2000
settings
object

Response

201 - application/json

Default Response

id
string<uuid>
required
name
string
required
contact_email
string
required
plan_tier
enum<string>
required
Available options:
starter,
growth,
scale,
premier,
internal
healthcare
boolean
required
suspended_at
string | null
required
settings
object
required
notes
string | null
required
created_at
string
required
updated_at
string
required