Skip to main content
PATCH
/
transfer-packages
/
{packageId}
Update
curl --request PATCH \
  --url https://api.mapademics.com/v1/transfer-packages/{packageId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "transferFromInstitution": "<string>",
  "uniqueTag": "<string>",
  "matchingConfig": {
    "fullEquivalentThreshold": 0.85,
    "partialEquivalentThreshold": 0.6
  }
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "transferFromInstitution": "<string>",
  "uniqueTag": "<string>",
  "matchingConfig": {
    "fullEquivalentThreshold": 0.85,
    "partialEquivalentThreshold": 0.6
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

packageId
string
required

Unique identifier for the transfer articulation package

Body

application/json
name
string

Package name

description
string | null

Package description

transferFromInstitution
string

Name of the transferring institution

uniqueTag
string | null

Student ID or unique identifier

matchingConfig
object

Response

Transfer package updated successfully

id
string
required
organizationId
string
required
name
string
required
transferFromInstitution
string
required
matchingConfig
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
uniqueTag
string | null
deletedAt
string<date-time> | null