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>

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

Parameters

idstringpathrequired

Request body

application/json

tagsstring[]

namesstring[]

Deprecated: use tags

{
  "tags": [
    "string"
  ],
  "names": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tags": [
    "string"
  ]
}

Schema

tagsstring[]required

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

DELETEhttps://hermeticor.com/v1/profiles/{id}/tags/{name}

Parameters

idstringpathrequired

namestringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/profiles/{id}/tags

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

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

Count profiles matching the same filters as GET /v1/profiles

Parameters

qstringquery

tagstringquery

tagsAnystringquery

tagsAllstringquery

listIdstringquery

emailstringquery

phonestringquery

createdSincestringquery

createdBeforestringquery

updatedSincestringquery

updatedBeforestringquery

attrKeystringquery

attrOpstringquery

eq | contains | gt | lt = eq

attrValuestringquery

vipstringquery

true | false

consentStatusstringquery

granted | revoked | pending_confirmation | none

consentChannelstringquery

email | sms | whatsapp | push | postcard

consentSincestringquery

topicIdstringquery

countrystringquery

regionstringquery

citystringquery

segmentIdstringquery

eventNamestringquery

eventSincestringquery

eventBeforestringquery

sourcestringquery

archivedstringquery

only | include

sortstringquery

newest | oldest = newest

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/profiles/count" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "count": 0
}

Schema

countintegerrequired

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "lists": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Schema

listsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "segments": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Schema

segmentsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

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

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "lists": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "segments": [
    {
      "id": "string",
      "name": "string"
    }
  ]
}

Schema

listsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

segmentsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

POSThttps://hermeticor.com/v1/profiles/memberships/batch

The lists and segments of up to 100 people in one call (unknown people are left out; people outside your lists are refused)

Request body

application/json

profileIdsstring[]required

{
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/profiles/memberships/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileIds":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "lists": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "segments": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

listsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

segmentsListsItem[]required

Show child parameters

idstringrequired

namestringrequired

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

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

Parameters

idstringpathrequired

noteIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

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

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

DELETEhttps://hermeticor.com/v1/profiles/{id}/notes/{noteId}

Parameters

idstringpathrequired

noteIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

5XX Default Response

Same as 4XX · POST /v1/profiles/{id}/tags

Next part

Updated Nov 8, 2026

Was this page helpful?