Preview a purchase's ad creative

GET

/api/v3/promotions/purchases/{purchaseUniqueId}/preview

const url = 'https://api.tryletterhead.com/api/v3/promotions/purchases/example/preview?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/promotions/purchases/example/preview?api=true' \
  --header 'Authorization: Bearer <token>'

Render the advertiser-submitted creative for a pending purchase and return it directly as text/html (not the usual JSON envelope) — used by the publisher to review the ad before approving it.

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Path Parameters

purchaseUniqueId

required

string

UUID of the purchase to preview

Query Parameters

api

required

boolean

When set to true, the endpoint accepts authorization with your API Key.

Responses

200

200 OK — rendered HTML

text/html

string

Still can’t find what you need? Contact support.