Skip to main content
PUT
This endpoint requires authentication and the updateNewsletter permission.

Path Parameters

string
required
The UUID of the newsletter to update

Request Body

string
Newsletter title
string
Newsletter content
string
ID of the uploaded image file
string
External image URL if not using uploaded file
string
ID of the uploaded PDF file
string
External PDF URL if not using uploaded file
string
Newsletter status. One of: draft, scheduled, published, archived
string
Scheduled publication date (ISO 8601)

Response

string
Unique identifier for the newsletter (UUID)
string
Newsletter title
string
Newsletter content
object
Uploaded image file information
string
External image URL if not using uploaded file
object
Uploaded PDF file information
string
External PDF URL if not using uploaded file
boolean
Whether the newsletter has an associated PDF
string
Newsletter status. One of: draft, scheduled, published, archived
string
Scheduled or actual publication date (ISO 8601)
integer
Number of times the newsletter has been viewed/received
string
Creation timestamp (ISO 8601)
string
Last update timestamp (ISO 8601)
string
UUID of the user who created the newsletter

Error Responses

object
Error details when the request fails
Common error cases:
  • 400 Bad Request: Invalid newsletter ID format or validation error
  • 401 Unauthorized: Missing or invalid access token
  • 403 Forbidden: Missing required permission
  • 404 Not Found: Newsletter not found