Skip to content
API Reference
/
catalog
/
catalog_invitations_program_blank_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_destroy

Request

Remove a program invitation: TBD

Security
PlatformApiKeyAuthentication
Query
activeboolean

Filter by active status

emailstringnon-empty

Filter by user email

orgstringnon-empty

Filter by platform organization

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

program_keystringnon-empty

Filter by program key

sortstringnon-empty

Field to sort results by

Default "-id"
sourcestringnon-empty

Filter by invitation source

usernamestringnon-empty

Filter by username

verboseboolean

Whether to include verbose output

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/invitations/program/?active=true&email=string&org=string&page=0&page_size=0&program_key=string&sort=-id&source=string&username=string&verbose=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Invitation successfully deleted

catalog_invitations_program_blank_create

Request

API View for creating blank program invitations.

This endpoint allows creating multiple blank program invitations (without user association) that can be redeemed later.

Request Parameters: program_key (str, required): The program to create invitations for source (str, required): The source identifier for the invitations count (int, required): The number of blank invitations to create metadata fields: Any additional parameters will be added as metadata

Methods: POST: Create multiple blank program invitations

Returns: POST: A JSON response containing the creation results: { "successes": 10, "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 IsPlatformAdminForProgram permission
  • Available to DM admins and platform admins for the specific program
Security
PlatformApiKeyAuthentication
Body
required
program_keystringrequired

The program 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/program/blank/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_key": "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_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"
  ]
}

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