Skip to main content
POST
/
programs
Create
curl --request POST \
  --url https://api.mapademics.com/v1/programs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Bachelor of Science in Computer Science",
  "description": "<string>",
  "code": "BS-CS",
  "cipCode": "11.0701"
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "cipCode": "<string>",
  "courses": [
    {
      "courseId": "<string>",
      "courseName": "<string>",
      "courseCode": "<string>",
      "courseDefaultSectionId": "<string>",
      "courseDisplayName": "<string>"
    }
  ],
  "courseOrder": [
    "<string>"
  ],
  "derivedSocs": [
    "15-1252",
    "15-1256"
  ],
  "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

Program name

Example:

"Bachelor of Science in Computer Science"

description
string | null

Program description

code
string | null

Program code

Example:

"BS-CS"

cipCode
string | null

CIP (Classification of Instructional Programs) code

Example:

"11.0701"

Response

Program created successfully

id
string
required
organizationId
string
required
name
string
required
courses
object[]
required

Array of course profiles

courseOrder
string[]
required

Ordered array of course IDs for curriculum sequencing

derivedSocs
string[]
required

SOC codes derived from the CIP code

Example:
["15-1252", "15-1256"]
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
code
string | null
cipCode
string | null

CIP (Classification of Instructional Programs) code

deletedAt
string<date-time> | null