Update a faculty activity

curl --request PATCH \
  --url https://api.scholarlysoftware.com/api/v1/faculty_activities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "faculty_activity",
    "attributes": {
      "properties": {}
    },
    "relationships": {}
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "faculty_activity",
    "attributes": {
      "key": "<string>",
      "external_id": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "properties": {}
    },
    "relationships": {
      "profile": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}

PATCH

api

faculty_activities

{id}

Update a faculty activity

curl --request PATCH \
  --url https://api.scholarlysoftware.com/api/v1/faculty_activities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "faculty_activity",
    "attributes": {
      "properties": {}
    },
    "relationships": {}
  }
}
'

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "faculty_activity",
    "attributes": {
      "key": "<string>",
      "external_id": "<string>",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "properties": {}
    },
    "relationships": {
      "profile": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "profile",
          "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

string

required

Faculty Activity UUID

Body

application/vnd.api+json

data

object

required

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "faculty_activity"

Example:

"faculty_activity"

data.attributes

object

Show child attributes

data.attributes.properties

object

data.relationships

object

Response

faculty activity updated

data

object

required

Show child attributes

data.id

string<uuid>

required

data.type

string

required

Allowed value: "faculty_activity"

Example:

"faculty_activity"

data.attributes

object

required

Show child attributes

data.attributes.key

string | null

data.attributes.external_id

string | null

An optional external identifier for the activity, such as an ID from an external system. We highly recommend setting this value if this resource is being synchronized from an external system, as it will help prevent duplicate entries when syncing data.

data.attributes.start_date

string<date> | null

data.attributes.end_date

string<date> | null

data.attributes.properties

object

data.relationships

object

Show child attributes

data.relationships.profile

object

Option 1
Option 2
Option 3

Show child attributes

data.relationships.profile.links

object

required

Show child attributes

data.relationships.profile.meta

object

data.relationships.profile.data

object

Show child attributes

data.relationships.profile.data.type

string

required

Allowed value: "profile"

Example:

"profile"

data.relationships.profile.data.id

string<uuid>

required

Delete a faculty activity List faculty activity configurations

⌘I

API reference

Authorizations

Headers

Path Parameters

Body

Response