Pitches
Create a pitch draft
Create an individual pitch draft for later review.
Personal token scopes: pitches:write. Your account must also have access to the requested data. Authentication
POST
Creates a draft pitch. Requires manage_emails. Drafts may be incomplete and can be updated before sending.
Personal access tokens: pitches: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.
application/json- body
Supported public fields for creating or updating a pitch draft. Scheduling and CC/BCC mutation are intentionally unsupported by this contract.
sender_address?|Pointer to a SenderAddress to be used with create & update operations.
recipient?||subject?stringcontent?stringSerialized Prezly email content JSON.
newsroom?|integer||story?|||story_alignment?stringValue in
"left""center""right"story_appearance?stringValue in
"intro""full"story_header_footer?stringValue in
"none""standard""full"is_open_tracking_enabled?booleanis_click_tracking_enabled?booleanCreated
application/json- response
pitch*A one-to-one email pitch sent to a single primary contact. The numeric id is the stable pitch identifier.
warnings*array<>curl -X POST 'https://api.prezly.com/v2/pitches' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "pitch": { "id": 0, "type": "pitch", "subject": "string", "followup_to": { "id": 0, "type": "pitch", "subject": "string" }, "quoted_email_content": "string", "followup_cc": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "cc", "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" } }, "email": "user@example.com" } ], "status": "draft", "workflow_statuses": [ "draft" ], "from": { "name": "string", "email_address": "user@example.com" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "sent_at": "2019-08-24T14:15:22Z", "delivered_at": "2019-08-24T14:15:22Z", "scheduled_at": "2019-08-24T14:15:22Z", "is_draft": true, "is_finalized": true, "is_scheduled": true, "is_processing": true, "is_sent": true, "is_demo": true, "email_content": "string", "story_alignment": "left", "story_appearance": "intro", "story_header_footer": "none", "recipient": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_name": "string", "avatar_url": "http://example.com", "email_address": "user@example.com", "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" } }, "is_unsubscribed": true, "is_unsubscribed_from_all_communications": true }, "copies": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "cc", "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" } }, "email": "user@example.com" } ], "author": { "id": 0, "email": "http://example.com", "name": "string", "display_name": "string", "first_name": "string", "last_name": "string", "avatar_url": "http://example.com" }, "sender": { "id": 0, "sender_email": "user@example.com", "sender_name": "string", "type": "string", "is_default": true, "is_public_webmail": true, "domain": { "domain_name": "example.com", "is_valid": true, "is_public_webmail": true, "is_prezlymail": true, "is_upgrade_recommended": true, "verification_flow_version": "v1" }, "is_verified": true, "is_approved": true, "domain_info": "string" }, "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" } }, "is_open_tracking_enabled": true, "is_click_tracking_enabled": true, "sender_domain_verification_flow": null, "sender_domain_verification_status": "unknown", "thumbnail_url": "http://example.com", "stats": { "recipients": 0, "delivered": 0, "clicks": 0, "opens": 0, "bounces": 0, "skipped": 0, "unsubscribes": 0, "clicks_rate": 0, "opens_rate": 0, "unsubscribes_rate": 0 } }, "warnings": [ { "field": "recipient.email_address", "code": "bounced", "message": "string" } ]}