Skip to main content
POST
/
api
/
v1
/
ranks
Create a rank
curl --request POST \
  --url https://api.scholarlysoftware.com/api/v1/ranks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "rank",
    "attributes": {
      "name": "<string>",
      "external_id": "<string>"
    },
    "relationships": {}
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "rank",
    "attributes": {
      "created_at": "<string>",
      "updated_at": "<string>",
      "name": "<string>",
      "external_id": "<string>"
    },
    "relationships": {},
    "meta": {
      "deletable": true,
      "primary_appointments_count": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.scholarlysoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Authorization
string
required

Bearer token

Body

application/vnd.api+json
​
data
object
required

Response

rank created

​
data
object
required