Skip to content
API Reference
/
catalog
/
catalog_suggestions_course_manage_destroy

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_suggestions_course_manage_create

Request

API View for managing course suggestions.

This endpoint allows administrators to view, create, update, and delete course suggestions for users within a platform.

Query Parameters (GET): platform_key (str, required): The platform to retrieve suggestions for platform_org (str, optional): The organization identifier for the platform query (str, optional): Search term to filter suggestions sort (str, optional): Field to sort results by (default: '-id') department_mode (bool, optional): Filter suggestions by department admin access page (int, optional): Page number for pagination page_size (int, optional): Number of items per page

Methods: GET: Retrieve a paginated list of course suggestions for a platform POST: Create or update a course suggestion DELETE: Remove a course suggestion

Request Body (POST): A JSON object containing:

  • platform_key (str, required): The platform for the suggestion
  • course_id (str, required): The course ID to suggest
  • user_id (str/int, required): The user to suggest the course to
  • accepted (bool, optional): Whether the suggestion is accepted
  • visible (bool, optional): Whether the suggestion is visible
  • metadata (dict, optional): Additional suggestion metadata

Query Parameters (DELETE): suggestion_id (int, required): The ID of the suggestion to delete

Returns: GET: A paginated JSON response containing course suggestions: { "count": 10, "next": "https://example.com/api/catalog/suggestions/course/manage/?page=2", "previous": null, "results": [ { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming" }, ... ] }

POST: A JSON response containing the created/updated suggestion: { "id": 123, "user_id": 456, "username": "student1", "name": "Student Name", "platform_key": "platform1", "accepted": false, "visible": true, "created": "2023-06-15T14:30:00Z", "modified": "2023-06-15T14:30:00Z", "metadata": {}, "course_id": "course-v1:org+course+run", "course_name": "Introduction to Programming" }

DELETE: A success response with status 200

Error Responses: 400 Bad Request: If required parameters are missing or invalid, or if suggestion operations fail 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage suggestions 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can manage suggestions for their platform
  • Department admins can manage suggestions for their departments
  • DM admins can manage all suggestions
Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Filter suggestions by department admin access

pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter suggestions

sortstringnon-empty

Field to sort results by

Default "-id"
Body
required
platform_keystringrequired

The platform for the suggestion

course_idstringrequired

The course ID to suggest

user_idstringrequired

The user to suggest the course to

usernamestring

The username of the user to suggest the course to

emailstring(email)

The email of the user to suggest the course to

acceptedboolean

Whether the suggestion is accepted

Default false
visibleboolean

Whether the suggestion is visible

Default true
metadataobject

Additional suggestion metadata

suggested_bystring

The user who suggested the course

directboolean

Whether the suggestion is direct

Default true
department_modeboolean

Flag to ensure department admins can call the API

Default false
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/course/manage/?department_mode=true&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "course_id": "string",
    "user_id": "string",
    "username": "string",
    "email": "user@example.com",
    "accepted": false,
    "visible": true,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "suggested_by": "string",
    "direct": true,
    "department_mode": false
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the suggestion

user_idintegerrequired

The ID of the user receiving the suggestion

usernamestringrequired

The username of the user receiving the suggestion

namestringrequired

The full name of the user receiving the suggestion

platform_keystringrequired

The platform key associated with the suggestion

acceptedbooleanrequired

Whether the suggestion has been accepted by the user

visiblebooleanrequired

Whether the suggestion is visible to the user

createdstring(date-time)required

When the suggestion was created

modifiedstring(date-time)required

When the suggestion was last modified

metadataobjectrequired

Additional metadata for the suggestion

metadata.​property name*anyadditional property
course_idstringrequired

The course ID being suggested

course_namestringrequired

The name of the course being suggested

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "username": "string",
  "name": "string",
  "platform_key": "string",
  "accepted": true,
  "visible": true,
  "created": "2019-08-24T14:15:22Z",
  "modified": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "course_id": "string",
  "course_name": "string"
}

catalog_suggestions_course_manage_destroy

Request

Delete single suggestion

Security
PlatformApiKeyAuthentication
Query
department_modeboolean

Flag to ensure department admins can call the API

Default false
pageinteger

Page number for pagination

page_sizeinteger

Number of items per page

platform_keystringnon-emptyrequired

The platform to retrieve suggestions for

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search term to filter suggestions

sortstringnon-empty

Field to sort results by

Default "-id"
suggestion_idintegerrequired

The ID of the suggestion to delete

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/course/manage/?department_mode=false&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id&suggestion_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Success - suggestion deleted

catalog_suggestions_course_manage_bulk_create

Request

API View for bulk management of course suggestions.

This endpoint allows administrators to create multiple course suggestions at once.

Methods: POST: Create multiple course suggestions in bulk

Request Body: A JSON object containing:

  • platform_key (str, required): The platform for the suggestions
  • suggestion_data (list, required): List of suggestion objects, each containing:
    • course_id (str, required): The course ID to suggest
    • user_id (str/int, required): The user to suggest the course to
    • accepted (bool, optional): Whether the suggestion is accepted
    • visible (bool, optional): Whether the suggestion is visible
    • metadata (dict, optional): Additional suggestion metadata

Returns: POST: A JSON response containing the operation results: { "successes": 15, "error_codes": [] }

Error Responses: 400 Bad Request: If required parameters are missing or invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to manage suggestions 500 Internal Server Error: If an unexpected error occurs during bulk creation

Access Control:

  • Requires IsDMAdmin, IsPlatformAdmin, or IsDepartmentModeAdminInPlatform permission
  • Platform admins can create suggestions for their platform
  • Department admins can create suggestions for their departments
  • DM admins can create suggestions for any platform
Security
PlatformApiKeyAuthentication
Body
required
platform_keystringrequired

The platform for the suggestions

suggestion_dataArray of objectsrequired

List of suggestion data objects, each containing course_id, user_id, etc.

suggestion_data[].​property name*anyadditional property
department_modeboolean

Flag to ensure department admins can call the API

Default false
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/suggestions/course/manage/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "platform_key": "string",
    "suggestion_data": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "department_mode": false
  }'

Responses

Bodyapplication/json
successesintegerrequired

Number of successfully created suggestions

error_codesArray of stringsrequired

List of error codes for failed suggestions

Response
application/json
{
  "successes": 0,
  "error_codes": [
    "string"
  ]
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com