Start Campaign

PUT 
https://api.tinyemail.com/v1/campaign/:id/start

Start a campaign

• Only DRAFT/PAUSED campaign can be started

Request

Path Parameters

id uuidrequired

ID of the campaign to start

application/json

Body

schedule object
dateTime string

Responses

204

Successful operation

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X PUT 'https://api.tinyemail.com/v1/campaign/:id/start' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>' \
--data-raw '{
  "schedule": {
    "dateTime": "2024-12-05T13:15:00.00Z"
  }
}'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Parameters

id — pathrequired

Body

{
  "schedule": {
    "dateTime": "2024-12-05T13:15:00.00Z"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!