campaigns
Email Campaigns

Create Email Campaign

Create a new email campaign using the dedicated EmailCampaign model. This endpoint provides a direct REST API method for creating campaigns instead of using the workflow approach.

post/api/campaigns/email

Request

  • Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepomo.ai/api/campaigns/email
  • Auth: HTTP bearer

Request body

namestring nullable
subject_linestring nullable
contentstring nullable
preview_textstring nullable
call_to_actionstring nullable
target_audiencestring nullable
key_selling_pointsstring nullable
from_namestring nullable
reply_tostring nullable
product_offering_idstring uuid nullable
workflow_status'draft' | 'review' | 'approved' | 'scheduled' | 'sending' | 'sent' | 'failed'

Email campaign workflow status values.

scheduled_send_timestring date-time nullable
sent_atstring date-time nullable
personalization_levelstring nullable
merge_variablesobject nullable
dynamic_blocksobject nullable
ab_test_configobject nullable
performance_metricsobject nullable
optimization_configobject nullable
company_idstring uuid nullable
consumer_group_idsstring[] nullable
campaign_idstring required
idea_numberinteger required
variationinteger

Response

Successful Response

namestring nullable
subject_linestring nullable
contentstring nullable
preview_textstring nullable
call_to_actionstring nullable
target_audiencestring nullable
key_selling_pointsstring nullable
from_namestring nullable
reply_tostring nullable
product_offering_idstring uuid nullable
workflow_status'draft' | 'review' | 'approved' | 'scheduled' | 'sending' | 'sent' | 'failed'

Email campaign workflow status values.

scheduled_send_timestring nullable
sent_atstring nullable
personalization_levelstring nullable
merge_variablesobject nullable
dynamic_blocksobject nullable
ab_test_configobject nullable
performance_metricsobject nullable
optimization_configobject nullable
company_idstring uuid nullable
consumer_group_idsstring[] nullable
idstring nullable required
company_profile_idstring nullable required
campaign_idstring required
idea_numberinteger required
variationinteger required
total_recipientsinteger
emails_sentinteger
emails_failedinteger
creation_datestring nullable required
last_modifiedstring nullable required

Changes

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