Campaigns

Public Update Campaign Step

Campaigns endpoint for PATCH /campaigns/steps/{step_id}.

patch/campaigns/steps/{step_id}

Request

  • Base URL: https://public.outreach2day.com
  • URL: https://public.outreach2day.com/campaigns/steps/{step_id}
  • Auth: HTTP bearer

Path parameters

step_idstring required

Query parameters

workspaceIdinteger required

Request body

orderinteger nullable
delaySecondsinteger nullable

Delay AFTER this step before the next step can be sent.

delayDaysinteger nullable

Delay AFTER this step before the next step can be sent (in days).

subjectstring nullable
bodystring nullable
bodyTextstring nullable
bodyHtmlstring nullable
text_html_validation_overridestring nullable

A reason to save a plain-text body that contains HTML tags anyway. Without it such a body is refused with 422 TEXT_BODY_LOOKS_LIKE_HTML. The reason is logged and never stored.

Example request

{
  "delaySeconds": 3600,
  "variants": [
    {
      "bodyText": "Edited body",
      "share": 1,
      "subject": "Updated variant"
    }
  ]
}

Response

Successful Response

idstring nullable
campaignIdstring nullable
orderinteger nullable
subjectstring nullable
bodystring nullable
bodyTextstring nullable
bodyHtmlstring nullable
delaySecondsinteger nullable

Delay AFTER this step before the next step can be sent.

delayDaysinteger nullable

Delay AFTER this step before the next step can be sent (in days).

variantsobject[] nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.