imports

Embed

<a href="https://hermeticor.com/docs/ref-imports"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/2733675a-1b97-4143-b0af-37608a251ed5/social-card.svg?v=3e7ae33eec8b" alt="imports" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/profiles/duplicates

Suggested duplicate groups (Gmail aliases, same name and city). Suggestions only: merge through POST /v1/profiles/:id/merge.

Parameters

limitintegerquery

= 50

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "rule": "email_alias",
      "confidence": "high",
      "suggestedSurvivorId": "string",
      "profiles": [
        {
          "id": "string",
          "email": "string",
          "phone": "string",
          "name": "string",
          "city": "string",
          "createdAt": "2024-01-01T00:00:00Z"
        }
      ]
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

rulestringrequired

email_alias | same_name_city

confidencestringrequired

high | medium

suggestedSurvivorIdstringrequired

profilesobject[]required

Show child parameters

idstringrequired

emailstringrequired

phonestringrequired

namestringrequired

citystringrequired

createdAtstringrequired

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/profiles/duplicates

GEThttps://hermeticor.com/v1/import-mapping-templates

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/import-mapping-templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsItemsItem52[]required

Show child parameters

idstringrequired

namestringrequired

mappingobjectrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

POSThttps://hermeticor.com/v1/import-mapping-templates

Save (or replace, by name) a column mapping for reuse in later imports

Request body

application/json

namestringrequired

mappingobjectrequired

{
  "name": "string",
  "mapping": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/import-mapping-templates" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","mapping":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "mapping": {},
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

mappingobjectrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

DELETEhttps://hermeticor.com/v1/import-mapping-templates/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/import-mapping-templates/{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/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

GEThttps://hermeticor.com/v1/import-schedules

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "frequency": "daily",
      "enabled": true,
      "listId": "string",
      "tags": [
        "string"
      ],
      "lastRunAt": "2024-01-01T00:00:00Z",
      "lastImportId": "string",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem53[]required

Show child parameters

idstringrequired

namestringrequired

urlstringrequired

frequencystringrequired

daily | weekly

enabledbooleanrequired

listIdstringrequired

tagsstring[]required

lastRunAtstringrequired

lastImportIdstringrequired

lastErrorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

POSThttps://hermeticor.com/v1/import-schedules

Import a CSV from an https URL daily or weekly

Request body

application/json

namestringrequired

urlstringrequired

frequencystringrequired

daily | weekly

metaobjectrequired

Show child parameters

mappingobjectrequired

listIdstring

tagsstring[]

= []

consentAssertionobject

Show child parameters

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

sourceTextstringrequired

attestedBystringrequired

verifyEmailboolean

= false

defaultCountrystring

delimiterstring

, | ; | | |

listIdsstring[]

= []

updateExistingboolean

= true

topicIdstring

{
  "name": "string",
  "url": "string",
  "frequency": "daily",
  "meta": {
    "mapping": {},
    "listId": "string",
    "tags": [],
    "consentAssertion": {
      "channel": "email",
      "purpose": "marketing",
      "sourceText": "string",
      "attestedBy": "string"
    },
    "verifyEmail": false,
    "defaultCountry": "string",
    "delimiter": ",",
    "listIds": [],
    "updateExisting": true,
    "topicId": "string"
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/import-schedules" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","url":"string","frequency":"daily","meta":{"mapping":{},"listId":"string","tags":[],"consentAssertion":{"channel":"email","purpose":"marketing","sourceText":"string","attestedBy":"string"},"verifyEmail":false,"defaultCountry":"string","delimiter":",","listIds":[],"updateExisting":true,"topicId":"string"}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "url": "string",
  "frequency": "daily",
  "enabled": true,
  "listId": "string",
  "tags": [
    "string"
  ],
  "lastRunAt": "2024-01-01T00:00:00Z",
  "lastImportId": "string",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

urlstringrequired

frequencystringrequired

daily | weekly

enabledbooleanrequired

listIdstringrequired

tagsstring[]required

lastRunAtstringrequired

lastImportIdstringrequired

lastErrorstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

DELETEhttps://hermeticor.com/v1/import-schedules/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/import-mapping-templates/{id}

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

PATCHhttps://hermeticor.com/v1/import-schedules/{id}

Parameters

idstringpathrequired

Request body

application/json

enabledbooleanrequired

{
  "enabled": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/import-schedules/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/import-schedules

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

POSThttps://hermeticor.com/v1/import-schedules/{id}/run

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/import-schedules/{id}/run" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "queued": true
}

Schema

queuedbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

5XX Default Response

Same as 4XX · GET /v1/profiles/duplicates

Next part

Updated Nov 8, 2026

Was this page helpful?