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>

POSThttps://hermeticor.com/v1/imports/{id}/cancel

Stop an import that has not finished (a running one stops at its next batch)

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "filename": "string",
  "status": "uploaded",
  "mapping": {},
  "listId": "string",
  "tags": [
    "string"
  ],
  "consentAssertion": {
    "channel": "email",
    "purpose": "marketing",
    "sourceText": "string",
    "attestedBy": "string"
  },
  "verifyEmail": true,
  "listIds": [],
  "updateExisting": true,
  "topicId": null,
  "stats": {
    "total": 0,
    "created": 0,
    "updated": 0,
    "errors": 0,
    "suppressed": 0,
    "consentSkipped": 0,
    "consentGranted": 0,
    "skipped": 0,
    "blocked": 0,
    "topicSubscribed": 0,
    "topicUnsubscribed": 0
  },
  "progress": {
    "rowsRead": 0,
    "processed": 0,
    "errors": 0
  },
  "error": "string",
  "errorsUrl": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "finishedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

filenamestringrequired

statusstringrequired

mappingobjectrequired

listIdstringrequired

tagsstring[]required

consentAssertionobjectrequired

Show child parameters

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

sourceTextstringrequired

attestedBystringrequired

verifyEmailbooleanrequired

listIdsstring[]required

= []

updateExistingbooleanrequired

= true

topicIdstringrequired

= null

statsobjectrequired

Show child parameters

totalintegerrequired

createdintegerrequired

updatedintegerrequired

errorsintegerrequired

suppressedintegerrequired

consentSkippedintegerrequired

consentGrantedintegerrequired

skippedintegerrequired

= 0

blockedintegerrequired

= 0

topicSubscribedintegerrequired

= 0

topicUnsubscribedintegerrequired

= 0

progressobjectrequired

Show child parameters

rowsReadintegerrequired

processedintegerrequired

errorsintegerrequired

errorstringrequired

errorsUrlstring

createdAtstringrequired

finishedAtstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

POSThttps://hermeticor.com/v1/imports/{id}/rollback

Undo a completed import within 7 days: deletes the profiles it created

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/imports/{id}/cancel

4XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

5XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

POSThttps://hermeticor.com/v1/imports/json

Bulk-import up to 10,000 profiles as JSON: runs as an import job (poll GET /v1/imports/:id, then /errors and /profiles)

Request body

application/json

profilesobject[]required

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

timezonestring

localestring

countrystring

citystring

regionstring

lifecycleStagestring

attributesobject

unsubscribedboolean

createdAtstring

listIdstring

listIdsstring[]

updateExistingboolean

= true

tagsstring[]

= []

consentAssertionobject

Show child parameters

channelstringrequired

email | sms | whatsapp | push | postcard

purposestringrequired

marketing | prospecting | transactional | operational

sourceTextstringrequired

attestedBystringrequired

defaultCountrystring

{
  "profiles": [
    {
      "email": "string",
      "phone": "string",
      "externalId": "string",
      "firstName": "string",
      "lastName": "string",
      "timezone": "string",
      "locale": "string",
      "country": "string",
      "city": "string",
      "region": "string",
      "lifecycleStage": "string",
      "attributes": {},
      "unsubscribed": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "listId": "string",
  "listIds": [
    "string"
  ],
  "updateExisting": true,
  "tags": [],
  "consentAssertion": {
    "channel": "email",
    "purpose": "marketing",
    "sourceText": "string",
    "attestedBy": "string"
  },
  "defaultCountry": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/imports/json" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profiles":[{"email":"string","phone":"string","externalId":"string","firstName":"string","lastName":"string","timezone":"string","locale":"string","country":"string","city":"string","region":"string","lifecycleStage":"string","attributes":{},"unsubscribed":true,"createdAt":"2024-01-01T00:00:00Z"}],"listId":"string","listIds":["string"],"updateExisting":true,"tags":[],"consentAssertion":{"channel":"email","purpose":"marketing","sourceText":"string","attestedBy":"string"},"defaultCountry":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Same as 200 · POST /v1/imports/{id}/cancel

4XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

5XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

GEThttps://hermeticor.com/v1/imports/{id}/errors

Rejected rows of an import as a paged JSON list

Parameters

limitintegerquery

= 100

offsetintegerquery

= 0

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "row": 0,
      "error": "string",
      "data": {}
    }
  ],
  "nextOffset": 0
}

Schema

itemsobject[]required

Show child parameters

rowintegerrequired

errorstringrequired

dataobjectrequired

nextOffsetintegerrequired

4XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

5XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

GEThttps://hermeticor.com/v1/imports/{id}/profiles

Profiles this import created (updated rows are not listed)

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "emailPrimary": "string",
      "phonePrimary": "string",
      "firstName": "string",
      "lastName": "string",
      "timezone": "string",
      "locale": "string",
      "country": "string",
      "city": "string",
      "region": "string",
      "source": "string",
      "lifecycleStage": "string",
      "ownerUserId": "string",
      "attributes": {},
      "tags": [
        "string"
      ],
      "mergedIntoId": "string",
      "archivedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "consentIgnored": [
        "email"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem2[]required

Show child parameters

idstringrequired

emailPrimarystringrequired

phonePrimarystringrequired

firstNamestringrequired

lastNamestringrequired

timezonestringrequired

localestringrequired

countrystringrequired

citystringrequired

regionstringrequired

sourcestringrequired

lifecycleStagestringrequired

ownerUserIdstringrequired

attributesobjectrequired

tagsstring[]required

mergedIntoIdstringrequired

archivedAtstring

createdAtstringrequired

updatedAtstringrequired

consentIgnoredstring[]

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

5XX Default Response

Same as 4XX · POST /v1/imports/{id}/cancel

Updated Nov 8, 2026

Was this page helpful?