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/campaigns/{id}/insights

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "timeline": [
    {
      "hour": 0,
      "opens": 0,
      "clicks": 0,
      "unsubscribes": 0
    }
  ],
  "links": [
    {
      "url": "string",
      "total": 0,
      "unique": 0
    }
  ],
  "domains": [
    {
      "group": "gmail",
      "sent": 0,
      "opened": 0,
      "clicked": 0
    }
  ],
  "devices": [
    {
      "device": "mobile",
      "opens": 0,
      "clicks": 0
    }
  ],
  "machineEvents": 0,
  "problems": {
    "unsubscribes": 0,
    "complaints": 0,
    "bounces": 0
  },
  "revenue": {
    "orders": 0,
    "revenueMinor": 0
  }
}

Schema

timelineobject[]required

Show child parameters

hourintegerrequired

opensintegerrequired

clicksintegerrequired

unsubscribesintegerrequired

linksLinksItem[]required

Show child parameters

urlstringrequired

totalintegerrequired

uniqueintegerrequired

domainsobject[]required

Show child parameters

groupstringrequired

gmail | outlook | yahoo | icloud | other

sentintegerrequired

openedintegerrequired

clickedintegerrequired

devicesobject[]required

Show child parameters

devicestringrequired

mobile | desktop | webmail | unknown

opensintegerrequired

clicksintegerrequired

machineEventsintegerrequired

problemsobjectrequired

Show child parameters

unsubscribesintegerrequired

complaintsintegerrequired

bouncesintegerrequired

revenueobjectrequired

Show child parameters

ordersintegerrequired

revenueMinorintegerrequired

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/campaigns/{id}/insights

GEThttps://hermeticor.com/v1/calendar

Parameters

fromstringqueryrequired

tostringqueryrequired

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/calendar?from=<from>&to=<to>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "kind": "campaign",
      "id": "string",
      "name": "string",
      "channel": "email",
      "status": "string",
      "at": "2024-01-01T00:00:00Z",
      "endAt": "2024-01-01T00:00:00Z",
      "endEstimated": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

kindstringrequired

campaign | workflow

idstringrequired

namestringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

statusstringrequired

atstringrequired

endAtstringrequired

endEstimatedbooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

GEThttps://hermeticor.com/v1/seed-lists

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem55[]required

Show child parameters

idstringrequired

namestringrequired

emailsstring[]required

phonesstring[]required

createdAtstringrequired

updatedAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

POSThttps://hermeticor.com/v1/seed-lists

Request body

application/json

namestringrequired

emailsstring[]

= []

phonesstring[]

= []

{
  "name": "string",
  "emails": [],
  "phones": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/seed-lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","emails":[],"phones":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "emails": [
    "string"
  ],
  "phones": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

emailsstring[]required

phonesstring[]required

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/seed-lists

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

PUThttps://hermeticor.com/v1/seed-lists/{id}

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

emailsstring[]

= []

phonesstring[]

= []

{
  "name": "string",
  "emails": [],
  "phones": []
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/seed-lists/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","emails":[],"phones":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/seed-lists

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

DELETEhttps://hermeticor.com/v1/seed-lists/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

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

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "campaignId": "string",
      "reason": "string",
      "createdBy": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "messages": 0,
      "templateId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem56[]required

Show child parameters

idstringrequired

campaignIdstringrequired

reasonstringrequired

createdBystringrequired

createdAtstringrequired

messagesintegerrequired

templateIdstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

POSThttps://hermeticor.com/v1/campaigns/{id}/revisions/{revisionId}/restore

Parameters

idstringpathrequired

revisionIdstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/revisions/{revisionId}/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/seed-lists/{id}

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/insights

Next part

Updated Nov 8, 2026

Was this page helpful?