Skip to content
API Reference
/
catalog
/
catalog_invitations_program_redeem_create

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_invitations_program_bulk_create

Request

API View for bulk creation of program invitations.

This endpoint allows creating multiple program invitations at once.

Request Parameters: invitation_data (list, required): List of invitation data objects, each containing: program_key (str, required): The program to create an invitation for email (str, required): The email address to invite active (bool, optional): Whether the invitation is active metadata fields: Any additional parameters will be added as metadata platform_key (str, required for platform admins): The platform key for permission validation

Methods: POST: Create multiple program invitations

Returns: POST: A JSON response containing the creation results: { "successes": 5, "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 access this resource 500 Internal Server Error: If an unexpected error occurs during creation

Access Control:

  • Requires IsDMAdmin or IsPlatformAdmin permission
  • Available to platform administrators and DM admins
Security
PlatformApiKeyAuthentication
Body
required
invitation_dataArray of objects(ProgramInvitationCreate)required

List of invitation data objects

invitation_data[].​program_keystringrequired

The program to create an invitation for

invitation_data[].​emailstring(email)

The email address to invite

invitation_data[].​usernamestring

The username to invite

invitation_data[].​activeboolean

Whether the invitation is active

Default true
invitation_data[].​sourcestring

The source of the invitation

invitation_data[].​redirect_tostring(uri)

URL to redirect to after accepting the invitation

invitation_data[].​createdstring(date-time)

When the invitation was created

invitation_data[].​expiredstring(date-time)

When the invitation expires

invitation_data[].​metadataobject

Additional metadata for the invitation

platform_keystring

The platform key for permission validation

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/program/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "invitation_data": [
      {
        "program_key": "string",
        "email": "user@example.com",
        "username": "string",
        "active": true,
        "source": "string",
        "redirect_to": "http://example.com",
        "created": "2019-08-24T14:15:22Z",
        "expired": "2019-08-24T14:15:22Z",
        "metadata": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "platform_key": "string"
  }'

Responses

Bodyapplication/json
successesintegerrequired

Number of successfully created invitations

error_codesArray of stringsrequired

List of error codes for failed invitations

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

catalog_invitations_program_redeem_create

Request

API View for redeeming blank program invitations.

This endpoint allows redeeming a blank program invitation by associating it with a user.

Request Parameters: program_key (str, required): The program key for the invitation source (str, required): The source identifier for the invitation email (str, optional): The email to associate with the invitation username (str, optional): The username to associate with the invitation metadata fields: Any additional parameters will be added as metadata

Methods: POST: Redeem a blank program invitation

Returns: POST: A JSON response containing the redeemed invitation: { "id": 123, "user_id": 456, "username": "username", "email": "user@example.com", "created": "2023-06-15T14:30:00Z", "started": "2023-06-15T14:30:00Z", "source": "source", "redirect_to": "https://example.com", "expired": null, "active": true, "metadata": {}, "program_key": "org+program1" }

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 access this resource 404 Not Found: If no blank invitation is available 500 Internal Server Error: If an unexpected error occurs during redemption

Access Control:

  • Requires IsDMAdmin or IsPlatformAdminForProgram permission
  • Available to DM admins and platform admins for the specific program
Security
PlatformApiKeyAuthentication
Body
required
program_keystringrequired

The program key for the invitation

sourcestringrequired

The source identifier for the invitation

emailstring(email)

The email to associate with the invitation

usernamestring

The username to associate with the invitation

metadataobject

Additional metadata for the invitation

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/program/redeem/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_key": "string",
    "source": "string",
    "email": "user@example.com",
    "username": "string",
    "metadata": {
      "property1": null,
      "property2": null
    }
  }'

Responses

Bodyapplication/json
idintegerrequired

The unique identifier for the invitation

user_idinteger or nullrequired

The ID of the user associated with the invitation

usernamestring or nullrequired

The username of the user associated with the invitation

emailstring or null(email)required

The email address associated with the invitation

createdstring(date-time)required

When the invitation was created

startedstring or null(date-time)required

When the invitation was started

expiredstring or null(date-time)required

When the invitation expires

sourcestring or nullrequired

The source of the invitation

redirect_tostring or null(uri)required

URL to redirect to after accepting the invitation

activebooleanrequired

Whether the invitation is active

metadataobjectrequired

Additional metadata for the invitation

metadata.​property name*anyadditional property
program_keystringrequired

The program key associated with the invitation

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "username": "string",
  "email": "user@example.com",
  "created": "2019-08-24T14:15:22Z",
  "started": "2019-08-24T14:15:22Z",
  "expired": "2019-08-24T14:15:22Z",
  "source": "string",
  "redirect_to": "http://example.com",
  "active": true,
  "metadata": {
    "property1": null,
    "property2": null
  },
  "program_key": "string"
}

catalog_licenses_course_retrieve

Request

Retrieve a paginated list of course licenses

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

course_idstringnon-empty

Filter by course ID

external_idstringnon-empty

Filter by external identifier

keystringnon-empty

Alternative filter by platform key

namestringnon-empty

Filter by license name (exact match)

orgstringnon-empty

Alternative filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

platform_keystringnon-empty

The unique identifier for the platform

platform_orgstringnon-empty

The organization identifier for the platform

querystringnon-empty

Search license names (contains)

sortstringnon-empty

Field to sort results by

Default "-id"
sourcestringnon-empty

Filter by license source

verboseboolean

Include detailed assignment data in the response

Default false
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/licenses/course/?active=true&course_id=string&external_id=string&key=string&name=string&org=string&page=0&page_size=0&platform_key=string&platform_org=string&query=string&sort=-id&source=string&verbose=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Total number of results

next_pagestring or null(uri)required

URL for next page of results

previous_pagestring or null(uri)required

URL for previous page of results

resultsArray of objects(CourseLicenseDetail)required

List of course licenses

results[].​idintegerrequired

The unique identifier for the license

results[].​createdstring(date-time)required

When the license was created

results[].​startedstring(date-time)required

When the license becomes active

results[].​expiredstring or null(date-time)required

When the license expires

results[].​namestringrequired

The display name of the license

results[].​countintegerrequired

The number of seats purchased

results[].​activebooleanrequired

Whether the license is active

results[].​metadataobjectrequired

Additional license metadata

results[].​metadata.​property name*anyadditional property
results[].​sourcestringrequired

The source identifier for the license

results[].​external_idstring or nullrequired

External identifier for the license

results[].​platform_keystringrequired

The platform key associated with the license

results[].​course_idstringrequired

The course ID associated with the license

results[].​usage_countinteger

The number of seats purchased

Default 0
Response
application/json
{
  "count": 0,
  "next_page": "http://example.com",
  "previous_page": "http://example.com",
  "results": [
    { … }
  ]
}

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