GET
/
api
/
v1
/
newsletters
/
{uuid}
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "uuid": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "owner": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "fullName": "<string>"
  },
  "html": "<string>",
  "design": [
    "<string>"
  ],
  "htmlRaw": "<string>",
  "cssRaw": "<string>",
  "clicks": [
    "<string>"
  ],
  "unit": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>"
  },
  "tenant": "https://example.com/",
  "localCenter": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>"
  },
  "isGeneral": true,
  "isContacts": true,
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateSent": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "recipients": 123,
  "rateSent": 123,
  "rateOpen": 123,
  "rateClick": 123,
  "rateBounced": 123,
  "rateCompliant": 123,
  "rateUnsubscribe": 123,
  "event": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "uuid": "<string>",
    "name": "<string>",
    "numberOfParticipants": 123,
    "isOnline": true,
    "settings": {
      "tenantLogo": true,
      "showTitle": true,
      "colorSelection": null,
      "colorButton": null,
      "disableSubscribe": false,
      "disableRegister": true,
      "lightThemeOnly": false,
      "isThankYouSingular": false,
      "fieldName": true,
      "fieldEmail": true,
      "fieldPhone": false,
      "fieldOrganisation": false,
      "fieldRole": false,
      "fieldTown": false,
      "fieldLinkedin": false,
      "fieldX": false,
      "fieldInstagram": false
    }
  },
  "sendToEverybody": true,
  "isPublic": true,
  "slugGo": "<string>",
  "publicPreviewLogo": "<string>",
  "userList": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>"
  }
}

Path Parameters

uuid
string
required

Newsletter identifier

Response

Newsletter resource

@context
@id
string
@type
string
id
integer
uuid
string | null
name
string
subject
string
owner
object
html
string | null
design
string[] | null
htmlRaw
string | null
cssRaw
string | null
clicks
string[] | null
unit
object | null
tenant
string<iri-reference>
Example:

"https://example.com/"

localCenter
object | null
isGeneral
boolean
isContacts
boolean
dateCreated
string<date-time>
dateSent
string<date-time> | null
status
string
recipients
integer | null
rateSent
integer | null
rateOpen
integer | null
rateClick
integer | null
rateBounced
integer | null
rateCompliant
integer | null
rateUnsubscribe
integer | null
event
object | null
sendToEverybody
boolean | null
isPublic
boolean | null
default:true
Example:

true

slugGo
string | null
userList
object | null