DocsAPI ReferenceNewsletter/bff/newsletter/job-run-action
postNewsletterAdmin BFF

/bff/newsletter/job-run-action

Executes a control action (start, pause, resume, cancel) on a newsletter sending job.

NewsletterpostBffNewsletterJob-run-action

Parameters

2 body

2 total
Body · 2
idstringRequired

Newsletter job ID.

actionstringRequired

Action to run: start, pause, resume, cancel.

Request

POST /bff/newsletter/job-run-action

post
curl -X POST "https://api.bizkithub.com/bff/newsletter/job-run-action" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id",
  "action": "start"
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key