Adopt the incoming version and discard the local edit
Adopt the retained incoming version as the body of record (FR-105).
/v1/help-centre/articles/{translation_id}/conflict/adoptEditor- Operation id
- post_adopt_conflict
- Access
- A viewer is refused.
/v1/help-centre/articles/{translation_id}/conflict/adoptAdopt the retained incoming version as the body of record (FR-105).
This resolves a conflict in favour of the source. The local edit is replaced and the conflict is cleared. There is no undo, so read the comparison first.
To resolve it the other way, keeping the local text, edit the article instead.
It takes no body. What is adopted is the version the server is holding, and
a client-supplied body would make this an edit endpoint wearing a different
name, with the one property that matters gone, namely that body_source
only ever holds bytes that came from the source or from the six-field edit.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: editor, admin or owner. A viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the help-centre-staff:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
uuidQuery Parameters
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/help-centre/articles/497f6eca-6276-4993-bfeb-53cbbbba6f08/conflict/adopt"{ "article_id": "string", "translation_id": "string", "locale": "string", "title": "string", "slug": "string", "excerpt": "string", "container_path": "string", "url": "string", "position": 0, "promoted": true, "breadcrumbs": [ { "name": "string", "path": "string", "url": "string" } ], "updated_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z", "vote_count": 0, "vote_sum": 0, "visibility": "string", "editorial_state": "string", "source_visibility_raw": {}, "permission_group_id": "string", "user_segment_ids": [ "string" ], "outdated": true, "outdated_locales": [ "string" ], "missing_at_source_at": "2019-08-24T14:15:22Z", "locally_edited_at": "2019-08-24T14:15:22Z", "has_conflict": true, "conflict_seen_at": "2019-08-24T14:15:22Z", "body_html": "string", "body_markdown": "string", "body_format": "string", "sanitizer_version": "string", "sanitize_report": {}, "link_report": {}, "asset_report": {}, "source_status_raw": "string", "canonical_url": "string", "alternates": [ { "locale": "string", "url": "string" } ], "author_label": "string", "labels": [ "string" ], "source_url": "string", "source_created_at": "2019-08-24T14:15:22Z", "source_updated_at": "2019-08-24T14:15:22Z", "noindex": true}