Coverage
Update Coverage
Change selected fields on an existing coverage entry.
Personal token scopes: coverage:write + contacts:write. Your account must also have access to the requested data. Authentication
Omitted fields remain unchanged and type defaults to the existing record. note_content accepts a text object; external_reference_id conflicts and story/newsroom mismatches return 409.
PATCH
Author and organisation can resolve or auto-create contacts. Personal tokens require both coverage:write and contacts:write.
Personal access tokens: coverage:write and contacts:write. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.
API_keyheader
AuthorizationBearer <token>Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.
id*stringCoverage ID.
application/json- body
type?stringRequired when creating coverage. On PATCH omission keeps the existing type.
Value in
"online""social""print""radio""television"attachment_oembed?OEmbed info object containing properties about specific URI location.
attachment_plaintext_content?stringattachment?stringauthor?|||||external_reference_id?string|nullheadline?stringnewsroom?integer|||||note_content?||Serialized content JSON, or a single-key wrapper containing serialized JSON or plain text. A parsed document object is not accepted.
organisation?|||||original_metadata_source?stringpublished_at?stringstory?|||Existing story integer ID or a single-key id wrapper. String IDs and UUIDs are not accepted. Null clears the story reference.
url?stringculture?stringCulture code.
country?stringCountry code.
management_url?stringprovider?|Value in
"ammco""auxipress""belga""feed""google_alerts""kantar""knewin""manual""mediaweb""meltwater""opoint""talkwalker""netfeedr"nullfragment_duration?integerfragment_start_time?stringfragment_end_time?stringpage?integerpdf_url?|Format
urisentiment?|Value in
"neutral""negative""positive"nullOK
application/json- response
coverage?curl -X PATCH 'https://api.prezly.com/v2/coverage/string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response200
{ "coverage": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "id": "string", "display_name": "string", "is_deleted": true, "headline": "string", "user": { "id": 0, "email": "http://example.com", "name": "string", "display_name": "string", "first_name": "string", "last_name": "string", "avatar_url": "http://example.com" }, "story": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "id": 0, "thumbnail_url": "http://example.com", "title": "string", "culture": { "code": "en", "name": "string", "direction": "ltr", "language_code": "en", "native_name": "string" }, "language": "string", "status": "uninitialized", "lifecycle_status": "uninitialized", "publication_status": "uninitialized", "visibility": "public", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "published_at": "2019-08-24T14:15:22Z", "scheduled_at": "2019-08-24T14:15:22Z", "author": { "id": 0, "email": "http://example.com", "name": "string", "display_name": "string", "first_name": "string", "last_name": "string", "avatar_url": "http://example.com" }, "newsroom": { "id": 0, "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "name": "string", "display_name": "string", "subdomain": "string", "thumbnail_url": "http://example.com", "timezone": "europe/london", "is_active": true, "is_archived": true, "is_online": true, "is_offline": true, "is_multilingual": true, "url": "http://example.com", "links": { "media_gallery_api": "http://example.com", "room_contacts_api": "http://example.com", "analytics_and_visibility_settings": "http://example.com", "categories_management": "http://example.com", "company_info_settings": "http://example.com", "contacts_management": "http://example.com", "domain_settings": "http://example.com", "edit": "http://example.com", "gallery_management": "http://example.com", "hub_settings": "http://example.com", "languages": "http://example.com", "look_and_feel_settings": "http://example.com", "manual_subscription_management": "http://example.com", "privacy_settings": "http://example.com", "widget_settings": "http://example.com" } }, "url": "http://example.com", "oembed": { "url": "http://example.com", "type": "video", "version": "1.0", "title": "string", "description": "string", "author_name": "string", "author_url": "http://example.com", "provider_name": "string", "provider_url": "http://example.com", "cache_age": 0, "html": "string", "thumbnail_url": "http://example.com", "thumbnail_width": 1, "thumbnail_height": 1, "screenshot_url": "http://example.com" }, "slug": "string" }, "newsroom": { "id": 0, "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "name": "string", "display_name": "string", "subdomain": "string", "thumbnail_url": "http://example.com", "timezone": "europe/london", "is_active": true, "is_archived": true, "is_online": true, "is_offline": true, "is_multilingual": true, "url": "http://example.com", "links": { "media_gallery_api": "http://example.com", "room_contacts_api": "http://example.com", "analytics_and_visibility_settings": "http://example.com", "categories_management": "http://example.com", "company_info_settings": "http://example.com", "contacts_management": "http://example.com", "domain_settings": "http://example.com", "edit": "http://example.com", "gallery_management": "http://example.com", "hub_settings": "http://example.com", "languages": "http://example.com", "look_and_feel_settings": "http://example.com", "manual_subscription_management": "http://example.com", "privacy_settings": "http://example.com", "widget_settings": "http://example.com" } }, "author_contact": { "id": 0, "contact_type": "person", "is_person": true, "is_deleted": true, "salutation": "string", "custom_fields": { "property1": "string", "property2": "string" }, "company_name": "string", "first_name": "string", "last_name": "string", "gender": "string", "display_name": "string", "avatar_url": "string", "avatar_image": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "version": 0, "filename": "string", "mime_type": "string", "size": 0, "original_width": 0, "original_height": 0, "effects": [ "string" ] }, "bio": "string", "primary_email": "user@example.com", "emails": [ "user@example.com" ], "phone_numbers": [ { "type": "cell", "number": "string" } ], "social": [ { "type": "bluesky", "username": "string" } ], "urls": [ "http://example.com" ], "function_name": "string", "periodicity": "daily", "medium_types": [ "wire" ], "address": { "street": "string", "number": "string", "box": "string", "zip": "string", "city": "string", "region": "string", "country": "string" }, "address_text": "string", "coverage_number": 0, "last_coverage_at": "2019-08-24T14:15:22Z", "organisations_number": 0, "organisations": [ { "id": 0, "display_name": "string", "links": { "view": "http://example.com" } } ], "employees_number": 0, "tags": [ "string" ], "is_bounced": true, "is_duplicated": true, "is_unsubscribed": true, "is_unsubscribed_from_all_communications": true, "has_enrichments": true, "unsubscribed_newsrooms": [ "string" ], "duplicate_contacts": [ { "contact": { "id": 0, "contact_type": "person", "display_name": "string", "function_name": "string", "avatar_url": "http://example.com", "is_deleted": true, "links": { "api": "http://example.com", "view": "http://example.com" } }, "score": 0, "status": "unseen", "links": { "merge_api": "http://example.com" } } ], "created_at": "2019-08-24T14:15:22Z", "modified_at": "2019-08-24T14:15:22Z", "stats": { "sent": 0, "replied": 0, "clicked": 0, "clicked_rate": 0, "opened": 0, "opened_rate": 0 }, "meta": { "is_unsubscribed": true, "is_bounced": true, "is_duplicated": true }, "links": { "api": "http://example.com", "view": "http://example.com", "edit": "http://example.com", "convert": "http://example.com", "exclude_mailbox_conversations": "http://example.com", "organisations_api": "http://example.com", "employees_api": "http://example.com", "enrichments_api": "http://example.com", "duplicates_api": "http://example.com", "data_privacy_requests_api": "http://example.com", "export_personal_data_api": "http://example.com" }, "tag_entities": [ { "id": 0, "name": "string" } ] }, "organisation_contact": { "id": 0, "contact_type": "person", "is_person": true, "is_deleted": true, "salutation": "string", "custom_fields": { "property1": "string", "property2": "string" }, "company_name": "string", "first_name": "string", "last_name": "string", "gender": "string", "display_name": "string", "avatar_url": "string", "avatar_image": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "version": 0, "filename": "string", "mime_type": "string", "size": 0, "original_width": 0, "original_height": 0, "effects": [ "string" ] }, "bio": "string", "primary_email": "user@example.com", "emails": [ "user@example.com" ], "phone_numbers": [ { "type": "cell", "number": "string" } ], "social": [ { "type": "bluesky", "username": "string" } ], "urls": [ "http://example.com" ], "function_name": "string", "periodicity": "daily", "medium_types": [ "wire" ], "address": { "street": "string", "number": "string", "box": "string", "zip": "string", "city": "string", "region": "string", "country": "string" }, "address_text": "string", "coverage_number": 0, "last_coverage_at": "2019-08-24T14:15:22Z", "organisations_number": 0, "organisations": [ { "id": 0, "display_name": "string", "links": { "view": "http://example.com" } } ], "employees_number": 0, "tags": [ "string" ], "is_bounced": true, "is_duplicated": true, "is_unsubscribed": true, "is_unsubscribed_from_all_communications": true, "has_enrichments": true, "unsubscribed_newsrooms": [ "string" ], "duplicate_contacts": [ { "contact": { "id": 0, "contact_type": "person", "display_name": "string", "function_name": "string", "avatar_url": "http://example.com", "is_deleted": true, "links": { "api": "http://example.com", "view": "http://example.com" } }, "score": 0, "status": "unseen", "links": { "merge_api": "http://example.com" } } ], "created_at": "2019-08-24T14:15:22Z", "modified_at": "2019-08-24T14:15:22Z", "stats": { "sent": 0, "replied": 0, "clicked": 0, "clicked_rate": 0, "opened": 0, "opened_rate": 0 }, "meta": { "is_unsubscribed": true, "is_bounced": true, "is_duplicated": true }, "links": { "api": "http://example.com", "view": "http://example.com", "edit": "http://example.com", "convert": "http://example.com", "exclude_mailbox_conversations": "http://example.com", "organisations_api": "http://example.com", "employees_api": "http://example.com", "enrichments_api": "http://example.com", "duplicates_api": "http://example.com", "data_privacy_requests_api": "http://example.com", "export_personal_data_api": "http://example.com" }, "tag_entities": [ { "id": 0, "name": "string" } ] }, "url": "string", "note_content_html": "string", "note_content_text": "string", "attachment": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "version": 0, "filename": "string", "mime_type": "string", "size": 0 }, "attachment_oembed": { "url": "http://example.com", "type": "video", "version": "1.0", "title": "string", "description": "string", "author_name": "string", "author_url": "http://example.com", "provider_name": "string", "provider_url": "http://example.com", "cache_age": 0, "html": "string", "thumbnail_url": "http://example.com", "thumbnail_width": 1, "thumbnail_height": 1, "screenshot_url": "http://example.com" }, "published_at": "string", "created_at": "string", "updated_at": "string", "edited_at": "string", "avatar_url": "string", "view_url": "string", "type": "online", "country": { "code": "string", "display_name": "string" }, "culture": { "code": "en", "name": "string", "direction": "ltr", "language_code": "en", "native_name": "string" }, "management_url": "string", "provider": "ammco", "fragment_duration": 0, "fragment_start_time": "string", "fragment_end_time": "string", "page": 0, "note_content_json": "string", "pdf_url": "http://example.com", "sentiment": "neutral", "suggested_stories_count": 0, "screenshot": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "version": 0, "filename": "string", "mime_type": "string", "size": 0, "original_width": 0, "original_height": 0, "effects": [ "string" ] } }}