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}/rss

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "campaignId": "string",
  "feedUrl": "string",
  "everyHours": 0,
  "active": true,
  "lastGuid": "string",
  "lastCheckedAt": "2024-01-01T00:00:00Z"
}

Schema

campaignIdstringrequired

feedUrlstringrequired

everyHoursnumberrequired

activebooleanrequired

lastGuidstringrequired

lastCheckedAtstringrequired

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}/rss

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

Parameters

idstringpathrequired

Request body

application/json

feedUrlstringrequired

everyHoursinteger

= 24

activeboolean

= true

{
  "feedUrl": "string",
  "everyHours": 24,
  "active": true
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/campaigns/{id}/rss" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"feedUrl":"string","everyHours":24,"active":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/campaigns/{id}/rss/pause

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/campaigns/{id}/rss/resume

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

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

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}/variants" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

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

5XX Default Response

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

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

Parameters

idstringpathrequired

keystringpathrequired

Code samples

cURL

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

TypeScript

Python

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

5XX Default Response

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

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

Parameters

idstringpathrequired

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}/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

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/campaigns/{id}/variants/{key}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

keystringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/campaigns/{id}/variants/{key}" \
  -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}/rss

5XX Default Response

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

POSThttps://hermeticor.com/v1/campaigns/{id}/send-report

Parameters

idstringpathrequired

Request body

application/json

emailsstring[]

= []

phonesstring[]

= []

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

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/send-report" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[],"phones":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sent": 0,
  "blocked": 0
}

Schema

sentintegerrequired

blockedintegerrequired

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "webVersionUrl": "string",
  "expiresAt": "string"
}

Schema

urlstringrequired

webVersionUrlstringrequired

expiresAtstringrequired

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?