SEsendfox
Campaigns

Update a draft campaign

Changed on

Only draft campaigns (not yet sent) can be updated. All fields are optional.

patch/campaigns/{id}

Request

  • Base URL
    https://api.sendfox.com
  • Auth
    OAuth 2
    Authorization codehttps://sendfox.com/oauth/authorize
    Token URLhttps://sendfox.com/oauth/token

Request body

titlestring
subjectstring
preview_textstring nullable

Inbox preview snippet. Pass null to clear.

htmlstring

Email body HTML content. Filtered and spaced on save the same way as when creating a campaign, unless it is the body the campaign already has.

from_namestring
from_emailstring email
reply_to_emailstring email nullable

Where replies go. Empty uses the account's default reply-to, then from_email.

scheduled_atstring date-time nullable

Set to null to unschedule, or a datetime to schedule

listsinteger[]

Replaces all list assignments

excluded_listsinteger[]

Replaces the excluded lists (contacts in these lists are removed from the send).

to_contact_tagsinteger[]

Replaces the included tag audience (contacts carrying these tags receive the campaign).

excluded_contact_tagsinteger[]

Replaces the excluded tag audience (contacts carrying these tags are removed from the send).

Response

Campaign updated successfully

idinteger
titlestring required
subjectstring required
preview_textstring nullable

Inbox preview snippet shown beneath the subject line in most email clients.

htmlstring required
from_namestring required
from_emailstring email required
reply_to_emailstring email nullable

Where replies go. Empty uses the account's default reply-to, then from_email.

scheduled_atstring date-time nullable
sent_atstring date-time nullable
timezonestring
is_web_gatedboolean

The saved per-issue signup requirement. Applies only to published web issues. If the account-wide signup requirement is enabled in Settings, the public page requires signup even when this field is false.

created_atstring date-time
updated_atstring date-time

Changes

  • ae5d5ba1d502Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 35797d91e3a9Revision changes
    • info

      added the optional property to the response with the status