newsletter

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-newsletter"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/6ddb6b60-e4af-4ab8-9e30-d59475817fd4/social-card.svg?v=3e7ae33eec8b" alt="newsletter" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/newsletter/publications/{id}/authors

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/newsletter/publications/{id}/authors" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "publicationId": "string",
      "name": "string",
      "slug": "string",
      "bio": "string",
      "avatarUrl": "string",
      "email": "string",
      "userId": "string",
      "isGuest": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem187[]required
Show child parameters
idstringrequired
publicationIdstringrequired
namestringrequired
slugstringrequired
biostringrequired
avatarUrlstringrequired
emailstringrequired
userIdstringrequired
isGuestbooleanrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
POSThttps://hermeticor.com/v1/newsletter/publications/{id}/authors

Parameters

idstringpathrequired

Request body

application/json
namestringrequired
slugstring
biostring
avatarUrlstring
emailstring
userIdstring
{
  "name": "string",
  "slug": "string",
  "bio": "string",
  "avatarUrl": "string",
  "email": "string",
  "userId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/publications/{id}/authors" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","bio":"string","avatarUrl":"string","email":"string","userId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "publicationId": "string",
  "name": "string",
  "slug": "string",
  "bio": "string",
  "avatarUrl": "string",
  "email": "string",
  "userId": "string",
  "isGuest": true
}
Schema
idstringrequired
publicationIdstringrequired
namestringrequired
slugstringrequired
biostringrequired
avatarUrlstringrequired
emailstringrequired
userIdstringrequired
isGuestbooleanrequired
DELETEhttps://hermeticor.com/v1/newsletter/authors/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/newsletter/authors/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
PATCHhttps://hermeticor.com/v1/newsletter/authors/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
slugstring
biostring
avatarUrlstring
emailstring
userIdstring
{
  "name": "string",
  "slug": "string",
  "bio": "string",
  "avatarUrl": "string",
  "email": "string",
  "userId": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/newsletter/authors/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","bio":"string","avatarUrl":"string","email":"string","userId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

GEThttps://hermeticor.com/v1/newsletter/publications/{id}/sections

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/newsletter/publications/{id}/sections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "publicationId": "string",
      "name": "string",
      "slug": "string",
      "description": "string",
      "position": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem188[]required
Show child parameters
idstringrequired
publicationIdstringrequired
namestringrequired
slugstringrequired
descriptionstringrequired
positionintegerrequired
nextCursorstringrequired
POSThttps://hermeticor.com/v1/newsletter/publications/{id}/sections

Parameters

idstringpathrequired

Request body

application/json
namestringrequired
slugstring
descriptionstring
{
  "name": "string",
  "slug": "string",
  "description": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/newsletter/publications/{id}/sections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","description":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "publicationId": "string",
  "name": "string",
  "slug": "string",
  "description": "string",
  "position": 0
}
Schema
idstringrequired
publicationIdstringrequired
namestringrequired
slugstringrequired
descriptionstringrequired
positionintegerrequired
DELETEhttps://hermeticor.com/v1/newsletter/sections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/newsletter/sections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/newsletter/authors/{id}

PATCHhttps://hermeticor.com/v1/newsletter/sections/{id}

Parameters

idstringpathrequired

Request body

application/json
namestring
slugstring
descriptionstring
{
  "name": "string",
  "slug": "string",
  "description": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/newsletter/sections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","slug":"string","description":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

GEThttps://hermeticor.com/v1/newsletter/publications/{id}/redirects

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/newsletter/publications/{id}/redirects" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "publicationId": "string",
      "fromPath": "string",
      "toPath": "string",
      "status": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem189[]required
Show child parameters
idstringrequired
publicationIdstringrequired
fromPathstringrequired
toPathstringrequired
statusintegerrequired
nextCursorstringrequired

Updated