Skip to main content
POST
/
transfer-packages
Create
curl --request POST \
  --url https://api.mapademics.com/v1/transfer-packages \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "John Doe - Community College Transfer",
  "description": "<string>",
  "transferFromInstitution": "Springfield Community College",
  "uniqueTag": "<string>",
  "matchingConfig": {
    "fullEquivalentThreshold": 0.85,
    "partialEquivalentThreshold": 0.6
  },
  "courses": [
    {
      "name": "<string>",
      "description": "<string>",
      "syllabusHref": "<string>"
    }
  ]
}'
{
  "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

Body

application/json
name
string
required

Package name

Example:

"John Doe - Community College Transfer"

transferFromInstitution
string
required

Name of the transferring institution

Example:

"Springfield Community College"

description
string | null

Package description

uniqueTag
string | null

Optional student ID or unique identifier

matchingConfig
object
courses
object[]

Optional array of transfer courses to create with the package

Response

Transfer package created 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