Update an earned media item
Projects module
PATCH/earned-media-items/{id}earnedMediaItems.update
A piece of earned media coverage of a project (gate 8, G8.MEASUREMENT_REPORTED), sourced, dated and linked. The earned media figures of the measurement summary are computed from these rows. A reach the source does not report is null (Unmeasured); a tone is null until rated. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability projects.gate.evidence.write.
- OAuth scopes: projects.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the earned media item. |
Request body: EarnedMediaItemUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| title | string | No | Headline or title of the coverage.Constraints: length 1 to 300 |
| outlet | string | No | Publication, station, channel or account that ran it.Constraints: length 1 to 200 |
| medium | "Online" | "Print" | "Broadcast" | "Podcast" | "Social" | No | Where the coverage ran. |
| published_on | string (date) | No | Day it ran, on the project's calendar; never after today there. |
| url | string (uri) | null | No | Link to the coverage; one live row per link in a project. |
| reach | integer | null | No | Audience the outlet reports for the piece; null when unreported.Constraints: range 0 to any |
| tone | "Positive" | "Neutral" | "Negative" | null | No | Sentiment of the coverage; null until rated. |
| source | "Manual" | "Import" | "Integration" | No | How the figure reached XOS. |
| source_reference | string | null | No | What the figure came from, such as an invoice, a meter reading or a file name.Constraints: length 1 to 300 |
| note | string | null | No | Note.Constraints: length 1 to 2000 |
{
"title": "Summer Series opens on the pier",
"outlet": "WLRN",
"medium": "Broadcast",
"published_on": "2026-10-08",
"url": "https://northwindlive.example/files/site-plan.pdf",
"reach": 120000,
"tone": "Positive",
"source": "Import",
"source_reference": "Hauler invoice 4471",
"note": "Two roll-off containers."
}Response 200: EarnedMediaItem
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the earned media item. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| title | string | Yes | Headline or title of the coverage.Constraints: length 1 to 300 |
| outlet | string | Yes | Publication, station, channel or account that ran it.Constraints: length 1 to 200 |
| medium | "Online" | "Print" | "Broadcast" | "Podcast" | "Social" | Yes | Where the coverage ran. |
| published_on | string (date) | Yes | Day it ran, on the project's calendar; never after today there. |
| url | string (uri) | null | Yes | Link to the coverage; one live row per link in a project. |
| reach | integer | null | Yes | Audience the outlet reports for the piece; null when unreported.Constraints: range 0 to any |
| tone | "Positive" | "Neutral" | "Negative" | null | Yes | Sentiment of the coverage; null until rated. |
| source | "Manual" | "Import" | "Integration" | Yes | How the figure reached XOS. |
| source_reference | string | null | Yes | What the figure came from, such as an invoice, a meter reading or a file name.Constraints: length 1 to 300 |
| note | string | null | Yes | Note.Constraints: length 1 to 2000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"title": "Summer Series opens on the pier",
"outlet": "WLRN",
"medium": "Broadcast",
"published_on": "2026-10-08",
"url": "https://northwindlive.example/files/site-plan.pdf",
"reach": 120000,
"tone": "Positive",
"source": "Import",
"source_reference": "Hauler invoice 4471",
"note": "Two roll-off containers."
}Code samples
curl -X PATCH "$XOS_BASE_URL/earned-media-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"title":"Summer Series opens on the pier","outlet":"WLRN","medium":"Broadcast","published_on":"2026-10-08","url":"https://northwindlive.example/files/site-plan.pdf","reach":120000,"tone":"Positive","source":"Import","source_reference":"Hauler invoice 4471","note":"Two roll-off containers."}'const { data, etag } = await xos.earnedMediaItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"title": "Summer Series opens on the pier",
"outlet": "WLRN",
"medium": "Broadcast",
"published_on": "2026-10-08",
"url": "https://northwindlive.example/files/site-plan.pdf",
"reach": 120000,
"tone": "Positive",
"source": "Import",
"source_reference": "Hauler invoice 4471",
"note": "Two roll-off containers."
}, { ifMatch: etag });response = xos.earned_media_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Summer Series opens on the pier", "outlet": "WLRN", "medium": "Broadcast", "published_on": "2026-10-08", "url": "https://northwindlive.example/files/site-plan.pdf", "reach": 120000, "tone": "Positive", "source": "Import", "source_reference": "Hauler invoice 4471", "note": "Two roll-off containers."}, if_match=etag)xos earned-media-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Summer Series opens on the pier","outlet":"WLRN","medium":"Broadcast","published_on":"2026-10-08","url":"https://northwindlive.example/files/site-plan.pdf","reach":120000,"tone":"Positive","source":"Import","source_reference":"Hauler invoice 4471","note":"Two roll-off containers."}' --if-match auto