Publish
Use the Publish API to submit reports, jobs, and training for publication on ReliefWeb.
Usual flow
A create, replace, or update typically goes like this:
- Submit with
PUT(orPATCH) - Queued (
202) - Processed (including file download for reports when relevant)
- Editorial review
- Published on reliefweb.int and in the read/search API
DELETE withdraws a document immediately, with no queue.
Before you start
Your organization must be listed on reliefweb.int/organizations. You also need an appname, API key, provider UUID, and trusted URL prefixes. See Access and credentials.
Where to go
| What you want to do | Page |
|---|---|
| Get access and credentials | Access and credentials |
| Set up trusted URL prefixes and generate UUIDs | Trusted URLs and UUIDs |
Create or replace a document (PUT) |
Create |
Change some fields (PATCH) |
Update |
Withdraw a document (DELETE) |
Withdraw |
| Status codes, shared rules, and limits | Responses, limits, and errors |
| Publish a report (including PDFs and images) | Reports · Report fields · Report examples · Files and images |
| Publish a job | Jobs · Job fields · Job examples |
| Publish a training opportunity | Training · Training fields · Training examples |