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>

GEThttps://hermeticor.com/v1/reports/{id}/products

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/reports/{id}/products" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "productId": "string",
      "title": "string",
      "orders": 0,
      "units": 0,
      "revenueMinor": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem61[]required

Show child parameters

productIdstringrequired

titlestringrequired

ordersintegerrequired

unitsintegerrequired

revenueMinorintegerrequired

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/reports/{id}/products

GEThttps://hermeticor.com/v1/lists/{id}/archive-url

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string"
}

Schema

urlstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

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

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "campaignId": "string",
      "status": "queued",
      "requested": 0,
      "sent": 0,
      "blocked": 0,
      "errors": [
        {
          "recipient": "string",
          "message": "string"
        }
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1CampaignsByIdTriggersResponse[]required

Show child parameters

idstringrequired

campaignIdstringrequired

statusstringrequired

queued | running | complete | failed | cancelled

requestedintegerrequired

sentintegerrequired

blockedintegerrequired

errorsobject[]required

Show child parameters

recipientstringrequired

messagestringrequired

createdAtstringrequired

completedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

POSThttps://hermeticor.com/v1/campaigns/{id}/triggers

Parameters

idstringpathrequired

Request body

application/json

dataobject

= {}

recipientsobject

= {"ids":[],"emails":[],"perRecipient":[]}

Show child parameters

idsstring[]

= []

emailsstring[]

= []

segmentIdstring

perRecipientobject[]

= []

Show child parameters

idstring

emailstring

dataobject

= {}

filterobject

Show child parameters

audienceobject

attributesobject[]

= []

dataFileUrlstring

idIgnoreMissingboolean

= false

{
  "data": {},
  "recipients": {
    "ids": [],
    "emails": [],
    "perRecipient": []
  },
  "dataFileUrl": "string",
  "idIgnoreMissing": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/triggers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{},"recipients":{"ids":[],"emails":[],"perRecipient":[]},"dataFileUrl":"string","idIgnoreMissing":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "id": "string",
  "campaignId": "string",
  "status": "queued",
  "requested": 0,
  "sent": 0,
  "blocked": 0,
  "errors": [
    {
      "recipient": "string",
      "message": "string"
    }
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

campaignIdstringrequired

statusstringrequired

queued | running | complete | failed | cancelled

requestedintegerrequired

sentintegerrequired

blockedintegerrequired

errorsobject[]required

Show child parameters

recipientstringrequired

messagestringrequired

createdAtstringrequired

completedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

GEThttps://hermeticor.com/v1/campaigns/{id}/triggers/{triggerId}

Parameters

idstringpathrequired

triggerIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/campaigns/{id}/triggers

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

POSThttps://hermeticor.com/v1/campaigns/{id}/triggers/{triggerId}/cancel

Parameters

idstringpathrequired

triggerIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/triggers/{triggerId}/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/campaigns/{id}/triggers

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

GEThttps://hermeticor.com/p/v/{token}

Hosted web version of a campaign message

Parameters

tokenstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/v/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

GEThttps://hermeticor.com/p/a/{ref}

Public campaign archive of a list

Parameters

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/a/{ref}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

GEThttps://hermeticor.com/p/a/{ref}/feed.xml

RSS feed of a list campaign archive

Parameters

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/a/{ref}/feed.xml"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

GEThttps://hermeticor.com/p/a/{ref}/archive.json

JSON list of a list campaign archive

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

refstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/p/a/{ref}/archive.json"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "subject": "string",
      "sentAt": "string",
      "url": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

subjectstringrequired

sentAtstringrequired

urlstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

5XX Default Response

Same as 4XX · GET /v1/reports/{id}/products

Next part

Updated Nov 8, 2026

Was this page helpful?