crm

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-crm"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/33f93100-1b7a-437e-92fb-01b31f9721b3/social-card.svg?v=3e7ae33eec8b" alt="crm" width="600" height="315"></a>
DELETEhttps://hermeticor.com/v1/integrations/crm-imports/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/integrations/crm-imports/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

GEThttps://hermeticor.com/v1/integrations/crm-log

Per-record CRM sync log, newest first

Parameters

limitintegerquery
= 50
cursorstringquery
connectionIdstringquery
localIdstringquery
statusstringquery
ok | skipped | error

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "connectionId": "string",
      "entity": "contact",
      "direction": "push",
      "status": "ok",
      "externalId": "string",
      "localId": "string",
      "message": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
connectionIdstringrequired
entitystringrequired
contact | company | source
directionstringrequired
push | pull | link | import
statusstringrequired
ok | skipped | error
externalIdstringrequired
localIdstringrequired
messagestringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

GEThttps://hermeticor.com/v1/integrations/crm-settings

Workspace CRM settings (sync log retention)

Code samples

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

Responses

200 Default Response
Example
{
  "logRetentionDays": 0
}
Schema
logRetentionDaysintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

PUThttps://hermeticor.com/v1/integrations/crm-settings

Set how many days the CRM sync log keeps rows (7 to 3650)

Request body

application/json
logRetentionDaysintegerrequired
{
  "logRetentionDays": 0
}

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/integrations/crm-settings

4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

GEThttps://hermeticor.com/v1/integrations/connections/{id}/crm/users

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "externalUserId": "string",
      "email": "string",
      "name": "string",
      "userId": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem242[]required
Show child parameters
externalUserIdstringrequired
emailstringrequired
namestringrequired
userIdstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

PUThttps://hermeticor.com/v1/integrations/connections/{id}/crm/users

Parameters

idstringpathrequired

Request body

application/json
pairsobject[]required
Show child parameters
externalUserIdstringrequired
userIdstringrequired
{
  "pairs": [
    {
      "externalUserId": "string",
      "userId": "string"
    }
  ]
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/integrations/connections/{id}/crm/users" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pairs":[{"externalUserId":"string","userId":"string"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "externalUserId": "string",
      "email": "string",
      "name": "string",
      "userId": "string"
    }
  ]
}
Schema
itemsItemsItem242[]required
Show child parameters
externalUserIdstringrequired
emailstringrequired
namestringrequired
userIdstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

POSThttps://hermeticor.com/v1/integrations/connections/{id}/crm/users/refresh

Read the CRM users and match new ones to members by email

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/crm/users/refresh" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PUT /v1/integrations/connections/{id}/crm/users

4XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/crm-imports/{id}

Updated