Programs

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/x-www-form-urlencoded

product_actionstringRequired

Action to perform. Possible values: archive, reactivate

product_idsinteger[]Required

Array of product ids to perform the action on

Responses

200

All programs have been successfully processed

application/json

Responseobject

422

Some programs have failed to process successfully

application/json

put

/api/v1/programs/archived

HTTPcURLJavaScriptPython

PUT /api/v1/programs/archived HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"product_action='text'&product_ids=[1]"

{}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific program

application/json

get

/api/v1/programs/{id}

HTTPcURLJavaScriptPython

GET /api/v1/programs/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific program

{
  "program": {
    "id": 12,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_12",
    "enrollment_fee": 0,
    "created_at": "2024/01/01 00:00:00 +0000",
    "credits": 9,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "teaser_12",
    "listing_path": "program-path-12",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 20,
      "name": "Domain Account 20"
    },
    "type": "Program",
    "title": "Program 12",
    "list_order": null,
    "waitlist": false,
    "waitlist_cap": null,
    "sku": null,
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Another Tag",
      "Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/programs/program-path-12",
    "start_date": "2023/12/25 00:00:00 +0000",
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [],
    "archived_at": null,
    "sequential": true,
    "requirements": [
      {
        "id": 13,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_13",
        "enrollment_fee": 0,
        "created_at": "2024/01/01 00:00:00 +0000",
        "credits": 3,
        "measurement": "credit",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "short_description": "teaser_13",
        "listing_path": "program-path-13",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 20,
          "name": "Domain Account 20"
        },
        "type": "Program",
        "title": "Program 13",
        "list_order": null,
        "waitlist": false,
        "waitlist_cap": null,
        "sku": null,
        "show_free_banner": true,
        "image_alt_text": null,
        "allowed_payment_types": [
          "standard"
        ],
        "tag_names": [],
        "listing_url": "http://www.my-catalog.edu/programs/program-path-13",
        "start_date": "2023/12/25 00:00:00 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [],
        "archived_at": null,
        "sequential": true,
        "requirements": [
          {
            "id": 15,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_15",
            "enrollment_fee": 0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_15",
            "listing_path": "course-path-15",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 20,
              "name": "Domain Account 20"
            },
            "type": "Course",
            "title": "Course 15",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_6",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-15",
            "start_date": "2023/12/25 00:00:00 +0000",
            "end_date": "2024/01/08 00:00:00 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "archived_at": null,
            "canvas_course": {
              "id": 6
            },
            "instructor_names": [],
            "primary_instructor_name": null
          }
        ]
      },
      {
        "id": 14,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_14",
        "enrollment_fee": 0,
        "created_at": "2024/01/01 00:00:00 +0000",
        "credits": 6,
        "measurement": "credit",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "short_description": "teaser_14",
        "listing_path": "program-path-14",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 20,
          "name": "Domain Account 20"
        },
        "type": "Program",
        "title": "Program 14",
        "list_order": null,
        "waitlist": false,
        "waitlist_cap": null,
        "sku": null,
        "show_free_banner": true,
        "image_alt_text": null,
        "allowed_payment_types": [
          "standard"
        ],
        "tag_names": [],
        "listing_url": "http://www.my-catalog.edu/programs/program-path-14",
        "start_date": "2023/12/25 00:00:00 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [],
        "archived_at": null,
        "sequential": true,
        "requirements": [
          {
            "id": 16,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_16",
            "enrollment_fee": 0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_16",
            "listing_path": "course-path-16",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 20,
              "name": "Domain Account 20"
            },
            "type": "Course",
            "title": "Course 16",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_7",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-16",
            "start_date": "2023/12/25 00:00:00 +0000",
            "end_date": "2024/01/08 00:00:00 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "archived_at": null,
            "canvas_course": {
              "id": 7
            },
            "instructor_names": [],
            "primary_instructor_name": null
          },
          {
            "id": 17,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_17",
            "enrollment_fee": 0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_17",
            "listing_path": "course-path-17",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 20,
              "name": "Domain Account 20"
            },
            "type": "Course",
            "title": "Course 17",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_8",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-17",
            "start_date": "2023/12/25 00:00:00 +0000",
            "end_date": "2024/01/08 00:00:00 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "archived_at": null,
            "canvas_course": {
              "id": 8
            },
            "instructor_names": [],
            "primary_instructor_name": null
          }
        ]
      }
    ]
  }
}

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Body

application/json

skustringOptional

Listing SKU

Responses

204

Updating a program

*/*

put

/api/v1/programs/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/programs/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "program": {
    "title": "text",
    "description": "text",
    "path": "text",
    "teaser": "text",
    "enrollment_open": "text",
    "enrollment_open_from": "text",
    "enrollment_open_to": "text",
    "visibility": "text",
    "enrollment_cap": "text",
    "enrollment_fee": "text",
    "allowed_payment_types": "text",
    "days_to_complete": "text",
    "account_id": "text",
    "list_order": "text",
    "waitlist": "text",
    "waitlist_cap": "text",
    "listing_image": "text",
    "tag_names": [
      "text"
    ],
    "show_free_banner": "text",
    "associated_account_ids": "text",
    "requirement_ids": "text",
    "sequential": "text"
  },
  "sku": "text"
}

204

Updating a program

{}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

204

Deleting a specific program

*/*

delete

/api/v1/programs/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/programs/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting a specific program

{}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Responses

200

Listing programs

application/json

Responseobject

get

/api/v1/programs

HTTPcURLJavaScriptPython

GET /api/v1/programs HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing programs

{
  "programs": [
    {
      "id": 24,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_24",
      "enrollment_fee": 0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 9,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_24",
      "listing_path": "program-path-24",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 22,
        "name": "Domain Account 22"
      },
      "type": "Program",
      "title": "Program 24",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [
        "Another Tag",
        "Tag"
      ],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-24",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 25,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_25",
          "enrollment_fee": 0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_25",
          "listing_path": "program-path-25",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 22,
            "name": "Domain Account 22"
          },
          "type": "Program",
          "title": "Program 25",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": null,
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/programs/program-path-25",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [],
          "archived_at": null,
          "sequential": true,
          "requirements": [
            {
              "id": 27,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_27",
              "enrollment_fee": 0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_27",
              "listing_path": "course-path-27",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 22,
                "name": "Domain Account 22"
              },
              "type": "Course",
              "title": "Course 27",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_12",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-27",
              "start_date": "2023/12/25 00:00:00 +0000",
              "end_date": "2024/01/08 00:00:00 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "archived_at": null,
              "canvas_course": {
                "id": 12
              },
              "instructor_names": [],
              "primary_instructor_name": null
            }
          ]
        },
        {
          "id": 26,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_26",
          "enrollment_fee": 0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 6,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_26",
          "listing_path": "program-path-26",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 22,
            "name": "Domain Account 22"
          },
          "type": "Program",
          "title": "Program 26",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": null,
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/programs/program-path-26",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [],
          "archived_at": null,
          "sequential": true,
          "requirements": [
            {
              "id": 28,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_28",
              "enrollment_fee": 0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_28",
              "listing_path": "course-path-28",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 22,
                "name": "Domain Account 22"
              },
              "type": "Course",
              "title": "Course 28",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_13",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-28",
              "start_date": "2023/12/25 00:00:00 +0000",
              "end_date": "2024/01/08 00:00:00 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "archived_at": null,
              "canvas_course": {
                "id": 13
              },
              "instructor_names": [],
              "primary_instructor_name": null
            },
            {
              "id": 29,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_29",
              "enrollment_fee": 0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_29",
              "listing_path": "course-path-29",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 22,
                "name": "Domain Account 22"
              },
              "type": "Course",
              "title": "Course 29",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_14",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-29",
              "start_date": "2023/12/25 00:00:00 +0000",
              "end_date": "2024/01/08 00:00:00 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "archived_at": null,
              "canvas_course": {
                "id": 14
              },
              "instructor_names": [],
              "primary_instructor_name": null
            }
          ]
        }
      ]
    },
    {
      "id": 25,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_25",
      "enrollment_fee": 0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 3,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_25",
      "listing_path": "program-path-25",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 22,
        "name": "Domain Account 22"
      },
      "type": "Program",
      "title": "Program 25",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-25",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 27,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_27",
          "enrollment_fee": 0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_27",
          "listing_path": "course-path-27",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 22,
            "name": "Domain Account 22"
          },
          "type": "Course",
          "title": "Course 27",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_12",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-27",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": "2024/01/08 00:00:00 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "archived_at": null,
          "canvas_course": {
            "id": 12
          },
          "instructor_names": [],
          "primary_instructor_name": null
        }
      ]
    },
    {
      "id": 26,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_26",
      "enrollment_fee": 0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 6,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_26",
      "listing_path": "program-path-26",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 22,
        "name": "Domain Account 22"
      },
      "type": "Program",
      "title": "Program 26",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-26",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 28,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_28",
          "enrollment_fee": 0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_28",
          "listing_path": "course-path-28",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 22,
            "name": "Domain Account 22"
          },
          "type": "Course",
          "title": "Course 28",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_13",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-28",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": "2024/01/08 00:00:00 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "archived_at": null,
          "canvas_course": {
            "id": 13
          },
          "instructor_names": [],
          "primary_instructor_name": null
        },
        {
          "id": 29,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_29",
          "enrollment_fee": 0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_29",
          "listing_path": "course-path-29",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 22,
            "name": "Domain Account 22"
          },
          "type": "Course",
          "title": "Course 29",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_14",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-29",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": "2024/01/08 00:00:00 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "archived_at": null,
          "canvas_course": {
            "id": 14
          },
          "instructor_names": [],
          "primary_instructor_name": null
        }
      ]
    }
  ]
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

skustringOptional

Listing SKU

Responses

201

Creating a program

application/json

post

/api/v1/programs

HTTPcURLJavaScriptPython

POST /api/v1/programs HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 527

{
  "program": {
    "title": "text",
    "description": "text",
    "path": "text",
    "teaser": "text",
    "enrollment_open": "text",
    "enrollment_open_from": "text",
    "enrollment_open_to": "text",
    "visibility": "text",
    "enrollment_cap": "text",
    "enrollment_fee": "text",
    "allowed_payment_types": "text",
    "days_to_complete": "text",
    "account_id": "text",
    "list_order": "text",
    "waitlist": "text",
    "waitlist_cap": "text",
    "listing_image": "text",
    "tag_names": [
      "text"
    ],
    "show_free_banner": "text",
    "associated_account_ids": "text",
    "requirement_ids": "text",
    "sequential": "text"
  },
  "sku": "text"
}

201

Creating a program

{
  "program": {
    "id": 30,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": 150,
    "description": "This is a very awesome program.",
    "enrollment_fee": 49.99,
    "created_at": "2024/01/01 00:00:00 +0000",
    "credits": null,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "program-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 23,
      "name": "Domain Account 23"
    },
    "type": "Program",
    "title": "Program 1",
    "list_order": 123,
    "waitlist": true,
    "waitlist_cap": 12,
    "sku": "abc1234",
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Tag",
      "Another Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/programs/program-1",
    "start_date": null,
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [],
    "archived_at": null,
    "sequential": true,
    "requirements": []
  }
}