Sign in

get/v1/campaigns/{campaignId}

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

Changed in 4 of the 27 revisions of this API.266

  • ee7832fe66a615See the full diff
    • ▲

      added the new path request parameter campaignId

      new-request-path-parameter

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

    • ○

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

      response-property-enum-value-removed

  • 8088d55e5f7c6See the full diff
    • ●

      deleted the path request parameter campaignId

      request-parameter-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

  • 36c9ecf012d21See the full diff
    • ○

      endpoint added

      endpoint-added

  • ad91eadfd8ee1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation