profiles

Embed

<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}

Update a contact; `tags` adds tags and `subscriptions` sets email / SMS marketing status through the consent ledger

Parameters

idstringpathrequired

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/{id}" \
  -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

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

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}

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

Archive a contact: kept with history, never sent to or counted until restored

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/profiles/{id}

4XX Default Response

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

5XX Default Response

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

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

Restore an archived contact

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/profiles/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

mergedIdstringrequired

{
  "mergedId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/{id}/merge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mergedId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · PATCH /v1/profiles/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

{}

4XX Default Response

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

5XX Default Response

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

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

Timeline, newest first; filter by activity type and by event / ref name

Parameters

limitintegerquery

= 50

cursorstringquery

typestringquery

namestringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "kind": "string",
      "refType": "string",
      "refId": "string",
      "summary": "string",
      "data": {},
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem3[]required

Show child parameters

idstringrequired

profileIdstringrequired

kindstringrequired

refTypestringrequired

refIdstringrequired

summarystringrequired

datarequired

atstringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

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

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "profileId": "string",
      "authorId": "string",
      "body": "string",
      "kind": "note",
      "at": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem4[]required

Show child parameters

idstringrequired

profileIdstringrequired

authorIdstringrequired

bodystringrequired

kindstringrequired

note | email | call | meeting = note

atstringrequired

updatedAtstring

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Request body

application/json

bodystringrequired

kindstring

note | email | call | meeting = note

{
  "body": "string",
  "kind": "note"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/{id}/notes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","kind":"note"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 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

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tags": [
    "string"
  ]
}

Schema

tagsstring[]required

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?