List newsletter-level segments (deprecated)

Deprecated

GET

/api/v3/audience/segments

const url = 'https://api.tryletterhead.com/api/v3/audience/segments?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/audience/segments?api=true' \
  --header 'Authorization: Bearer <token>'

This endpoint is deprecated in favor of the company-wide Contacts endpoints, which do the same job with more flexibility and at a larger scale. It is documented here for accounts still calling it; use the Contacts endpoints for anything new.

Replaced by GET /api/v3/contacts/segments. Some longer-standing accounts still see a newsletter-level segment list here. Dynamic segments that Letterhead maintains for you are not included.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

Successful response

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