Campaigns

Get a specific campaign

Changed on
get/campaigns/{id}

Request

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

Response

Successful response

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

    • 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

    • info

      added the optional property to the response with the status