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>
PATCHhttps://hermeticor.com/v1/profiles/{id}/notes/{noteId}

Parameters

idstringpathrequired
noteIdstringpathrequired

Request body

application/json
bodystringrequired
kindstring
note | email | call | meeting = note
{
  "body": "string",
  "kind": "note"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/profiles/{id}/notes/{noteId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","kind":"note"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "profileId": "string",
  "authorId": "string",
  "body": "string",
  "kind": "note",
  "at": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
profileIdstringrequired
authorIdstringrequired
bodystringrequired
kindstringrequired
note | email | call | meeting = note
atstringrequired
updatedAtstring
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

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

Device records entered by hand for this person (flagged manual; real visits are in the device_* attributes)

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "manual": true,
      "type": "string",
      "os": "string",
      "browser": "string",
      "brand": "string",
      "model": "string",
      "at": "2024-01-01T00:00:00Z",
      "by": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem27[]required
Show child parameters
idstringrequired
manualbooleanrequired
true
typestringrequired
osstring
browserstring
brandstring
modelstring
atstringrequired
bystringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

POSThttps://hermeticor.com/v1/profiles/{id}/devices

Add a device record by hand (flagged manual)

Parameters

idstringpathrequired

Request body

application/json
typestringrequired
desktop | mobile | tablet | other
osstring
browserstring
brandstring
modelstring
{
  "type": "desktop",
  "os": "string",
  "browser": "string",
  "brand": "string",
  "model": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/profiles/{id}/devices" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"desktop","os":"string","browser":"string","brand":"string","model":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "manual": true,
  "type": "string",
  "os": "string",
  "browser": "string",
  "brand": "string",
  "model": "string",
  "at": "2024-01-01T00:00:00Z",
  "by": "string"
}
Schema
idstringrequired
manualbooleanrequired
true
typestringrequired
osstring
browserstring
brandstring
modelstring
atstringrequired
bystringrequired
4XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

DELETEhttps://hermeticor.com/v1/profiles/{id}/devices/{deviceId}

Parameters

idstringpathrequired
deviceIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/profiles/{id}/devices/{deviceId}" \
  -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

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

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

UTM records entered by hand for this person (flagged manual)

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "manual": true,
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "content": "string",
      "term": "string",
      "note": "string",
      "at": "2024-01-01T00:00:00Z",
      "by": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem28[]required
Show child parameters
idstringrequired
manualbooleanrequired
true
sourcestring
mediumstring
campaignstring
contentstring
termstring
notestring
atstringrequired
bystringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

POSThttps://hermeticor.com/v1/profiles/{id}/utm

Add a UTM record by hand. It is flagged manual and never feeds attribution, first touch or last touch

Parameters

idstringpathrequired

Request body

application/json
sourcestring
mediumstring
campaignstring
contentstring
termstring
notestring
{
  "source": "string",
  "medium": "string",
  "campaign": "string",
  "content": "string",
  "term": "string",
  "note": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/profiles/{id}/utm" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"string","medium":"string","campaign":"string","content":"string","term":"string","note":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "manual": true,
  "source": "string",
  "medium": "string",
  "campaign": "string",
  "content": "string",
  "term": "string",
  "note": "string",
  "at": "2024-01-01T00:00:00Z",
  "by": "string"
}
Schema
idstringrequired
manualbooleanrequired
true
sourcestring
mediumstring
campaignstring
contentstring
termstring
notestring
atstringrequired
bystringrequired
4XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

DELETEhttps://hermeticor.com/v1/profiles/{id}/utm/{utmId}

Parameters

idstringpathrequired
utmIdstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/profiles/{id}/devices/{deviceId}

4XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

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

Fetch a profile by id, email, phone, external_id or anonymous_id

Parameters

idTypestringpathrequired
id | email | phone | external_id | anonymous_id
valuestringpathrequired

Code samples

cURL
curl -X GET "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
{
  "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 · PATCH /v1/profiles/{id}/notes/{noteId}

5XX Default Response

Same as 4XX · PATCH /v1/profiles/{id}/notes/{noteId}

Updated