Other endpoints

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-other-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9b8b485e-df2a-4959-8c16-36d30bd083b0/social-card.svg?v=3e7ae33eec8b" alt="Other endpoints" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/compliance/retention

Parameters

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/compliance/retention" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "dataClass": "string",
      "retainDays": 0,
      "isDefault": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem100[]required
Show child parameters
dataClassstringrequired
retainDaysnumberrequired
isDefaultbooleanrequired
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/compliance/retention

PUThttps://hermeticor.com/v1/compliance/retention/{dataClass}

Parameters

dataClassstringpathrequired

Request body

application/json
retainDaysinteger | stringrequired
{
  "retainDays": 0
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/compliance/retention/{dataClass}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"retainDays":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "dataClass": "string",
      "retainDays": 0,
      "isDefault": true
    }
  ]
}
Schema
itemsItemsItem100[]required
Show child parameters
dataClassstringrequired
retainDaysnumberrequired
isDefaultbooleanrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

GEThttps://hermeticor.com/v1/compliance/unsubscribe-purge

Days after which an unsubscribed contact is erased (null = never)

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/compliance/unsubscribe-purge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "days": 0,
  "seconds": 0
}
Schema
daysintegerrequired
secondsinteger
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

PUThttps://hermeticor.com/v1/compliance/unsubscribe-purge

GDPR auto-purge: erase contacts N days after they unsubscribed (their address stays suppressed)

Request body

application/json
daysinteger
secondsinteger
{
  "days": 0,
  "seconds": 0
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/compliance/unsubscribe-purge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":0,"seconds":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/unsubscribe-purge

4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

GEThttps://hermeticor.com/v1/compliance/orphan-purge

Days after which a contact with no list, message or consent history is erased (null = never)

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/compliance/orphan-purge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "days": 0
}
Schema
daysintegerrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

PUThttps://hermeticor.com/v1/compliance/orphan-purge

Clean up contacts that never joined a list, got a message or gave consent

Request body

application/json
daysintegerrequired
{
  "days": 0
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/compliance/orphan-purge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/orphan-purge

4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

POSThttps://hermeticor.com/v1/profiles/{id}/dsar/export

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/profiles/{id}/dsar/export" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "requestId": "string",
  "exportedAt": "string"
}
Schema
requestIdstringrequired
exportedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

POSThttps://hermeticor.com/v1/profiles/{id}/dsar/erase

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/profiles/{id}/dsar/erase" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "requestId": "string",
  "tombstones": 0,
  "counts": {}
}
Schema
requestIdstringrequired
tombstonesnumberrequired
countsobjectrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

POSThttps://hermeticor.com/v1/workspaces/current/reset

Owner only: delete the chosen data (contacts, events, messages, campaigns, journeys) and keep settings, members, keys, connections, templates and suppressions. Audited.

Request body

application/json
confirmNamestringrequired
datasetsstring[]required
{
  "confirmName": "string",
  "datasets": [
    "contacts"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/workspaces/current/reset" \
  -H "Content-Type: application/json" \
  -d '{"confirmName":"string","datasets":["contacts"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "id": "string",
  "datasets": [
    "string"
  ],
  "status": "queued",
  "counts": {},
  "error": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
datasetsstring[]required
statusstringrequired
queued | running | completed | failed
countsobjectrequired
errorstringrequired
createdAtstringrequired
finishedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

GEThttps://hermeticor.com/v1/workspaces/current/resets

Parameters

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/workspaces/current/resets" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "datasets": [
        "string"
      ],
      "status": "queued",
      "counts": {},
      "error": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "finishedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1WorkspacesCurrentResetResponse[]required
Show child parameters
idstringrequired
datasetsstring[]required
statusstringrequired
queued | running | completed | failed
countsobjectrequired
errorstringrequired
createdAtstringrequired
finishedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

GEThttps://hermeticor.com/v1/workspaces/current/resets/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/workspaces/current/resets/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 202 · POST /v1/workspaces/current/reset

4XX Default Response

Same as 4XX · GET /v1/compliance/retention

5XX Default Response

Same as 4XX · GET /v1/compliance/retention

Updated