Skip to main content
POST
/
credentials
Create
curl --request POST \
  --url https://api.mapademics.com/v1/credentials \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Web Development Certificate",
  "description": "<string>",
  "code": "CERT-WEB"
}'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "code": "<string>",
  "sections": [
    {
      "courseId": "<string>",
      "courseName": "<string>",
      "courseCode": "<string>",
      "courseDefaultSectionId": "<string>",
      "courseDisplayName": "<string>",
      "sectionId": "<string>",
      "sectionName": "<string>",
      "sectionInstructorName": "<string>",
      "sectionSkills": [
        {
          "skillId": "<string>",
          "skillName": "<string>",
          "level": 3,
          "confidence": 0.5
        }
      ]
    }
  ],
  "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

Credential name

Example:

"Web Development Certificate"

description
string | null

Credential description

code
string | null

Credential code

Example:

"CERT-WEB"

Response

Credential created successfully

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

Array of section profiles

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
code
string | null
deletedAt
string<date-time> | null