Skip to main content
GET
/
api
/
v1
/
campaign
Retrieve Campaign
curl --request GET \
  --url https://api.deliveryman.ai/api/v1/campaign/ \
  --header 'X-Api-Key: <api-key>'
{
  "uid": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "workspace_id": 123,
  "settings": {
    "name": "<string>",
    "skip_days": [],
    "sending_domains": [
      123
    ],
    "reply_to_address": "<string>",
    "daily_email_limit": 1073741823,
    "single_subject": true,
    "from_time": "<string>",
    "to_time": "<string>",
    "time_zone": "<string>",
    "add_unsub_link": true,
    "unsub_link_type": "<string>",
    "custom_unsub_text": "<string>",
    "click_tracking_enabled": true,
    "open_tracking_enabled": true,
    "skip_dangerous_emails": true,
    "skip_disposable_emails": true,
    "skip_catchall_emails": true,
    "skip_full_inbox_emails": true,
    "skip_invalid_emails": true,
    "forward_negative_emails": true,
    "forward_netural_emails": true
  },
  "selected_contact_lists": [
    {}
  ],
  "scheduled_start_datetime": "2023-11-07T05:31:56Z",
  "bounces": 1073741823,
  "campaign_paused": true,
  "campaign_paused_on": "2023-11-07T05:31:56Z",
  "is_generating_schedules": true,
  "is_deleting_schedules": true,
  "archived": true,
  "is_campaign_bounce_blocked": true,
  "started_running_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.deliveryman.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Enter your API key in the format: X-Api-Key <your_key>

Query Parameters

​
campaign_uid
string
required

UID of campaign data to fetch.

Response

Success

​
uid
string
required

Unique identifier of the campaign.

Maximum string length: 255
​
created_on
string<date-time>
required
read-only

Date when the campaign was created. ISO format date string in UTC timezone.

​
workspace_id
integer | null
required
read-only

The ID of the workspace associated with the campaign.

​
settings
object
required
​
selected_contact_lists
object[]
required
read-only
​
scheduled_start_datetime
string<date-time> | null

Datetime when the campaign is scheduled to start. ISO format date string in UTC timezone.

​
status
enum<string>

Current status of the campaign.

  • creating - Creating
  • created - Created
  • scheduled - Scheduled
  • running - Running
  • paused - Paused
  • complete - Complete
  • cancelled - Cancelled
  • failed - Failed
Available options:
creating,
created,
scheduled,
running,
paused,
complete,
cancelled,
failed
​
bounces
integer

Number of bounced emails in the campaign.

Required range: 0 <= x <= 2147483647
​
campaign_paused
boolean

Indicates whether the campaign is paused.

​
campaign_paused_on
string<date-time> | null

Datetime when the campaign was paused.

​
is_generating_schedules
boolean

Indicates if schedules are being generated for the campaign.

​
is_deleting_schedules
boolean

Indicates if schedules are being deleted for the campaign.

​
archived
boolean

Flag indicating if the campaign is archived.

​
is_campaign_bounce_blocked
boolean

Flag indicating if the campaign is bounce-blocked.

​
started_running_at
string<date-time> | null

Datetime when the campaign started running. ISO format date string in UTC timezone.

​
completed_at
string<date-time> | null

Datetime when the campaign was completed. ISO format date string in UTC timezone.

​
cancelled_at
string<date-time> | null

Datetime when the campaign was cancelled. ISO format date string in UTC timezone.