Skip to main content
PATCH
/
api
/
v1
/
profiles
/
{id}
Update a profile
curl --request PATCH \
  --url https://api.scholarlysoftware.com/api/v1/profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "profile",
    "attributes": {
      "display_name": "<string>",
      "legal_first_name": "<string>",
      "legal_middle_name": "<string>",
      "legal_last_name": "<string>",
      "legal_maiden_name": "<string>",
      "suffix": "<string>",
      "deceased_on": "2023-12-25",
      "racial_identity": "<string>",
      "primary_employee_id": "<string>",
      "employee_ids": "<any>",
      "gender_identity": "<string>",
      "custom_fields": "<any>"
    },
    "relationships": {
      "primary_appointments": {
        "data": [
          {
            "type": "primary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "additional_appointments": {
        "data": [
          {
            "type": "secondary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      },
      "addresses": {
        "data": [
          {
            "type": "address",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    }
  }
}'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "profile",
    "attributes": {
      "display_name": "<string>",
      "legal_first_name": "<string>",
      "legal_middle_name": "<string>",
      "legal_last_name": "<string>",
      "legal_maiden_name": "<string>",
      "suffix": "<string>",
      "deceased_on": "2023-12-25",
      "racial_identity": "<string>",
      "primary_employee_id": "<string>",
      "employee_ids": "<any>",
      "avatar_url": "<string>",
      "gender_identity": "<string>",
      "custom_fields": "<any>"
    },
    "relationships": {
      "current_department": {
        "data": {
          "type": "department",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "current_primary_appointment": {
        "data": {
          "type": "primary_appointment",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "primary_appointments": {
        "data": [
          {
            "type": "primary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "additional_appointments": {
        "data": [
          {
            "type": "secondary_appointment",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "links": {
          "related": "<string>"
        },
        "meta": {}
      },
      "addresses": {
        "links": {
          "related": "<string>"
        },
        "meta": {}
      }
    }
  }
}

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

Profile UUID

Body

application/vnd.api+json
data
object
required

Response

profile updated

data
object
required
I