Skip to main content
PATCH
/
api
/
v1
/
primary_appointments
/
{id}
Update primary appointment
curl --request PATCH \
  --url https://api.scholarlysoftware.com/api/v1/primary_appointments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "primary_appointment",
    "attributes": {
      "title": "Associate Professor",
      "effective_from": "2025-01-01",
      "appointment_type": "Tenure Track",
      "track_type": "Research",
      "external_id": "EMP001234",
      "effective_to": "2026-01-01",
      "terminated_on": "2026-12-31",
      "termination_note": "Resigned to accept position elsewhere",
      "percent_allocation": 100,
      "full_time": true
    },
    "relationships": {
      "profile": {
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "rank": {
        "data": {
          "type": "rank",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "department": {
        "data": {
          "type": "department",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}'

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

Path Parameters

​
id
string
required

Primary appointment UUID

Body

application/vnd.api+json
​
data
object
required

Response

primary appointment updated with record extras

⌘I