campaigns

Embed
Preview of the card
<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>
GEThttps://hermeticor.com/v1/campaign-messages

Every campaign message in the workspace, filtered by campaign, channel, status, text and updated time

Parameters

limitintegerquery
= 50
cursorstringquery
campaignIdstringquery
channelstringquery
email | sms | whatsapp | push | postcard
campaignStatusstringquery
draft | scheduled | sending | paused | completed | cancelled | failed
qstringquery
updatedFromstringquery
updatedTostringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/campaign-messages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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",
      "campaignName": "string",
      "campaignStatus": "string",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
campaignIdstringrequired
positionintegerrequired
channelstringrequired
email | sms | whatsapp | push | postcard
labelstringrequired
subjectstringrequired
previewTextstringrequired
fromNamestringrequired
replyTostringrequired
templateIdstringrequired
templateVersionIdstringrequired
imageAssetIdstringrequired
renderOptionsobjectrequired
sendAtstring
campaignNamestringrequired
campaignStatusstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/campaign-messages

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

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired
messageIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/campaigns/{id}/messages/{messageId}/variants" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "string",
      "templateVersionId": "string",
      "subject": "string",
      "fromName": "string",
      "previewText": "string",
      "replyTo": "string",
      "imageAssetId": "string",
      "sendOffset": 0,
      "weight": 0
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem60[]required
Show child parameters
keystringrequired
templateVersionIdstringrequired
subjectstringrequired
fromNamestringrequired
previewTextstringrequired
replyTostringrequired
imageAssetIdstringrequired
sendOffsetintegerrequired
weightintegerrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/campaign-messages

5XX Default Response

Same as 4XX · GET /v1/campaign-messages

PUThttps://hermeticor.com/v1/campaigns/{id}/messages/{messageId}/variants/{key}

Parameters

idstringpathrequired
messageIdstringpathrequired
keystringpathrequired

Request body

application/json
templateVersionIdstringrequired
subjectstring
fromNamestring
previewTextstring
replyTostring
imageAssetIdstring
sendOffsetinteger
= 0
weightinteger
= 1
{
  "templateVersionId": "string",
  "subject": "string",
  "fromName": "string",
  "previewText": "string",
  "replyTo": "string",
  "imageAssetId": "string",
  "sendOffset": 0,
  "weight": 1
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/campaigns/{id}/messages/{messageId}/variants/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateVersionId":"string","subject":"string","fromName":"string","previewText":"string","replyTo":"string","imageAssetId":"string","sendOffset":0,"weight":1}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "key": "string",
  "templateVersionId": "string",
  "subject": "string",
  "fromName": "string",
  "previewText": "string",
  "replyTo": "string",
  "imageAssetId": "string",
  "sendOffset": 0,
  "weight": 0
}
Schema
keystringrequired
templateVersionIdstringrequired
subjectstringrequired
fromNamestringrequired
previewTextstringrequired
replyTostringrequired
imageAssetIdstringrequired
sendOffsetintegerrequired
weightintegerrequired
4XX Default Response

Same as 4XX · GET /v1/campaign-messages

5XX Default Response

Same as 4XX · GET /v1/campaign-messages

DELETEhttps://hermeticor.com/v1/campaigns/{id}/messages/{messageId}/variants/{key}

Parameters

idstringpathrequired
messageIdstringpathrequired
keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/campaigns/{id}/messages/{messageId}/variants/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/campaign-messages

5XX Default Response

Same as 4XX · GET /v1/campaign-messages

POSThttps://hermeticor.com/v1/campaigns/{id}/variants/grid

Multivariate test: one variant per combination of templates, subjects, from names and preview texts

Parameters

idstringpathrequired

Request body

application/json
templateVersionIdsstring[]
= []
subjectsstring[]
= []
fromNamesstring[]
= []
previewTextsstring[]
= []
baseTemplateVersionIdstringrequired
{
  "templateVersionIds": [],
  "subjects": [],
  "fromNames": [],
  "previewTexts": [],
  "baseTemplateVersionId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/campaigns/{id}/variants/grid" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"templateVersionIds":[],"subjects":[],"fromNames":[],"previewTexts":[],"baseTemplateVersionId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "combinations": 0,
  "variants": [
    {
      "key": "string",
      "templateVersionId": "string",
      "subject": "string",
      "fromName": "string",
      "previewText": "string"
    }
  ]
}
Schema
combinationsintegerrequired
variantsobject[]required
Show child parameters
keystringrequired
templateVersionIdstringrequired
subjectstringrequired
fromNamestringrequired
previewTextstringrequired
4XX Default Response

Same as 4XX · GET /v1/campaign-messages

5XX Default Response

Same as 4XX · GET /v1/campaign-messages

Updated