---
updatedAt: 2026-04-29T08:26:22.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Archive training content (bulk)
Marks one or more training content items as archived. Archived items are hidden from learners but the records are not permanently deleted.
Returns `200 OK` with a `success` array of archived identifiers and an `errors` array for any identifiers that could not be found.
**Before using this endpoint:**
- Training content items must already exist — use the `externalIdentifier` values from the create step.
- Archiving is non-destructive — archived content is hidden from learners but can be restored if needed.
- Unknown identifiers are not treated as a fatal error; they are reported in the `errors` array.
**Testing notes:** Open the **Examples** panel and select a **Request Example** to inspect the body parameters.
# OpenAPI definition
```json
{
"openapi": "3.1.1",
"info": {
"title": "Bob Learning API",
"description": "Public API for partner Learning integrations: register an integration, push and update training content in bulk, archive content, and submit xAPI progress statements.",
"license": {
"name": "Proprietary",
"url": "https://apidocs.hibob.com/docs/api-terms-of-use"
},
"contact": {
"name": "Hi Bob, Inc."
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.hibob.com/v1",
"description": "Production"
},
{
"url": "https://api.sandbox.hibob.com/v1",
"description": "Sandbox"
}
],
"x-readme": {
"metrics-enabled": false
},
"tags": [
{
"name": "Provider integrations",
"description": "Register and remove partner LMS integrations, manage training content, and submit xAPI progress statements"
}
],
"paths": {
"/learning/lms-integrations/{provider-identifier}/training-content/archive": {
"patch": {
"operationId": "patch_learning-lms-integrations-provider-identifier-training-content-archive",
"tags": [
"Provider integrations"
],
"summary": "Archive training content (bulk)",
"description": "Marks one or more training content items as archived. Archived items are hidden from learners but the records are not permanently deleted.\n\nReturns `200 OK` with a `success` array of archived identifiers and an `errors` array for any identifiers that could not be found.\n\n**Before using this endpoint:**\n\n - Training content items must already exist — use the `externalIdentifier` values from the create step.
\n - Archiving is non-destructive — archived content is hidden from learners but can be restored if needed.
\n - Unknown identifiers are not treated as a fatal error; they are reported in the `errors` array.
\n
\n\n**Testing notes:** Open the **Examples** panel and select a **Request Example** to inspect the body parameters.\n",
"parameters": [
{
"name": "provider-identifier",
"in": "path",
"required": true,
"description": "The provider identifier of the LMS integration.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerContentArchiveRequest"
},
"examples": {
"multipleCourses": {
"summary": "Archive multiple courses (with one unknown)",
"value": {
"items": [
"ACME-course-003",
"ACME-course-004",
"ACME-course-009"
]
}
},
"singleCourse": {
"summary": "Archive a single course",
"value": {
"items": [
"ACME-course-005"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success — per-id outcomes",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerContentBulkResponse"
},
"examples": {
"partialSuccess": {
"summary": "Mixed success and errors (unknown identifier)",
"value": {
"success": [
"ACME-course-003",
"ACME-course-004"
],
"errors": [
{
"externalIdentifier": "ACME-course-009",
"message": "Not found"
}
]
}
},
"allSuccess": {
"summary": "All courses archived successfully",
"value": {
"success": [
"ACME-course-005"
],
"errors": []
}
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden — feature disabled or missing permissions",
"content": {}
},
"404": {
"description": "Not found — unknown integration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable entity — invalid item(s)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"security": [
{
"basic": []
},
{
"Bearer": []
}
],
"x-internal": false
}
}
},
"components": {
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic",
"description": "Basic HTTP authentication using service user credentials"
},
"Bearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0",
"description": "OAuth 2.0 access token. Complete the OAuth 2.0 flow in Postman, then paste the token here. Learn more about OAuth 2.0 in HiBob"
}
},
"schemas": {
"ApiErrorResponse": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Error key identifier"
},
"error": {
"type": "string",
"description": "Human-readable error message"
},
"args": {
"type": "array",
"description": "Optional error arguments providing additional context",
"items": {
"type": "string"
}
}
}
},
"PartnerContentArchiveRequest": {
"type": "object",
"description": "Request body for archiving training content by external identifier.",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"description": "List of external identifiers to archive.",
"items": {
"type": "string"
}
}
}
},
"PartnerContentBulkResponse": {
"type": "object",
"description": "Bulk operation outcome from `PartnerContentBulkResponse`.",
"properties": {
"success": {
"type": "array",
"description": "External identifiers that were processed successfully.",
"items": {
"type": "string"
}
},
"errors": {
"type": "array",
"description": "Per-item failures with external id and message.",
"items": {
"$ref": "#/components/schemas/PartnerContentErrorItem"
}
}
}
},
"PartnerContentErrorItem": {
"type": "object",
"required": [
"externalIdentifier",
"message"
],
"properties": {
"externalIdentifier": {
"type": "string",
"description": "External identifier of the failing item."
},
"message": {
"type": "string",
"description": "Failure reason (for example validation or downstream error)."
}
}
}
}
}
}
```