Edit a newsletter.

Authorization

GhostAdminJWT

Authorization<token>

Send Authorization: Ghost <JWT>. This is a custom Ghost scheme, not standard Bearer.

The JWT is signed with HS256 using the Admin API key secret after hex decoding it to bytes. The JWT header must include kid set to the Admin API key id. Ghost verifies the aud claim against the requested Admin or Content API path and enforces a maximum token age of 5 minutes.

In: header

Path Parameters

id*string

Query Parameters

include?string

Comma-separated includes. Allowed values are count.posts, count.members, and count.active_members.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

newsletters*array<>

Response Body

`application/json`

curl -X PUT "https://example.com/newsletters/64f0f2c75b8d5b0012345678/?include=count.posts" \  -H "Content-Type: application/json" \  -d '{    "newsletters": [      {}    ]  }'

{
  "newsletters": [
    {
      "id": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "description": "string",
      "feedback_enabled": true,
      "slug": "string",
      "sender_name": "string",
      "sender_email": "string",
      "sender_reply_to": "newsletter",
      "status": "active",
      "visibility": "string",
      "subscribe_on_signup": true,
      "sort_order": 0,
      "header_image": "http://example.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}