profiles

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-profiles"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/5378c6e4-7f93-4868-ad25-407466520de8/social-card.svg?v=3e7ae33eec8b" alt="profiles" width="600" height="315"></a>
DELETEhttps://hermeticor.com/v1/profiles/by/{idType}/{value}

Delete a profile addressed by any identifier

Parameters

idTypestringpathrequired
id | email | phone | external_id | anonymous_id
valuestringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/profiles/by/{idType}/{value}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "removed": [
    {
      "type": "string",
      "value": "string"
    }
  ]
}
Schema
removedobject[]required
Show child parameters
typestringrequired
valuestringrequired
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/profiles/by/{idType}/{value}

PATCHhttps://hermeticor.com/v1/profiles/by/{idType}/{value}

Update a profile addressed by any identifier

Parameters

idTypestringpathrequired
id | email | phone | external_id | anonymous_id
valuestringpathrequired

Request body

application/json
firstNamestring
lastNamestring
timezonestring
localestring
countrystring
citystring
regionstring
lifecycleStagestring
ownerUserIdstring
attributesobject
subscriptionsobject
Show child parameters
emailstring
subscribed | unsubscribed
smsstring
subscribed | unsubscribed
legalBasisstring
consent | legitimate_interest | contract | other
tagsstring[]
{
  "firstName": "string",
  "lastName": "string",
  "timezone": "string",
  "locale": "string",
  "country": "string",
  "city": "string",
  "region": "string",
  "lifecycleStage": "string",
  "ownerUserId": "string",
  "attributes": {},
  "subscriptions": {
    "email": "subscribed",
    "sms": "subscribed",
    "legalBasis": "consent"
  },
  "tags": [
    "string"
  ]
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/profiles/by/{idType}/{value}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"string","lastName":"string","timezone":"string","locale":"string","country":"string","city":"string","region":"string","lifecycleStage":"string","ownerUserId":"string","attributes":{},"subscriptions":{"email":"subscribed","sms":"subscribed","legalBasis":"consent"},"tags":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "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"
  ]
}
Schema
idstringrequired
emailPrimarystringrequired
phonePrimarystringrequired
firstNamestringrequired
lastNamestringrequired
timezonestringrequired
localestringrequired
countrystringrequired
citystringrequired
regionstringrequired
sourcestringrequired
lifecycleStagestringrequired
ownerUserIdstringrequired
attributesobjectrequired
tagsstring[]required
mergedIntoIdstringrequired
archivedAtstring
createdAtstringrequired
updatedAtstringrequired
consentIgnoredstring[]
4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

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

Fetch one profile by id, email, phone, externalId or anonymousId (first one given wins)

Parameters

emailstringquery
phonestringquery
externalIdstringquery
anonymousIdstringquery
idstringquery

Code samples

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

Responses

200 Default Response

Same as 200 · PATCH /v1/profiles/by/{idType}/{value}

4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

POSThttps://hermeticor.com/v1/profiles/lookup

Batch read by ids, emails, phones or external ids; `keys` limits the attributes returned

Request body

application/json
idsstring[]
emailsstring[]
phonesstring[]
externalIdsstring[]
keysstring[]
{
  "ids": [
    "string"
  ],
  "emails": [
    "string"
  ],
  "phones": [
    "string"
  ],
  "externalIds": [
    "string"
  ],
  "keys": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/profiles/lookup" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"emails":["string"],"phones":["string"],"externalIds":["string"],"keys":["string"]}'
TypeScript
Python
Go
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"
      ]
    }
  ]
}
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[]
4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

GEThttps://hermeticor.com/v1/profiles/{id}/campaign-stats

Per-contact campaign engagement: sent, delivered, opens, clicks, bounces by campaign

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "totals": {
    "campaigns": 0,
    "sent": 0,
    "delivered": 0,
    "opened": 0,
    "clicked": 0,
    "bounced": 0,
    "unsubscribed": 0,
    "complained": 0
  },
  "campaigns": [
    {
      "campaignId": "string",
      "name": "string",
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "clicked": 0,
      "bounced": true,
      "unsubscribed": true,
      "complained": true,
      "lastActivityAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
totalsobjectrequired
Show child parameters
campaignsintegerrequired
sentintegerrequired
deliveredintegerrequired
openedintegerrequired
clickedintegerrequired
bouncedintegerrequired
unsubscribedintegerrequired
complainedintegerrequired
campaignsobject[]required
Show child parameters
campaignIdstringrequired
namestringrequired
sentintegerrequired
deliveredintegerrequired
openedintegerrequired
clickedintegerrequired
bouncedbooleanrequired
unsubscribedbooleanrequired
complainedbooleanrequired
lastActivityAtstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

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

Custom objects linked to this profile

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/profiles/{id}/relationships" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "typeKey": "string",
      "objectId": "string",
      "name": "string",
      "role": "string",
      "labels": [
        "string"
      ],
      "linkedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
typeKeystringrequired
objectIdstringrequired
namestringrequired
rolestringrequired
labelsstring[]required
linkedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

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

Every email, phone and external id attached to a person, including those that came with a merge

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/profiles/{id}/identifiers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "type": "string",
      "value": "string",
      "verified": true,
      "source": "string",
      "addedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
typestringrequired
valuestringrequired
verifiedbooleanrequired
sourcestringrequired
addedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

5XX Default Response

Same as 4XX · DELETE /v1/profiles/by/{idType}/{value}

Updated