Sign in
crm-email

Get a CRM email campaign's full definition

Admin-only endpoint returning a single campaign's full definition

get/api/campaigns/{campaign_id}

Path parameters

campaign_idstring uuid required

Campaign UUID

Campaign UUID

Response

Successful Response

idstring required

Campaign UUID.

statusstring required

scheduled | sending | sent | failed | cancelled.

scheduled_atstring date-time nullable

When the campaign is/was scheduled to send.

subjectstring required

Email subject.

notesstring nullable

Internal note on why the campaign was sent; CRM-only.

email_htmlstring nullable

Composed HTML body (placeholders already replaced by URLs).

template_pathstring nullable

Storage path of the uploaded template, if any.

placeholder_imagesobject

Map of placeholder name -> image public URL used to compose email_html.

audience_typestring required

'filters' or 'csv'.

patient_statesstring[]

Stato paziente filters (empty for a csv audience).

registration_reasonsstring[]

Motivo iscrizione filters (empty for a csv audience).

filter_match'any' | 'all'

How stato/motivo filters combine ('any' or 'all').

recipient_emailsstring[]

Explicit recipient emails (only for a csv audience).

created_atstring date-time required

When the campaign was created.

Changes

No recorded changes to this endpoint across all 1 revision of this API.