GET /v1/campaigns/{campaignId}

Changed on

Request

Path parameters

campaignIdstring required
Example:cmp_123

Response

Get campaign details

idstring required
namestring required
fromstring required
subjectstring required
previewTextstring nullable required
contactBookIdstring nullable required
htmlstring nullable required
contentstring nullable required
statusstring required
scheduledAtstring date-time nullable required
batchSizeinteger required
batchWindowMinutesinteger required
totalinteger required
sentinteger required
deliveredinteger required
openedinteger required
clickedinteger required
unsubscribedinteger required
bouncedinteger required
hardBouncedinteger required
complainedinteger required
replyTostring[] required
ccstring[] required
bccstring[] required
createdAtstring date-time required
updatedAtstring date-time required

Changes

    • breaking

      added the new path request parameter campaignId

    • info

      removed the DRAFT enum value from the response property for the response status

    • info

      removed the PAUSED enum value from the response property for the response status

    • info

      removed the RUNNING enum value from the response property for the response status

    • info

      removed the SCHEDULED enum value from the response property for the response status

    • info

      removed the SENT enum value from the response property for the response status

    • warning

      deleted the path request parameter campaignId

    • warning

      added the new DRAFT enum value to the response property for the response status

    • warning

      added the new PAUSED enum value to the response property for the response status

    • warning

      added the new RUNNING enum value to the response property for the response status

    • warning

      added the new SCHEDULED enum value to the response property for the response status

    • warning

      added the new SENT enum value to the response property for the response status