Skip to content
API Reference
/
catalog
/
catalog_reviews_program_update_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_reviews_program_info_retrieve

Request

Retrieve aggregate review information for a program.

Security
PlatformApiKeyAuthentication
Query
program_keystringnon-emptyrequired

The program key to get review information for

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/program/info/?program_key=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
program_keystringrequired

The program key associated with the reviews

avg_ratingnumber or null(double)required

Average rating of the program

countintegerrequired

Total number of reviews for the program

Response
application/json
{
  "program_key": "string",
  "avg_rating": 0.1,
  "count": 0
}

catalog_reviews_program_update_create

Request

Create or update a program review

Security
PlatformApiKeyAuthentication
Body
required
program_keystringrequired

The program key to review (format: program-v1:org+program_id)

usernamestringrequired

The username of the reviewer

user_idinteger

The user ID of the reviewer (alternative to username)

ratingnumber or null(double)

The rating value (typically 1-5)

titlestring

The review title

contentstring

The review content/text

visibleboolean

Whether the review is visible

Default true
metadataany

Additional review metadata

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/program/update/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_key": "string",
    "username": "string",
    "user_id": 0,
    "rating": 0.1,
    "title": "string",
    "content": "string",
    "visible": true,
    "metadata": null
  }'

Responses

Bodyapplication/json
user_idintegerrequired

The user identifier

usernamestringrequired

The username of the reviewer

contentstringrequired

Review content/text

ratingnumber or null(double)required

Rating value (typically 1-5)

titlestringrequired

Review title

visiblebooleanrequired

Whether the review is visible

createdstring or nullrequired

Date when review was created

modifiedstring or nullrequired

Date when review was last modified

program_keystringrequired

The program key identifier

Response
application/json
{
  "user_id": 0,
  "username": "string",
  "content": "string",
  "rating": 0.1,
  "title": "string",
  "visible": true,
  "created": "string",
  "modified": "string",
  "program_key": "string"
}

catalog_reviews_program_update_destroy

Request

Delete a program review

Security
PlatformApiKeyAuthentication
Query
program_keystringnon-emptyrequired

The program key of the review to delete

user_idinteger

The user ID of the reviewer (alternative to username)

usernamestringnon-emptyrequired

The username of the reviewer

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/reviews/program/update/?program_key=string&user_id=0&username=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Review successfully deleted

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