Skip to content
API Reference
/
catalog
/
catalog_invitations_course_bulk_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_course_blank_create

Request

Create multiple blank course invitations

Security
PlatformApiKeyAuthentication
Body
required
course_idstringrequired

The course to create invitations for

sourcestringrequired

The source identifier for the invitations

countintegerrequired

The number of blank invitations to create

metadataobject

Additional metadata for the invitations

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/course/blank/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": "string",
    "source": "string",
    "count": 0,
    "metadata": {
      "property1": null,
      "property2": null
    }
  }'

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_course_bulk_create

Request

Create multiple course invitations

Security
PlatformApiKeyAuthentication
Body
required
invitation_dataArray of objects(CourseInvitationCreate)required

List of invitation data objects

invitation_data[].​course_idstringrequired

The course 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/course/bulk/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "invitation_data": [
      {
        "course_id": "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_course_redeem_create

Request

Redeem a blank course invitation

Security
PlatformApiKeyAuthentication
Body
required
course_idstringrequired

The course ID 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/course/redeem/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "course_id": "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 null

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)

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
course_idstringrequired

The course ID 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
  },
  "course_id": "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