{"info":{"_postman_id":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","name":"Rise Up","description":"

Rise Up delivers you a RESTful API, you can use any HTTP client in any programming language to interact with your account.

All routes must include the API version, for example:
/v3/users

🌍 API Environments

Preproduction:
https://preprod-customer-api.riseup.ai/

Production:
https://api.riseup.ai/

📤 Send Data

To create or update resources you need to set the Content-Type as application/json in the request header and send data in the body of the request in json format

In our API design, we exclusively utilize the HTTP verb PUT for updating resources and do not support the use of the PATCH verb. If you intend to modify an item, such as a User, the recommended approach is to employ the PUT route:

PUT /v3/users/{id}

This route serves as the designated method for updating resources, mirroring the functionality typically associated with PATCH routes in other systems. By adhering to this convention, you can seamlessly update specific resource attributes without the need for a dedicated PATCH verb, ensuring a straightforward and consistent API experience.

📦 Range

The API responds with a '206 Partial Content' HTTP status code when the number of items to be returned exceeds the default limit of 50. To manage this, it is imperative to integrate our pagination mechanism.

In every 206 response, the 'Content-range' header provides information about the range of returned items and the total count. For instance, it might appear as follows: content-range: 0-50/150, where 150 signifies the total number of items. Additionally, the 206 response includes a 'Link' header containing URLs for the first, next, and last pages.

To retrieve a specific page, specify the desired range as a query parameter, as outlined in the 'Link' header. For example:

{URL}/v3/users?range=20-30

Each page can accommodate a maximum of 50 objects. However, this limit is adjustable and can be extended up to 500 by utilizing the 'limit' filter on any endpoint:

{URL}/v3/users?limit=250

This allows you to tailor the response to your specific needs and efficiently navigate through the paginated content.

🎯 Filters on Int and String

Any field with type Int or String can be filtered using a body in the request :

{URL}/certificateuser?iduser=357
{URL}/certifications?state=validated

Using multiple values of INT data by separating them with a coma :

{URL}/certificateuser?iduser=357,224

filter for contains using String using * :

{URL}/trainings?title=``_apprendre_

⏰ Filters on Date

Any field with type Date can be filtered using a body in the request :

{URL}/sessions?startdate[gt]=2022-01-01
{URL}/users?startdate[lte]=2023-01-01

Accepted values for filtering are [gt], [gte], [lt], [lte].

⚙️ Quota

There is a maximum of 300 calls by minute, this limit cannot be extended.

If you do more than 300 calls minute, the API will return a 429 error : Too many requests.

The quota is calculated on one moving minute.

Please catch the error when calling our API in order to detect when you are over the quota.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49869254","collectionId":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","publishedId":"2sBXigNZSw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"363A71","highlight":"FFA168"},"publishDate":"2026-03-16T13:52:27.000Z"},"item":[{"name":"Generic API Errors","item":[{"name":"401 Unauthorized","id":"1731062d-7974-4677-925d-8b52f2f978fb","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.riseup.ai/v3/any-endpoint","description":"

Example of 401 Unauthorized error that can occur on any authenticated endpoint when the access token is invalid, expired, or missing.

Example of 403 Forbidden error that can occur when the authenticated user doesn't have sufficient permissions to access the resource.

Example of 404 Not Found error that can occur when trying to access a resource that doesn't exist.

Example of 500 Internal Server Error that can occur due to unexpected server-side issues.

Example of 400 Bad Request error that occurs when request data fails validation. This includes field-specific errors such as:

Invalid email format
Field too short/long
Missing required fields
Invalid URL format
Invalid field values
Fields containing unauthorized content (e.g., script tags)

The error_description will specify which field(s) failed validation and why.

Example of 400 Bad Request errors caused by business logic violations. These occur when the request is valid but violates business rules:

User already registered for a session
Resource already exists (duplicates)
Invalid date ranges (e.g., startdate after enddate)
Referenced entity doesn't exist (e.g., invalid language code)
Action not allowed for specific entity combinations
Missing dependencies (e.g., missing authentication when required)

The error_description will explain which business rule was violated.

Example of 429 Too Many Requests error that occurs when rate limits are exceeded.

Rate Limits:

The API enforces rate limits to ensure fair usage and system stability
When exceeded, the API returns a 429 status code
The response includes Retry-After header indicating when to retry

Best Practices:

Implement exponential backoff when receiving 429 responses
Respect the Retry-After header value
Monitor your request rates to stay within limits
Consider caching responses when appropriate

Generic API Errors - Reference Guide

This folder contains common error patterns and examples that occur across the Rise Up API.

📘 Purpose

These are REFERENCE EXAMPLES showing typical error formats and patterns. They help you understand:

Standard HTTP error responses (401, 403, 404, 500, 429)
Common validation error patterns (invalid email, invalid URL, missing files)
Common business logic error patterns (invalid language, duplicate entries)

⚠️ Important Note

For complete endpoint-specific error documentation, please refer to the individual resource folders (Users, Courses, Webhooks, etc.).

Each resource folder contains:

All errors specific to that resource's endpoints
Real request/response examples
Field-specific validation errors
Business logic errors unique to that resource

🎯 How to Use This Folder

Learning: Review error patterns to understand API error structure
Reference: See examples of common error types
Specific errors: Check individual resource folders for complete documentation

Error Pattern Categories:

Authentication & Authorization Errors (401, 403)
Not Found Errors (404)
Server Errors (500)
Rate Limiting (429)
Validation Patterns:
- File upload (file mandatory, invalid type)
- Field validation (doesn't exist, must be array, invalid type, cannot be empty)
\n
Business Logic Patterns:
- Invalid language
- Reference already exists
- Entity doesn't exist (foreign key validation)
\n

\n","_postman_id":"59b9b99a-9c95-413d-83c1-a9a6ffa5ab5a","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"grant_type","value":""},{"key":"headerPrefix","value":""},{"key":"password","value":"{{clientSecret}}"},{"key":"username","value":"{{clientId}}"},{"key":"scope","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""}]},"isInherited":true,"source":{"_postman_id":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","id":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","name":"Rise Up","type":"collection"}}},{"name":"Authentication","item":[{"name":"OAuth 2.0 - Get Access Token","id":"c7191e5a-f26a-4abf-a84d-979032f07fa6","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{base64_credentials}}","description":"

Authorization method 'Basic' followed by your public_key and private_key in your settings > developer > API combined into a string 'public_key:private_key' and encoded using Base64

\n","type":"text"},{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"

OAuth 2.0 grant type - must be 'client_credentials'

\n"}]},"url":"https://api.riseup.ai/oauth/token","description":"

Authentication is required before any other API call.

This endpoint implements OAuth 2.0 Client Credentials flow to obtain an access token.

How to authenticate:

Get your API credentials from your Rise Up settings > developer > API
\n
Combine credentials into format: public_key:private_key
\n
Encode with Base64 and use in Authorization header as Basic {base64_encoded_credentials}
\n
Send POST request with grant_type=client_credentials
\n
Use the returned access_token in subsequent API calls as Bearer {access_token}
\n

Example with curl:

curl -X POST https://api.riseup.ai/oauth/token \\\n  -H \"Authorization: Basic YourEncodedAuthorizationHere\" \\\n  -H \"Content-Type: application/x-www-form-urlencoded\" \\\n  -d \"grant_type=client_credentials\"\n\n

Note: The access token expires after a certain period and you'll need to request a new one when you receive 401 Unauthorized responses.

Retrieve all certificates from the system.

Query Parameters

You can filter certificates using the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
`name`	String	Filter by certificate name (supports wildcards `*`)	`?name=Professional`
`owner`	String	Filter by certificate owner (supports wildcards `*`)	`?owner=University`
`ownerstatus`	String	Filter by owner status (supports wildcards `*`)	`?ownerstatus=Director`
`duration`	Integer	Filter by duration in minutes	`?duration=120`
`level`	Integer	Filter by certificate level	`?level=3`
`description`	String	Filter by description (supports wildcards `*`)	`?description=advanced`
`creationdate`	Date	Filter by creation date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?creationdate[gte]=2025-01-01`
`modificationdate`	Date	Filter by modification date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?modificationdate[lte]=2025-12-31`

Combined Filter Example

GET /v3/certificates?level=3&name=*Professional*&creationdate[gte]=2025-01-01\n

For details on common query parameters like range, limit, and sort, see the collection-level documentation.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Fetch a specific certificate by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Delete a certificates by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Retrieve all CertificateUsers from the system.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve all certifications from the system.

Query Parameters

You can filter certifications using the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
`name`	String	Filter by certification name (supports wildcards `*`)	`?name=Professional`
`img`	String	Filter by image URL (supports wildcards `*`)	`?img=logo.png`
`creationdate`	Date	Filter by creation date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?creationdate[gte]=2025-01-01`
`modificationdate`	Date	Filter by modification date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?modificationdate[lte]=2025-12-31`

Combined Filter Example

GET /v3/certifications?name=*Professional*&creationdate[gte]=2025-01-01\n

For details on common query parameters like range, limit, and sort, see the collection-level documentation.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve all classroom sessions from the system.

Query Parameters

In addition to the common parameters (range, limit, sort) documented in the collection-level description, this endpoint supports filtering by any field with type String or Int:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
`state`	String	Filter by session state (`pending`, `validated`, `cancelled`)	`?state=validated`
`session_type`	String	Filter by session type (`virtual`, `face-to-face`)	`?session_type=face-to-face`
`idmodule`	Integer	Filter by module ID	`?idmodule=81583`
`idtraining`	Integer	Filter by training/course ID	`?idtraining=46`
`location`	String	Filter by location (exact match or wildcard)	`?location=Paris`
`language`	String	Filter by language code	`?language=fr-FR`
`reference`	String	Filter by session reference	`?reference=S1234`
`startdate`	Date	Filter by start date (supports date operators)	`?startdate[gte]=2024-01-01`
`enddate`	Date	Filter by end date (supports date operators)	`?enddate[lte]=2024-12-31`
`mycustomfields*`	String	Filter by custom field values	`?mycustomfields1=value`

Combining Filters:
Multiple filters can be combined:
/v3/classroomsessions?state=validated&session_type=face-to-face&idtraining=46

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve a specific classroom session by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Create a new classroom session in the system.

Request Body Parameters

Parameter	Type	Required	Description
`idmodule`	Integer	Required	ID of the module
`startdate`	Date	Required	Start date of the session (YYYY-MM-DD HH:MM:SS)
`enddate`	Date	Required	End date of the session (YYYY-MM-DD HH:MM:SS)
`seats`	Integer	Required	Seats available for the session
`eduduration`	Integer	Required	Educational duration in minutes
`language`	String	Optional	Language of the session ('fr-FR', 'en-US', 'es-ES', etc.)
`location`	String	Optional	Location of the session
`description`	String	Optional	Description of the session
`meetingurl`	String	Optional	URL of the virtual classroom
`state`	String	Optional	State of the session: `pending`, `validated`, `cancelled`
`session_type`	String	Optional	Type of the session: `virtual`, `face-to-face`
`createzoomlink`	Boolean	Optional	Generate a zoom link
`room`	String	Optional	Room of the session
`reference`	String	Optional	Reference of the session
`facilitators`	Array	Optional	Array of user IDs of the facilitators
`mycustomfields1`	String	Optional	Custom field 1

Error Responses

Endpoint-Specific Errors:\nSee response examples below for errors specific to this endpoint (e.g., invalid module ID).

Generic Errors:\nFor common errors (401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests, 500 Internal Server Error), see the 'Generic API Errors' folder.

Update an existing classroom session by its ID. No mails are sent using this call.

Request Body Parameters

Parameter	Type	Required	Description
`startdate`	Date	No	Start date of the session (YYYY-MM-DD HH:MM:SS)
`enddate`	Date	No	End date of the session (YYYY-MM-DD HH:MM:SS)
`seats`	Integer	No	Seats available for the session
`eduduration`	Integer	No	Educational duration in minutes
`language`	String	No	Language of the session ('fr-FR', 'en-US', 'es-ES', etc.)
`location`	String	No	Location of the session
`description`	String	No	Description of the session
`meetingurl`	String	No	URL of the virtual classroom
`state`	String	No	State of the session: `pending`, `validated`, `cancelled`
`session_type`	String	No	Type of the session: `virtual`, `face-to-face`
`createzoomlink`	Boolean	No	Generate a zoom link
`room`	String	No	Room of the session
`reference`	String	No	Reference of the session
`facilitators`	Array	No	Array of user IDs of the facilitators
`mycustomfields1`	String	No	Custom field 1

Note: The idmodule field cannot be changed via PUT. It is only set during POST.

Error Responses

Endpoint-Specific Errors:\nSee response examples below for errors specific to this endpoint (e.g., session not found).

Generic Errors:\nFor common errors (401 Unauthorized, 403 Forbidden, 429 Too Many Requests, 500 Internal Server Error), see the 'Generic API Errors' folder.

Delete a classroom session by its ID. No mails are sent using this call.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Retrieve all classroom session registrations from the system.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve a specific classroom session registration by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Create a new classroom session registration in the system.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`iduser`	Integer	Required	ID of the user
`idsession`	Integer	Required	ID of the classroom session
`attended`	String	Optional	User attendance
`eduduration`	Integer	Optional	Attendance duration of the user (in minutes)
`sendemail`	Boolean	Optional	Send the classroom session registration email
`reference`	String	Optional	Reference of the classroom session registration

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve signatures for a specific classroom session registration.\\n\\nNote: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Update an existing classroom session registration by its ID.\\n\\n### Request Body Parameters\\n\\n| Parameter | Type | Required | Description |\\n|-----------|------|----------|-------------|\\n| attended | String | Optional | User attendance |\\n| eduduration | Integer | Optional | Attendance duration of the user (in minutes) |\\n| sendemail | Boolean | Optional | Send the attendance validation email if \"attended\" is True |\\n| state | String | Optional | State of the classroom session registration (Can only be \"cancelled\") |\\n| reference | String | Optional | Reference of the classroom session registration |\\n\\nNote: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Delete a classroom session registration by its ID. A mail is sent when using this API call.\\n\\nNote: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Fetch my company information.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Retrieve all courseperiods from the system.

Query Parameters

This endpoint supports filtering on course period fields. You can filter course periods by any field returned in the response using query parameters.

Example Filters

GET /v3/courseperiods?idtraining=123\nGET /v3/courseperiods?startdate[gte]=2025-03-01\nGET /v3/courseperiods?enddate[lte]=2025-12-31\n

Note: Date fields support comparison operators: [gt] (greater than), [gte] (greater than or equal), [lt] (less than), [lte] (less than or equal).

For details on common query parameters like range, limit, and sort, see the collection-level documentation.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve a specific courseperiods by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Create a new course period in the system.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
idtraining	Integer	Yes	ID of the course
startdate	Date	Yes	Start date of the course period
enddate	Date	Yes	End date of the course period
state	String	No	State of the course period: `active` or `suspend`

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Update an existing course period by its ID.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
startdate	Date	No	Start date of the course period
enddate	Date	No	End date of the course period
state	String	No	State of the course period: `active` or `suspend`

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Retrieve all courses from the system.

Query Parameters

In addition to the common parameters (range, limit, sort) documented in the collection-level description, this endpoint supports filtering by any field with type String or Int:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description	Example
`title`	String	Filter by course title (exact match or wildcard)	`?title=JavaScript`
`state`	String	Filter by course state (`draft`, `validated`)	`?state=validated`
`language`	String	Filter by language code	`?language=en-US`
`type`	String	Filter by type (`internal`, `partner`)	`?type=internal`
`reference`	String	Filter by course reference	`?reference=COURSE123`
`iduser`	Integer	Filter by creator user ID	`?iduser=202`
`idpartner`	Integer	Filter by partner ID	`?idpartner=10`
`visible`	Boolean	Filter by visibility status	`?visible=true`
`mycustomfields*`	String	Filter by custom field values	`?mycustomfields1=value`

Combining Filters:
Multiple filters can be combined:
/v3/courses?state=validated&visible=true&language=en-US

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

My registration message

\",\n \"externallink\": null,\n \"legaldocs\": true,\n \"registration\": true,\n \"nointernalvalidation\": true,\n \"minisite\": true,\n \"forumcategory\": true,\n \"onlysuccessquiz\": true,\n \"creationdate\": \"2014-11-14 14:35:54\",\n \"modificationdate\": \"2015-03-17 13:48:22\",\n \"creators\": [202, 203, 204],\n \"perimeters\": [\n {\n \"partner\": 3\n },\n {\n \"internal\": true\n }\n ],\n \"trainingtype\": \"E-learning\",\n \"categories\": [4, 5, 6],\n \"skills\": [1, 2, 3],\n \"keywords\": [\"K1\", \"k1\", \"M1\"],\n \"visibilityexception\": { \"users\": [14, 17], \"groups\": [1, 5] }\n }\n]"}],"_postman_id":"54a8233c-01e5-40d2-9aae-f65abab146f1"},{"name":"Get course by ID","id":"4cdbd27b-f42c-43e2-8765-0039674c3aae","request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://api.riseup.ai/v3/courses/:id","description":"

Retrieve a specific course by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Create a new course in the system.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Yes	Title of the course
type	String	Yes	Type of the course: `internal` or `partner`
language	String	Yes	Language of the course (e.g., `fr-FR`, `en-US`, `es-ES`)
iduser	Integer	Yes	ID of the creator
eduduration	Integer	Yes	Educational duration of the course in minutes
state	String	No	State of the course: `draft` or `validated`
description	String	No	Description of the course
objective	String	No	Objective of the course
reference	String	No	Reference of the course
idpartner	Integer	No	ID of the partner (required if type is `partner`)
orgname	String	No	Name of the course organisation
orgformacode	String	No	Formacode of the course organisation
orgevalmodality	String	No	Evaluation modality of the course organisation
orgnature	String	No	Nature of the course organisation: `none`, `courseaction`, `skills`, `validation`, or `apprenticeship`
sequential	Boolean	No	Whether the course is sequential
visible	Boolean	No	Whether the course is visible on catalog for learners
selfunsubscribe	Boolean	No	Allow users to unregister
isrecommended	Boolean	No	Display the course as recommended in the catalogue
authorizeskillassessment	Boolean	No	Authorize skill assessment on the course
legaldocs	Boolean	No	Send legal documents
registration	Boolean	No	Allow registrations to the course
nointernalvalidation	Boolean	No	Requires an internal validation
minisite	Boolean	No	Generate a public link to access the course
catalogname	String	No	External catalog name
catalogexternal	Boolean	No	Mark course as external (prevents content edition on webplatform)
externalcontenturl	String	No	URL to redirect learners if catalogexternal is true
forumcategory	Boolean	No	Create a board on the community page
onlysuccessquiz	Boolean	No	Users must successfully finish quiz to complete the course
creators	Array of Integers	No	ID of the creator users
skills	Array of Integers	No	ID of the skills
scopes	Array of Integers	No	ID of the partners
registrationpersonalizedmessage	String	No	Message sent in registration mail
externallink	String	No	URL used in the Catalog details page
mycustomfields1	String	No	First custom field
categories	Array of Integers	No	ID of the course categories
keywords	Array of Strings	No	Names of the keywords
visibilityexception	Object	No	List of groups and users for whom 'Visible' field does not apply
periods	Array of Objects	No	List of the course periods

Error Responses

Endpoint-Specific Errors:\nSee response examples below for errors specific to this endpoint (e.g., invalid language, invalid link format, script tags not allowed).

Generic Errors:\nFor common errors (401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests, 500 Internal Server Error), see the 'Generic API Errors' folder.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":""},{"key":"accessTokenUrl","value":""},{"key":"clientSecret","value":""},{"key":"clientId","value":""},{"key":"client_authentication","value":""},{"key":"grant_type","value":""},{"key":"headerPrefix","value":""},{"key":"password","value":"{{clientSecret}}"},{"key":"username","value":"{{clientId}}"},{"key":"scope","value":""},{"key":"tokenName","value":""},{"key":"challengeAlgorithm","value":""}]},"isInherited":true,"source":{"_postman_id":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","id":"cc9a5879-c837-467b-9fbe-abe49ea39cb3","name":"Rise Up","type":"collection"}},"urlObject":{"path":["v3","courses"],"host":["https://api.riseup.ai"],"query":[],"variable":[]}},"response":[{"id":"d46f4e68-4dc4-4fdc-9610-0237044032a5","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"description\": \"Description\",\n \"objective\": \"Objective\",\n \"reference\": \"1234DFTEZ\",\n \"eduduration\": 20,\n \"sequential\": false,\n \"visible\": true,\n \"creators\": [202, 203, 204],\n \"skills\": [1, 2, 3],\n \"categories\": [1, 2, 3],\n \"scopes\": [1, 2, 3],\n \"keywords\": [\"K1\", \"k1\", \"M1\"],\n \"mycustomfields1\": \"value\",\n \"visibilityexception\": { \"users\": [14, 17], \"groups\": [1, 5] }\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 18909,\n \"title\": \"Title\",\n \"description\": \"Description\",\n \"objective\": \"Objective\",\n \"reference\": \"1234DFTEZ\",\n \"language\": \"fr-FR\",\n \"eduduration\": 20,\n \"price\": \"0.00\",\n \"state\": \"draft\",\n \"type\": \"internal\",\n \"idpartner\": null,\n \"img\": null,\n \"video\": null,\n \"sequential\": false,\n \"visible\": false,\n \"selfunsubscribe\": true,\n \"isrecommended\": true,\n \"legaldocs\": true,\n \"authorizeskillassessment\": false,\n \"registration\": true,\n \"nointernalvalidation\": true,\n \"minisite\": true,\n \"forumcategory\": true,\n \"onlysuccessquiz\": true,\n \"creationdate\": \"2019-06-21 16:26:08\",\n \"modificationdate\": null,\n \"creators\": [202, 203, 204],\n \"trainingtype\": \"Face-to-face\",\n \"registrationpersonalizedmessage\": null,\n \"externallink\": \"https://example.com/MyExternalLinkExample\",\n \"skills\": [1, 2, 3],\n \"categories\": [1, 2, 3],\n \"scopes\": [1, 2, 3],\n \"keywords\": [\"K1\", \"k1\", \"M1\"],\n \"mycustomfields1\": \"value\",\n \"visibilityexception\": { \"users\": [14, 17], \"groups\": [1, 5] }\n}"},{"id":"6f132ae9-57f2-4966-a026-7057a77349f3","name":"400 Bad Request - Script Tags Not Allowed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"registrationpersonalizedmessage\": \"\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Field 'registrationpersonalizedmessage' must not contain 'script' tags\"\n}"},{"id":"fda2b748-ccb3-404a-b61f-7456e97c409d","name":"400 Bad Request - Invalid Link Format","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"externallink\": \"not-a-valid-url\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Field 'externallink' must be a link format\"\n}"},{"id":"cedb8846-7f60-4e39-8ceb-9f4dadcd2de9","name":"400 Bad Request - Invalid Language","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"xx-YY\",\n \"iduser\": 202\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Language 'xx-YY' doesn't exist\"\n}"},{"id":"2f6a947e-bcd1-4c8d-a3d4-92b44de0a984","name":"400 Bad Request - Invalid User ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 999999\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_request\",\n \"error_description\": \"Id user '999999' doesn't exist\"\n}"},{"id":"c137a433-6c3f-4ec2-b6b8-0024637a3833","name":"400 Bad Request - Partner Course Missing Partner ID","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"partner\",\n \"language\": \"fr-FR\",\n \"iduser\": 202\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Training of type partner must be provided with an idpartner\\\"\\n}"},{"id":"69a256cb-386c-4ba8-acba-014f9595a042","name":"400 Bad Request - Course Must Be Active to Be Visible","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"state\": \"draft\",\n \"visible\": true\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Course needs to be active to be visible.\\\"\\n}"},{"id":"d9330612-5be7-49e6-818f-a0855cfe4dd0","name":"400 Bad Request - External URL Requires Catalog Name","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"externalurl\": \"https://example.com\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Cannot set external URL without a catalogname\\\"\\n}"},{"id":"19ca099d-f7f7-4bf9-9c03-4847acc6b865","name":"400 Bad Request - Invalid Skill IDs","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"skills\": [1, 99999]\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"One or many skills ids does not exist\\\"\\n}"},{"id":"8f7bf1b2-768b-4e01-81dc-2e869ecf0732","name":"400 Bad Request - Invalid Scope IDs","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"scopes\": [1, 99999]\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"One or many scopes ids does not exist\\\"\\n}"},{"id":"8d833563-b860-4abb-b108-7c8671c3dc8c","name":"400 Bad Request - Invalid Category IDs","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"categories\": [1, 99999]\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"One or many categories ids does not exist\\\"\\n}"},{"id":"e26a0e3e-53a9-46c0-a126-f98968ce4bf2","name":"400 Bad Request - Scopes Must Be Integers","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"scopes\": [1, \"not-an-integer\"]\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Scopes must contains only integer values\\\"\\n}"},{"id":"adced0c5-2f6d-44d7-8b41-7c58713903d7","name":"400 Bad Request - Invalid Course Period Dates","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"periods\": [{\"startdate\": \"2024-12-31 00:00:00\", \"enddate\": \"2024-01-01 00:00:00\"}]\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Course period startdate must be before course period enddate.\\\"\\n}"},{"id":"1b948292-0628-4f11-bd89-948d3ea7da5c","name":"400 Bad Request - Creators Must Be Array","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"creators\": \"not-an-array\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"Creators field should be a list\\\"\\n}"},{"id":"acf0e72e-fccf-4a80-9ecc-eb514743264f","name":"400 Bad Request - Skills Must Be Array","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"skills\": \"not-an-array\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"skills must be an array\\\"\\n}"},{"id":"fca4026f-86b5-485d-bad3-0c10acce9889","name":"400 Bad Request - Scopes Must Be Array","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"scopes\": \"not-an-array\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"scopes must be an array\\\"\\n}"},{"id":"429cfebc-8df7-4a35-baea-e131d82eefc0","name":"400 Bad Request - Categories Must Be Array","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"categories\": \"not-an-array\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"categories must be an array\\\"\\n}"},{"id":"77ebdcd1-8ecd-44f7-bc24-fb08a1b52dd3","name":"400 Bad Request - Keywords Must Be Array","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"keywords\": \"not-an-array\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"keywords must be an array\\\"\\n}"},{"id":"574ed3ba-6f4e-4eb4-afef-b0950be81d97","name":"400 Bad Request - Field Must Be Boolean","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"visible\": \"not-a-boolean\"\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"visible must be of type boolean\\\"\\n}"},{"id":"67dd0d92-4a1c-41c4-b144-19e0ff643251","name":"400 Bad Request - Skills Cannot Be Empty","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"skills\": []\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"skills must not be an empty array\\\"\\n}"},{"id":"8cdbe482-7ba5-4bdb-8c70-065f7da34a59","name":"400 Bad Request - Scopes Cannot Be Empty","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"scopes\": []\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"scopes must not be an empty array\\\"\\n}"},{"id":"6620a8cf-efbe-40fe-aede-f1df510a2160","name":"400 Bad Request - Categories Cannot Be Empty","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"categories\": []\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"categories must not be an empty array\\\"\\n}"},{"id":"793e514c-3364-4446-97c0-5af35512eb83","name":"400 Bad Request - Keywords Cannot Be Empty","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Title\",\n \"type\": \"internal\",\n \"language\": \"fr-FR\",\n \"iduser\": 202,\n \"keywords\": []\n}"},"url":"https://api.riseup.ai/v3/courses"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\\n \\\"error\\\": \\\"invalid_request\\\",\\n \\\"error_description\\\": \\\"keywords must not be an empty array\\\"\\n}"}],"_postman_id":"834e66d0-cace-4158-a888-9a54a81bcb18"},{"name":"Upload course image","id":"9b3ee744-3aaf-4974-86ad-6a6abf6130a7","request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://api.riseup.ai/v3/courses/image/:id","description":"

Upload an image file for a course.

File Upload Validation Errors:

400 Bad Request: File is mandatory
400 Bad Request: Invalid file type
400 Bad Request: Invalid file size

See the Generic API Errors folder for detailed file upload error examples.

Common Errors: For authentication and server errors (401, 403, 404, 500), see the 'Generic API Errors' folder.

Upload a banner image file for a course.

File Upload Validation Errors:

400 Bad Request: File is mandatory
400 Bad Request: Invalid file type
400 Bad Request: Invalid file size

See the Generic API Errors folder for detailed file upload error examples.

Common Errors: For authentication and server errors (401, 403, 404, 500), see the 'Generic API Errors' folder.

Upload a video file for a course.

File Upload Validation Errors:

400 Bad Request: File is mandatory
400 Bad Request: Invalid file type
400 Bad Request: Invalid file size

See the Generic API Errors folder for detailed file upload error examples.

Common Errors: For authentication and server errors (401, 403, 404, 500), see the 'Generic API Errors' folder.

Update an existing course by its ID. This API Call checks the state when trying to set a course to draft.

Request Body Parameters

Parameter	Type	Required	Description
title	String	No	Title of the course
description	String	No	Description of the course
objective	String	No	Objective of the course
reference	String	No	Reference of the course
eduduration	Integer	No	Educational duration of the course in minutes
state	String	No	State of the course: `draft` or `validated`
price	Float	No	Price of the course
orgname	String	No	Name of the course organisation
orgformacode	String	No	Formacode of the course organisation
orgevalmodality	String	No	Evaluation modality of the course organisation
orgnature	String	No	Nature of the course organisation: `none`, `courseaction`, `skills`, `validation`, or `apprenticeship`
sequential	Boolean	No	Whether the course is sequential
visible	Boolean	No	Whether the course is visible on catalog for learners
selfunsubscribe	Boolean	No	Allow users to unregister
isrecommended	Boolean	No	Display the course as recommended in the catalogue
authorizeskillassessment	Boolean	No	Authorize skill assessment on the course
legaldocs	Boolean	No	Send legal documents
registration	Boolean	No	Allow registrations to the course
nointernalvalidation	Boolean	No	Requires an internal validation
minisite	Boolean	No	Generate a public link to access the course
catalogname	String	No	External catalog name
catalogexternal	Boolean	No	Mark course as external (prevents content edition on webplatform)
externalcontenturl	String	No	URL to redirect learners if catalogexternal is true
forumcategory	Boolean	No	Create a board on the community page
onlysuccessquiz	Boolean	No	Users must successfully finish quiz to complete the course
creators	Array of Integers	No	ID of the creator users
skills	Array of Integers	No	ID of the skills
scopes	Array of Integers	No	ID of the partners
registrationpersonalizedmessage	String	No	Message sent in registration mail
externallink	String	No	URL used in the Catalog details page
mycustomfields1	String	No	First custom field
categories	Array of Integers	No	ID of the course categories
keywords	Array of Strings	No	Names of the keywords
visibilityexception	Object	No	List of groups and users for whom 'Visible' field does not apply
periods	Array of Objects	No	List of the course periods

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Delete a course by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Retrieve all course registrations from the system.

Note: For common error responses (401, 403, 500), see the 'Generic API Errors' folder.

Retrieve a specific course registration by its ID.

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

Create a new course registration in the system.

Request Body Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
iduser	Integer	Yes	ID of the user
idtraining	Integer	Yes	ID of the course
sendemail	Boolean	No	Send the welcome email
reference	String	No	Reference of the registration
idcourseperiod	Integer	No	ID of the course period

Error Responses

Endpoint-Specific Errors:\nSee response examples below for errors specific to this endpoint (e.g., registration already exists, invalid user/course ID).

Generic Errors:\nFor common errors (401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests, 500 Internal Server Error), see the 'Generic API Errors' folder.

Update an existing course registration by its ID.

Request Body Parameters

Parameter	Type	Required	Description	Possible Values
`state`	String	Optional	State of the registration	`validated`, `pending`, `archived`, `cancelled`, `refused`
`forcefinished`	Boolean	Optional	Set force finish to True or False
`totaltime`	Integer	Optional	Total time user did on course
`sendemail`	Boolean	Optional	Send email to the target user
`generatedocument`	Boolean	Optional	Generate certificate of course completion if course progress equal to 100 and not force finished
`reference`	String	Optional	Reference of the registration
`mycustomfields1`	String	Optional	Custom field
`idcourseperiod`	Integer	Optional	ID of the course period

Note: For common error responses (401, 403, 404, 500), see the 'Generic API Errors' folder.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":""}],"advancedConfig":[{"key":"tokenType","value":"

Parameter	Type	Description	Example
`username`	String	Filter by username (exact match or wildcard)	`?username=johndoe` or `?username=john`
`firstname`	String	Filter by first name (exact match or wildcard)	`?firstname=John` or `?firstname=Jo`
`lastname`	String	Filter by last name (exact match or wildcard)	`?lastname=Doe` or `?lastname=Do`
`email`	String	Filter by email address (exact match or wildcard)	`?email=john@example.com`
`phonenumber`	String	Filter by phone number	`?phonenumber=0102030405`
`rhid`	String	Filter by HR ID	`?rhid=EMP12345`
`state`	String	Filter by user state (`active`, `suspend`, `pending`)	`?state=active`
`lastlogindate`	Date	Filter by last login date (supports date operators)	`?lastlogindate[gte]=2024-01-01`
`idgroup`	Integer	Filter users by group ID	`?idgroup=99`
`mycustomfield*`	String/Integer	Filter by custom field values	`?mycustomfields1=Paris`

Parameter	Type	Description	Example
`title`	String	Filter by webhook title/name (supports wildcards `*`)	`?title=user`
`activated`	Boolean	Filter by activation status (true or false)	`?activated=true`
`entity`	String	Filter by entity type (e.g., 'user', 'course')	`?entity=user`
`url`	String	Filter by webhook URL (supports wildcards `*`)	`?url=example.com`
`basicauth`	Boolean	Filter by basic auth requirement (true or false)	`?basicauth=true`
`hmacsignature`	Boolean	Filter by HMAC signature presence (true or false)	`?hmacsignature=true`

Parameter	Type	Required	Description
name	String	Yes	Name of the custom field
type	String	Yes	Type of the custom field: `text`, `text_dropdown`, `number`, `date`, `boolean`, `url`
linked_entities	Array	Yes	Entities the custom field is linked to (e.g., `['training', 'user', 'usergroup']`)
values	Array	No	Predefined values for dropdown types
options	Array	No	Options for the custom field (e.g., `['required']`)

Parameter	Type	Required	Description
name	String	No	Name of the custom field
options	Array	No	Options for the custom field (e.g., `['required']`)
values	Array	No	Predefined values for dropdown types

Parameter	Type	Description	Example
`iduser`	Integer	Filter groups by user membership (returns groups containing this user)	`?iduser=5`
`admin`	Boolean	When combined with `iduser`, filter for groups where user is admin	`?iduser=5&admin=true`
`name`	String	Filter by group name (exact match or wildcard)	`?name=Engineering`
`reference`	String	Filter by group reference	`?reference=GRP123`
`hidden`	Boolean	Filter by visibility status	`?hidden=false`
`community`	Boolean	Filter groups with community board	`?community=true`
`idpartner`	Integer	Filter by partner ID	`?idpartner=10`
`mycustomfields*`	String	Filter by custom field values	`?mycustomfields1=value`

Parameter	Type	Required	Description
name	String	No	Name of the group
managercanmanagetrainings	String	No	Manager can manage trainings: `every`, `specific`, or `none`
reference	String	No	Reference of the group
mycustomfields1	String	No	Custom field
hidden	Boolean	No	Whether the group is hidden
community	Boolean	No	Group has a board on the community page

Parameter	Type	Description	Example
`title`	String	Filter by learning path title (supports wildcards `*`)	`?title=Onboarding`
`description`	String	Filter by learning path description (supports wildcards `*`)	`?description=beginner`
`pathref`	String	Filter by path reference	`?pathref=LP-001`
`forumcategory`	Boolean	Filter by forum category status (1 or 0)	`?forumcategory=1`
`sequential`	Boolean	Filter by sequential status (1 or 0)	`?sequential=1`
`creationdate`	Date	Filter by creation date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?creationdate[gte]=2025-01-01`
`modificationdate`	Date	Filter by modification date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?modificationdate[lte]=2025-12-31`

Parameter	Type	Required	Description
title	String	No	Title of the learning path
sequential	Boolean	No	If learning path is sequential or not (1 or 0)
description	String	No	Description of the learning path
trainings	Array of Objects	No	List all courses of the learning path
pathref	String	No	Reference of the path
forumcategory	Boolean	No	Create a board on the community page

Parameter	Type	Required	Description
idpath	Integer	Yes	ID of the learning path
iduser	Integer	Yes	ID of the user registered to the path
reference	String	No	Reference of the registration

Parameter	Type	Description	Example
`idtraining`	Integer	Filter by training ID	`?idtraining=123`
`title`	String	Filter by module title (supports wildcards `*`)	`?title=Introduction`
`description`	String	Filter by module description (supports wildcards `*`)	`?description=beginner`
`location`	String	Filter by module location	`?location=Paris`
`duration`	Integer	Filter by duration in minutes	`?duration=60`
`reference`	String	Filter by module reference	`?reference=MOD-001`
`type`	String	Filter by module type ('online' or 'physical')	`?type=online`
`seats`	Integer	Filter by number of seats	`?seats=25`
`creationdate`	Date	Filter by creation date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?creationdate[gte]=2025-01-01`
`modificationdate`	Date	Filter by modification date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?modificationdate[lte]=2025-12-31`

Parameter	Type	Required	Description
`title`	String	No	Title of the module
`description`	String	No	Description of the module
`eduduration`	Integer	No	Educational duration in minutes
`reference`	String	No	Reference of the module
`position`	Integer	No	Position of the module

Parameter	Type	Description	Example
`name`	String	Filter by partner name (exact match or wildcard)	`?name=Acme`
`fullcontrol`	Boolean	Filter by full control status	`?fullcontrol=true`
`creationdate`	Date	Filter by creation date (supports date operators)	`?creationdate[gte]=2024-01-01`
`modificationdate`	Date	Filter by modification date (supports date operators)	`?modificationdate[lte]=2024-12-31`

Parameter	Type	Required	Description
title	String	Yes	Title of the skill theme
language	String	Yes	Language of the skill theme: `french`, `english`, `chinese`, `spanish`, `arabic`, `portuguese`, `russian`, `japanese`, `german`, `italian`, `dutch`, `thai`, `polish`, `bulgarian`, `czech`, `greek`, `korean`, `turkish`, `vietnamese`, `serbian`, `brazilian`, `ukrainian`
skills	Array	No	Array of skill IDs to link to this theme

Parameter	Type	Required	Description
name	String	No	Name of the partner
fullcontrol	Boolean	No	Whether the partner has full control
nbmaxusers	Integer	No	Maximum number of users allowed
nbmaxsubscriptions	Integer	No	Maximum number of subscriptions allowed

Parameter	Type	Required	Description
title	String	No	Title of the resource
content	String/Object	No	Content of the resource (depends on type)
idparent	Integer	No	Parent ID of the resource
reference	String	No	Reference of the resource

Parameter	Type	Description	Example
`name`	String	Filter by skill name/title (supports wildcards `*`)	`?name=Leadership`
`title`	String	Filter by skill title (supports wildcards `*`)	`?title=Management`
`skill`	String	Filter by skill identifier (supports wildcards `*`)	`?skill=SKILL-001`
`description`	String	Filter by skill description (supports wildcards `*`)	`?description=team`
`creationdate`	Date	Filter by creation date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?creationdate[gte]=2025-01-01`
`modificationdate`	Date	Filter by modification date using `[gt]`, `[gte]`, `[lt]`, `[lte]`	`?modificationdate[lte]=2025-12-31`

Parameter	Type	Required	Description
name	String	No	Name of the skill
reference	String	No	Reference of the skill
description	String	No	Description of the skill
themes	Array	No	Array of theme IDs (can be empty array to remove all themes)

Parameter	Type	Required	Description
title	String	No	Title of the training session
seats	Integer	No	Seats available for the training session
sessions	Array of Objects	No	List of the sessions
state	String	No	State of the sessions: `pending` or `validated`

Parameter	Type	Required	Description
idmodule	Integer	No	ID of the module
startdate	Date	No	Start date of the session
enddate	Date	No	End date of the session
location	String	No	Location of the session
timezone	String	No	Timezone of the training session
language	String	No	Language of the session (e.g., `fr-FR`, `en-US`, `es-ES`)
description	String	No	Description of the session
room	String	No	Room of the session
meetingurl	String	No	URL of the virtual classroom
session_type	String	No	Type of the session: `virtual` or `face-to-face`
eduduration	Integer	No	Educational duration of the session in minutes
reference	String	No	Reference of the session
facilitators	Array of Integers	No	User IDs of the facilitators

Parameter	Type	Required	Description
attended	String	No	User attendance
reference	String	No	Reference of the training session registration

Parameter	Type	Required	Description
title	String	No	Title of the webhook
activated	Boolean	No	Whether the webhook is activated
entity	String	No	Entity type: `user`, `training`, `module`, `step`, `resource`, `group`, `partner`, `trainingcategory`, `trainingsubscription`, `sessionsubscription`, `session`, `trainingpath`, `skill`
actions	Array	No	List of actions that trigger the webhook (e.g., `['user_created', 'user_updated']`)
url	String	No	URL endpoint to send webhook requests to
basicauth	Boolean	No	Enable basic authentication
username	String	No	Username for basic authentication (required if basicauth is true)
password	String	No	Password for basic authentication (required if basicauth is true)
hmacsignature	Boolean	No	Enable HMAC signature verification
hmacsecret	String	No	HMAC secret key (required if hmacsignature is true)