api-docs-icon

Get Campaign

GET
/ api/ v1/ campaigns/ {id}/ details

Get basic campaign information given a campaign id. For more detailed stats, call the Get Campaign Stats endpoint

status

  • 1 - Sent
  • 0 - Pending
  • -1 - Draft Mode
  • 9 or 10 - Processing

id
integer (int32)
required

Integer contains the Id of the object to retrieve.

Response

application/json
object
ContactListId
integer (int32)

The identifier for the contact list used in the campaign.

Example:
10142067
DirectMailDropId
integer (int32)

The unique identifier for the Direct Mail Drop.

Example:
10142067
DirectMailName
string
nullable

The name of the direct mail campaign.

Example:
Keymaker
EndPointId
string
nullable

The endpoint identifier associated with the campaign.

Example:
https://app.postalytics.com/1234567890
Status
integer (int32)

The status of the campaign.

Example:
1

Code Examples

Response