integrations

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-integrations"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/536d19a1-6da2-4066-83a8-fffef554f020/social-card.svg?v=3e7ae33eec8b" alt="integrations" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/id-mappings

Old ids (from HubSpot, for example) and the lists or journeys they became

Parameters

sourcestringquery
= hubspot
kindstringqueryrequired
list | workflow
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/id-mappings?kind=list" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "legacyId": "string",
      "targetId": "string",
      "kind": "string",
      "source": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem182[]required
Show child parameters
legacyIdstringrequired
targetIdstringrequired
kindstringrequired
sourcestringrequired
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/id-mappings

POSThttps://hermeticor.com/v1/id-mappings

Record old id -> new id pairs

Request body

application/json
sourcestring
= hubspot
kindstringrequired
list | workflow
pairsobject[]required
Show child parameters
legacyIdstringrequired
targetIdstringrequired
{
  "source": "hubspot",
  "kind": "list",
  "pairs": [
    {
      "legacyId": "string",
      "targetId": "string"
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/id-mappings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"hubspot","kind":"list","pairs":[{"legacyId":"string","targetId":"string"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "saved": 0
}
Schema
savedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/id-mappings

5XX Default Response

Same as 4XX · GET /v1/id-mappings

POSThttps://hermeticor.com/v1/id-mappings/read

Look up the new ids for up to 1000 old ids

Request body

application/json
sourcestring
= hubspot
kindstringrequired
list | workflow
legacyIdsstring[]required
{
  "source": "hubspot",
  "kind": "list",
  "legacyIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/id-mappings/read" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"hubspot","kind":"list","legacyIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "legacyId": "string",
      "targetId": "string",
      "kind": "string",
      "source": "string"
    }
  ]
}
Schema
itemsItemsItem182[]required
Show child parameters
legacyIdstringrequired
targetIdstringrequired
kindstringrequired
sourcestringrequired
4XX Default Response

Same as 4XX · GET /v1/id-mappings

5XX Default Response

Same as 4XX · GET /v1/id-mappings

POSThttps://hermeticor.com/v1/migrations/hubspot/lists

Import HubSpot list memberships (list id, list name, email): one list per HubSpot list, existing contacts only, no consent granted

Request body

application/json
rowsobject[]required
Show child parameters
listIdstringrequired
listNamestringrequired
emailstringrequired
{
  "rows": [
    {
      "listId": "string",
      "listName": "string",
      "email": "string"
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/migrations/hubspot/lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"listId":"string","listName":"string","email":"string"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "legacyId": "string",
      "listId": "string",
      "name": "string",
      "created": true,
      "added": 0,
      "notFound": 0
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
legacyIdstringrequired
listIdstringrequired
namestringrequired
createdbooleanrequired
addedintegerrequired
notFoundintegerrequired
4XX Default Response

Same as 4XX · GET /v1/id-mappings

5XX Default Response

Same as 4XX · GET /v1/id-mappings

Updated