REST API: GET destination + fields (Publisher)

You can use the REST API to retrieve a summary of a mailing destination including the (sub)profile fields with an HTTP GET call to the following URL:$id/fields

Where $id should be replaced with the ID of the mailing destination you want summarized. This method also support the use of the fields parameter for the timestamp field.

Returned fields

The method returns a JSON object containing the following information:

  • ID: The ID of the destination.
  • timestampsent: The timestamp on which the mailing was sent to this recipient.
  • internal: The internal ID of the destination.
  • profile: Array with the ID and fields of the destination profile.
  • subprofile: Array with the ID and fields of the destination subprofile. (if applicable).
  • mailing: The ID of the mailing.

PHP example

The script below demonstrates how to use this API method. Don't forget to replace the ID in the URL before executing the call.

// dependencies

// change this into your access token
$api = new CopernicaRestAPI("your-access-token", 4);

// execute the call

This example requires the REST API class

More information