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

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "campaignId": "string",
      "name": "string",
      "priority": 0,
      "definition": {
        "includeSegmentIds": [],
        "includeListIds": [],
        "excludeSegmentIds": [],
        "excludeListIds": [],
        "onePerCompany": true,
        "everyone": true,
        "includeTags": [
          "string"
        ],
        "excludeTags": [
          "string"
        ]
      },
      "messageIds": [
        "string"
      ],
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem223[]required

Show child parameters

idstringrequired

campaignIdstringrequired

namestringrequired

priorityintegerrequired

definitionobjectrequired

Show child parameters

includeSegmentIdsstring[]required

= []

includeListIdsstring[]required

= []

excludeSegmentIdsstring[]required

= []

excludeListIdsstring[]required

= []

onePerCompanyboolean

everyoneboolean

includeTagsstring[]

excludeTagsstring[]

messageIdsstring[]required

createdAtstringrequired

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

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

Parameters

idstringpathrequired

Request body

application/json

namestringrequired

priorityinteger

= 0

definitionobjectrequired

Show child parameters

includeSegmentIdsstring[]

= []

includeListIdsstring[]

= []

excludeSegmentIdsstring[]

= []

excludeListIdsstring[]

= []

onePerCompanyboolean

everyoneboolean

includeTagsstring[]

excludeTagsstring[]

messageIdsstring[]

= []

{
  "name": "string",
  "priority": 0,
  "definition": {
    "includeSegmentIds": [],
    "includeListIds": [],
    "excludeSegmentIds": [],
    "excludeListIds": [],
    "onePerCompany": true,
    "everyone": true,
    "includeTags": [
      "string"
    ],
    "excludeTags": [
      "string"
    ]
  },
  "messageIds": []
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/audiences" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","priority":0,"definition":{"includeSegmentIds":[],"includeListIds":[],"excludeSegmentIds":[],"excludeListIds":[],"onePerCompany":true,"everyone":true,"includeTags":["string"],"excludeTags":["string"]},"messageIds":[]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "campaignId": "string",
  "name": "string",
  "priority": 0,
  "definition": {
    "includeSegmentIds": [],
    "includeListIds": [],
    "excludeSegmentIds": [],
    "excludeListIds": [],
    "onePerCompany": true,
    "everyone": true,
    "includeTags": [
      "string"
    ],
    "excludeTags": [
      "string"
    ]
  },
  "messageIds": [
    "string"
  ],
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

campaignIdstringrequired

namestringrequired

priorityintegerrequired

definitionobjectrequired

Show child parameters

includeSegmentIdsstring[]required

= []

includeListIdsstring[]required

= []

excludeSegmentIdsstring[]required

= []

excludeListIdsstring[]required

= []

onePerCompanyboolean

everyoneboolean

includeTagsstring[]

excludeTagsstring[]

messageIdsstring[]required

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/campaigns/{id}/audiences/{audienceId}

Parameters

idstringpathrequired

audienceIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/campaigns/{id}/audiences

4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/campaigns/{id}/audiences/{audienceId}

Parameters

idstringpathrequired

audienceIdstringpathrequired

Code samples

cURL

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

5XX Default Response

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

PATCHhttps://hermeticor.com/v1/campaigns/{id}/audiences/{audienceId}

Parameters

idstringpathrequired

audienceIdstringpathrequired

Request body

application/json

namestring

priorityinteger

definitionobject

Show child parameters

includeSegmentIdsstring[]

= []

includeListIdsstring[]

= []

excludeSegmentIdsstring[]

= []

excludeListIdsstring[]

= []

onePerCompanyboolean

everyoneboolean

includeTagsstring[]

excludeTagsstring[]

messageIdsstring[]

{
  "name": "string",
  "priority": 0,
  "definition": {
    "includeSegmentIds": [],
    "includeListIds": [],
    "excludeSegmentIds": [],
    "excludeListIds": [],
    "onePerCompany": true,
    "everyone": true,
    "includeTags": [
      "string"
    ],
    "excludeTags": [
      "string"
    ]
  },
  "messageIds": [
    "string"
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/campaigns/{id}/audiences/{audienceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","priority":0,"definition":{"includeSegmentIds":[],"includeListIds":[],"excludeSegmentIds":[],"excludeListIds":[],"onePerCompany":true,"everyone":true,"includeTags":["string"],"excludeTags":["string"]},"messageIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/campaigns/{id}/audiences

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/campaigns/{id}/audiences/{audienceId}/clone

Parameters

idstringpathrequired

audienceIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 201 · POST /v1/campaigns/{id}/audiences

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/campaigns/{id}/recipient-estimations/latest

The most recent recipient estimation of this campaign

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "campaignId": "string",
  "status": "queued",
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "result": {
    "audience": 0,
    "suppressed": 0,
    "unconsented": 0,
    "estimated": 0,
    "included": 0,
    "excludedBy": [
      {
        "kind": "segment",
        "id": "string",
        "removed": 0
      }
    ],
    "reasons": {}
  }
}

Schema

idstringrequired

campaignIdstringrequired

statusstringrequired

queued | complete | failed

createdAtstringrequired

completedAtstringrequired

resultobjectrequired

Show child parameters

audiencenumberrequired

suppressednumberrequired

unconsentednumberrequired

estimatednumberrequired

includednumber

excludedByExcludedByItem[]

Show child parameters

kindstringrequired

segment | list | tag

idstringrequired

removednumberrequired

reasonsobject

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?