Update Campaign

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

Update an existing campaign

• Campaigns in LAUNCHED / COMPLETED / FAILED status is not allowed to update

Request

Path Parameters

id uuidrequired

ID of the campaign to update

application/json

Body

required

contentSourceUrl string
campaign object
name string
subject string
previewText string
senderId uuid
template object
html string
contactIds string[]
schedule object
dateTime string
days string[]
time 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' \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>' \
--data-raw '{
  "contentSourceUrl": "https://app.tinyemail.com/api/v1/content.json",
  "campaign": {
    "name": "Black Friday Campaign",
    "subject": "Black Friday Offer",
    "previewText": "Offer!"
  },
  "senderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "template": {
    "html": ""
  },
  "contactIds": [
    [
      "2b4ea4a6-1fa3-4863-87e7-f498376d68",
      "b85a7177-b94b-43de-a8cd-03713c91b"
    ]
  ],
  "schedule": {
    "dateTime": "2024-12-05T13:15:00.00Z",
    "days": [
      [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ]
    ],
    "time": "03:00:00"
  }
}'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Parameters

id — pathrequired

Body required

{
  "contentSourceUrl": "https://app.tinyemail.com/api/v1/content.json",
  "campaign": {
    "name": "Black Friday Campaign",
    "subject": "Black Friday Offer",
    "previewText": "Offer!"
  },
  "senderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "template": {
    "html": ""
  },
  "contactIds": [
    [
      "2b4ea4a6-1fa3-4863-87e7-f498376d68",
      "b85a7177-b94b-43de-a8cd-03713c91b"
    ]
  ],
  "schedule": {
    "dateTime": "2024-12-05T13:15:00.00Z",
    "days": [
      [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY",
        "THURSDAY",
        "FRIDAY",
        "SATURDAY",
        "SUNDAY"
      ]
    ],
    "time": "03:00:00"
  }
}

ResponseClear

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