Skip to content
API Reference/
/
ai_mentor_orgs_users_supp...

ibl-data-manager (4.84.1-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_mentor_orgs_users_support_tickets_partial_update

Request

ViewSet for managing Human Support Tickets.

This ViewSet provides endpoints to retrieve, create, and update Human Support Tickets.

Permissions: Platform Admins:

  • Platform admins are able to update the ticket status, and view all tickets for the tenant.
  • Platform admins can only update the subject, description and status fields. Students:
  • Students are only able to view their own created tickets.
  • students can modify only the subject and description entries

Field Updates:

  • subject: Modifiable by both student and platform admin
  • description: Modifiable by only student.
  • status: Modifiable by only platform admin.
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this human support ticket.

orgstringrequired
user_idstringrequired
Body
subjectstring<= 255 characters
descriptionstring
statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "subject": "string",
    "description": "string",
    "status": "open"
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
usernamestringread-onlyrequired
emailstringread-onlyrequired
full_namestringread-onlyrequired
userinteger[ 0 .. 2147483647 ]read-onlyrequired

edX user ID

sessionstring(uuid)read-onlyrequired
subjectstring<= 255 charactersrequired
descriptionstringrequired
statusstring(HumanSupportTicketStatusEnum)
  • open - Open
  • in_progress - In Progress
  • closed - Closed
Enum"open""in_progress""closed"
mentor_idstringread-onlyrequired
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)read-onlyrequired
resolved_atstring or null(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "username": "string",
  "email": "string",
  "full_name": "string",
  "user": 2147483647,
  "session": "3f2c4c37-8bf1-47a5-bf05-0490dc5c033d",
  "subject": "string",
  "description": "string",
  "status": "open",
  "mentor_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "resolved_at": "2019-08-24T14:15:22Z"
}

ai_mentor_orgs_users_support_tickets_destroy

Request

ViewSet for managing Human Support Tickets.

This ViewSet provides endpoints to retrieve, create, and update Human Support Tickets.

Permissions: Platform Admins:

  • Platform admins are able to update the ticket status, and view all tickets for the tenant.
  • Platform admins can only update the subject, description and status fields. Students:
  • Students are only able to view their own created tickets.
  • students can modify only the subject and description entries

Field Updates:

  • subject: Modifiable by both student and platform admin
  • description: Modifiable by only student.
  • status: Modifiable by only platform admin.
Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this human support ticket.

orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_mentor_orgs_users_support_tickets_close_create

Request

Endpoint to close a Human support ticket.

This endpoint is used to close a Human support ticket.

Permissions: - available to both platform admins and the student who created the ticket.

Returns: Response: A response object containing the closed ticket data.

Security
PlatformApiKeyAuthentication
Path
idintegerrequired

A unique integer value identifying this human support ticket.

orgstringrequired
user_idstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-mentor/orgs/{org}/users/{user_id}/support-tickets/{id}/close/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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