Create event

post

https://api.campaignrefinery.com/rest/sequences/create_event

Adds an event to a sequence and returns it (HTTP 201). The accepted body depends on event_type: supply only the parameters that belong to that type (extras are rejected with 422, and a type's required parameters must be present). Call sequence_events for the per-type parameter list. Note: footer_id and suppression_list_id are UUIDs despite their names. The new event is appended after the sequence's existing events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sequence_uuid

uuid

required

UUID of the sequence to add the event to. Must belong to the account.

event_type

string

enum

required

The kind of event. Determines which additional parameters are accepted/required -- see sequence_events.

event_name

string

Optional display name for the event.

eds_uuid

uuid

Used by event type(s): send_email, send_notification. Required for: send_email, send_notification.

email_name

string

Used by event type(s): send_email, send_notification. Required for: send_email, send_notification.

email_subject_1

string

Used by event type(s): send_email, send_notification. Required for: send_email, send_notification.

footer_id

uuid

Used by event type(s): send_email, send_notification. Required for: send_email, send_notification. Despite the _id suffix this is the footer UUID (fetch options from GET /rest/footers/get_footers).

email_body

string

Used by event type(s): send_email, send_notification.

email_body_custom

string

Used by event type(s): send_email, send_notification.

email_body_custom_on

boolean

Used by event type(s): send_email, send_notification.

email_preview_text

string

Used by event type(s): send_email, send_notification.

email_from_name

string

Used by event type(s): send_email, send_notification.

email_from_email

string

Used by event type(s): send_email, send_notification.

email_replyto_name

string

Used by event type(s): send_email, send_notification.

email_replyto_email

string

Used by event type(s): send_email, send_notification.

email_recipient

string

Used by event type(s): send_email, send_notification.

run_event_in_days

integer