campaigns

Embed

<a href="https://hermeticor.com/docs/ref-campaigns"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/7b5e5778-2701-4b75-820c-3417186ab185/social-card.svg?v=3e7ae33eec8b" alt="campaigns" width="600" height="315"></a>

PUThttps://hermeticor.com/v1/campaigns/{id}/details

Owner, planned start and end dates and notes for a campaign; allowed at any status

Parameters

idstringpathrequired

Request body

application/json

ownerIdstringrequired

startsOnstringrequired

endsOnstringrequired

notesstringrequired

{
  "ownerId": "string",
  "startsOn": "string",
  "endsOn": "string",
  "notes": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/campaigns/{id}/details" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ownerId":"string","startsOn":"string","endsOn":"string","notes":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "ownerId": "string",
  "startsOn": "string",
  "endsOn": "string",
  "notes": "string"
}

Schema

idstringrequired

ownerIdstringrequired

startsOnstringrequired

endsOnstringrequired

notesstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

GEThttps://hermeticor.com/v1/search/campaigns

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

qstringquery

channelstringquery

email | sms | whatsapp | push | postcard

purposestringquery

marketing | prospecting | transactional | operational

folderIdstringquery

tagstringquery

listIdstringquery

fromstringquery

tostringquery

scheduledFromstringquery

scheduledTostringquery

updatedFromstringquery

updatedTostringquery

sentFromstringquery

sentTostringquery

profileIdstringquery

archivedstringquery

true | false

deletedstringquery

true | false

sortstringquery

created | updated | name | scheduled = created

orderstringquery

asc | desc = desc

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/search/campaigns" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "channel": "email",
      "purpose": "marketing",
      "status": "draft",
      "audience": {
        "includeSegmentIds": [],
        "includeListIds": [],
        "excludeSegmentIds": [],
        "excludeListIds": [],
        "onePerCompany": true,
        "everyone": true,
        "includeTags": [
          "string"
        ],
        "excludeTags": [
          "string"
        ]
      },
      "audienceFrozenAt": "2024-01-01T00:00:00Z",
      "templateId": "string",
      "topicId": "string",
      "route": {
        "connectionId": "string",
        "poolId": "string",
        "routePolicyId": "string"
      },
      "schedule": {
        "at": "2024-01-01T00:00:00Z",
        "tz": "UTC",
        "recipientLocal": false,
        "throttlePerHour": 0,
        "window": {
          "startMin": 0,
          "endMin": 0
        },
        "sendTime": "fixed",
        "pastZones": "immediately",
        "batchSize": 0
      },
      "abTest": {
        "testPercent": 20,
        "metric": "clicks",
        "waitHours": 4,
        "auto": true,
        "method": "bayesian_beta"
      },
      "variants": [
        {
          "key": "string",
          "templateVersionId": "string",
          "subject": "string",
          "fromName": "string",
          "previewText": "string",
          "replyTo": "string",
          "imageAssetId": "string",
          "sendOffset": 0,
          "weight": 1
        }
      ],
      "utm": {},
      "tracking": {
        "opens": true,
        "clicks": true
      },
      "autoPause": {
        "enabled": true,
        "maxFailureRate": 0.25,
        "maxBounceRate": 0.1,
        "minSample": 50
      },
      "slug": "string",
      "archiveProfile": {},
      "inArchive": true,
      "ownerId": "string",
      "startsOn": "string",
      "endsOn": "string",
      "notes": "string",
      "approvalStatus": "string",
      "approvedBy": "string",
      "approvalSubmittedBy": "string",
      "approvalComment": "string",
      "startedAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z",
      "testSentAt": "2024-01-01T00:00:00Z",
      "contentErasedAt": "2024-01-01T00:00:00Z",
      "stats": {},
      "archivedAt": "2024-01-01T00:00:00Z",
      "parentCampaignId": "string",
      "reviewDrafts": true,
      "reviewDeadline": {
        "hours": 0,
        "action": "send"
      },
      "failureReason": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "folderId": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

statusstringrequired

audienceobjectrequired

Show child parameters

includeSegmentIdsstring[]required

= []

includeListIdsstring[]required

= []

excludeSegmentIdsstring[]required

= []

excludeListIdsstring[]required

= []

onePerCompanyboolean

everyoneboolean

includeTagsstring[]

excludeTagsstring[]

audienceFrozenAtstringrequired

templateIdstringrequired

topicIdstringrequired

routeobjectrequired

Show child parameters

connectionIdstring

poolIdstring

routePolicyIdstring

scheduleobjectrequired

Show child parameters

atstringrequired

tzstringrequired

= UTC

recipientLocalbooleanrequired

= false

throttlePerHourinteger

windowobject

sendTimestringrequired

fixed | optimized = fixed

pastZonesstring

immediately | tomorrow

batchSizeinteger

abTestobjectrequired

Show child parameters

testPercentintegerrequired

= 20

metricstringrequired

clicks | replies | conversions | revenue | opens = clicks

waitHoursintegerrequired

= 4

autobooleanrequired

= true

methodstringrequired

bayesian_beta | frequentist_ztest = bayesian_beta

variantsVariantsItem[]

Show child parameters

keystringrequired

templateVersionIdstringrequired

subjectstring

fromNamestring

previewTextstring

replyTostring

imageAssetIdstring

sendOffsetintegerrequired

= 0

weightintegerrequired

= 1

utmobjectrequired

trackingobjectrequired

Show child parameters

opensboolean

clicksboolean

autoPauseobjectrequired

Show child parameters

enabledbooleanrequired

= true

maxFailureRatenumberrequired

= 0.25

maxBounceRatenumberrequired

= 0.1

minSampleintegerrequired

= 50

slugstringrequired

archiveProfileobjectrequired

inArchivebooleanrequired

ownerIdstring

startsOnstring

endsOnstring

notesstring

approvalStatusstringrequired

approvedBystringrequired

approvalSubmittedBystring

approvalCommentstring

startedAtstringrequired

completedAtstringrequired

testSentAtstringrequired

contentErasedAtstring

statsobjectrequired

archivedAtstring

parentCampaignIdstring

reviewDraftsboolean

reviewDeadlineobject

Show child parameters

hoursintegerrequired

actionstringrequired

send | skip

failureReasonstring

createdAtstringrequired

updatedAtstringrequired

folderIdstring

tagsstring[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

GEThttps://hermeticor.com/v1/campaigns/{id}/tags

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/campaigns/{id}/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tags": [
    "string"
  ]
}

Schema

tagsstring[]required

4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

PUThttps://hermeticor.com/v1/campaigns/{id}/tags

Parameters

idstringpathrequired

Request body

application/json

tagsstring[]required

{
  "tags": [
    "string"
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/campaigns/{id}/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/campaigns/{id}/tags

4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

GEThttps://hermeticor.com/v1/campaigns/{id}/messages

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/campaigns/{id}/messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "campaignId": "string",
      "position": 0,
      "channel": "email",
      "label": "string",
      "subject": "string",
      "previewText": "string",
      "fromName": "string",
      "replyTo": "string",
      "templateId": "string",
      "templateVersionId": "string",
      "imageAssetId": "string",
      "renderOptions": {},
      "sendAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem58[]required

Show child parameters

idstringrequired

campaignIdstringrequired

positionintegerrequired

channelstringrequired

email | sms | whatsapp | push | postcard

labelstringrequired

subjectstringrequired

previewTextstringrequired

fromNamestringrequired

replyTostringrequired

templateIdstringrequired

templateVersionIdstringrequired

imageAssetIdstringrequired

renderOptionsobjectrequired

sendAtstring

nextCursorstringrequired

4XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

5XX Default Response

Same as 4XX · PUT /v1/campaigns/{id}/details

Next part

Updated Nov 8, 2026

Was this page helpful?