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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "status": "string",
  "startedAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "recipients": 0,
  "byStatus": {}
}

Schema

idstringrequired

statusstringrequired

startedAtstringrequired

completedAtstringrequired

recipientsintegerrequired

byStatusobjectrequired

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

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

Parameters

limitintegerquery

= 50

cursorstringquery

statusstringquery

engagedstringquery

opened | clicked | unsubscribed | bounced | complained

qstringquery

linkUrlstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "destination": "string",
      "status": "string",
      "sentAt": "2024-01-01T00:00:00Z",
      "opens": 0,
      "clicks": 0,
      "unsubscribed": true,
      "bounced": true,
      "complained": true,
      "lastActivityAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

destinationstringrequired

statusstringrequired

sentAtstringrequired

opensintegerrequired

clicksintegerrequired

unsubscribedbooleanrequired

bouncedbooleanrequired

complainedbooleanrequired

lastActivityAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

GEThttps://hermeticor.com/v1/campaigns/{id}/recipients.csv

Parameters

statusstringquery

engagedstringquery

opened | clicked | unsubscribed | bounced | complained

qstringquery

linkUrlstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

GEThttps://hermeticor.com/v1/campaigns/{id}/recipients/{profileId}/activity

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "kind": "string",
      "url": "string",
      "at": "2024-01-01T00:00:00Z",
      "isMachine": true
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

kindstringrequired

urlstringrequired

atstringrequired

isMachinebooleanrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

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

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "campaignId": "string",
      "parentId": "string",
      "authorId": "string",
      "body": "string",
      "resolved": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem59[]required

Show child parameters

idstringrequired

campaignIdstringrequired

parentIdstringrequired

authorIdstringrequired

bodystringrequired

resolvedbooleanrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

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

Parameters

idstringpathrequired

Request body

application/json

bodystringrequired

parentIdstring

{
  "body": "string",
  "parentId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/campaigns/{id}/feedback" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","parentId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "campaignId": "string",
  "parentId": "string",
  "authorId": "string",
  "body": "string",
  "resolved": true,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

campaignIdstringrequired

parentIdstringrequired

authorIdstringrequired

bodystringrequired

resolvedbooleanrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

GEThttps://hermeticor.com/v1/campaigns/{id}/feedback/{feedbackId}

Parameters

idstringpathrequired

feedbackIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

DELETEhttps://hermeticor.com/v1/campaigns/{id}/feedback/{feedbackId}

Parameters

idstringpathrequired

feedbackIdstringpathrequired

Code samples

cURL

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

5XX Default Response

Same as 4XX · GET /v1/campaigns/{id}/send-job

PATCHhttps://hermeticor.com/v1/campaigns/{id}/feedback/{feedbackId}

Parameters

idstringpathrequired

feedbackIdstringpathrequired

Request body

application/json

bodystring

resolvedboolean

{
  "body": "string",
  "resolved": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/campaigns/{id}/feedback/{feedbackId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","resolved":true}'

TypeScript

Python

PHP

Ruby

Java