Training
Submit a training opportunity for editorial review. The path segment is training (no trailing “s”).
PUT|PATCH|DELETE https://api.reliefweb.int/v2/training/{uuid}?appname=REPLACE-WITH-APP-NAME
You need Access and credentials and Trusted URLs and UUIDs. For changes and withdrawals, see Update and Withdraw.
Field summary
Canonical schema: training.json. Field-by-field rules and examples: field reference.
| Name | Required | Type | Description |
|---|---|---|---|
url |
yes | string (IRI / URL) | Immutable unique identifier in URL form under your trusted document prefix. Used to generate the training UUID. Does not need to resolve to a live page. Never change after first submission. |
uuid |
yes | string (UUID v5) | Training UUID v5 computed as `uuid5(ReliefWeb namespace, url)`. Must match what the server computes from the exact url string. |
title |
yes | string | Training title only. Do not put location, date, or organization name in this field. |
source |
yes | array of integer | Source organization ID(s) from /v2/sources (ReliefWeb integer taxonomy IDs, not UUIDs). |
format |
yes | array of integer | Training-format ID(s) from /v2/references/training-formats (on-site and/or online). On-site id is 4606; online is 4607. |
country |
conditional | array of integer | Country ID(s) from /v2/countries. Mandatory when format includes on-site; otherwise the property is not allowed. |
dates |
no | object | Training dates. Omit the whole object if the offering is ongoing or always available. When present, all three properties are required. |
event_url |
yes | string (IRI / URL) | Public page with more information about the opportunity. Do not use a social media URL here (you may mention social links in body). |
cost |
yes | string (enum) | Whether the training is free or fee-based. |
fee_information |
conditional | string | Exact course fee and what it does and does not cover (plain text). Cannot be replaced by a link alone. |
category |
yes | array of integer | Single training-type ID from /v2/references/training-types. |
training_language |
yes | array of integer | Language(s) in which the course or event is held, from /v2/references/languages. |
professional_function |
no | array of integer | Career-category ID(s) from /v2/references/career-categories. Tag only the most relevant (over-tagging reduces discoverability). |
theme |
no | array of integer | Single theme ID from /v2/references/themes. Choose only the most relevant. |
language |
yes | array of integer | Language(s) of this advertisement (English, Spanish, or French), from /v2/references/languages. This is the language of the ad text, not the course language. |
body |
yes | string (markdown or HTML) | Complete training description (introduction, methodology, objectives, audience). Do not replace with a link for further details. |
how_to_register |
yes | string (markdown or HTML) | Registration steps, conditions, and contact details. Do not replace with a bare link. If none required, say so explicitly (for example “No registration required.”). |
Taxonomy fields are integer ids — not UUIDs. Resolve them via the read API and /v2/references.
Conditional fields
| Field | Rule |
|---|---|
fee_information |
Required when cost is fee-based; omit when cost is free. |
country |
Required when format includes on-site (4606); omit otherwise. |
dates |
If present, include start, end, and registration_deadline (ISO 8601). Omit the whole object for ongoing offerings. |
| Goal | See |
|---|---|
| Rules, examples, and lookups for each field | Training fields |
| Minimal and production-style payloads, troubleshooting | Training examples |
| Change some fields | Update |
| Withdraw | Withdraw |
Next: Training fields