Get one NewsLetter

GET

api

content

newsletters

{id}

Get one NewsLetter

curl --request GET \
  --url https://spaces.nexudus.com/api/content/newsletters/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/newsletters/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/newsletters/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "LastSent": "<string>",
  "Language": 123,
  "NewsLetterContents": "<string>",
  "NewsLetterDesign": "<string>",
  "Clicks": 123,
  "Opens": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A newsletter is a location-scoped email campaign with a subject and HTML body, sent through a separate command to active subscribers in the selected language.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the NewsLetter-Read role.

Path Parameters

integer

required

The Id of the NewsLetter record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/newsletters/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/newsletters/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/newsletters/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this newsletter..

string

Email subject line shown to newsletter recipients..

string

UTC date and time when a newsletter send was last initiated; set by the send command..

integer

Language edition and recipient-language filter: EnglishUS, Spanish, or EnglishUK.. See eLanguage enum values: 3 = EnglishUK, 1 = EnglishUS, 2 = Spanish.

string

HTML email body; sending adds unsubscribe and engagement-tracking links and replaces supported recipient tokens..

string

Optional newsletter design data; current send processing uses NewsLetterContents as the email body..

integer

Read-only count of tracked recipient link-click activities for this newsletter..

integer

Read-only count of tracked recipient open activities for this newsletter..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "LastSent": null,
  "Language": 0,
  "NewsLetterContents": null,
  "NewsLetterDesign": null,
  "Clicks": 0,
  "Opens": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "NewsLetter Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one NewsLetter

curl --request GET \
  --url https://spaces.nexudus.com/api/content/newsletters/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/newsletters/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/newsletters/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "LastSent": "<string>",
  "Language": 123,
  "NewsLetterContents": "<string>",
  "NewsLetterDesign": "<string>",
  "Clicks": 123,
  "Opens": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200