segments

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-segments"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a1bf95e7-ade8-4fcf-b9dd-0119dc7aeef8/social-card.svg?v=3e7ae33eec8b" alt="segments" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/segments/{id}/match/{profileId}

Does this contact match the segment right now?

Parameters

idstringpathrequired
profileIdstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "segmentId": "string",
  "profileId": "string",
  "matched": true,
  "member": true
}
Schema
segmentIdstringrequired
profileIdstringrequired
matchedbooleanrequired
memberbooleanrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

GEThttps://hermeticor.com/v1/segments/{id}/match-runs

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "segmentId": "string",
      "status": "complete",
      "count": 0,
      "takenAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1SegmentsByIdMatchRunsResponse[]required
Show child parameters
idstringrequired
segmentIdstringrequired
statusstringrequired
complete
countintegerrequired
takenAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

POSThttps://hermeticor.com/v1/segments/{id}/match-runs

Match everyone against the segment now and keep the result as a run

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/segments/{id}/match-runs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "segmentId": "string",
  "status": "complete",
  "count": 0,
  "takenAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
segmentIdstringrequired
statusstringrequired
complete
countintegerrequired
takenAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

GEThttps://hermeticor.com/v1/segment-match-runs/{id}

A run; its people are at GET /v1/segment-snapshots/{id}/contacts

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/segments/{id}/match-runs

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

POSThttps://hermeticor.com/v1/segment-match-runs

Run up to 20 segments at once

Request body

application/json
segmentIdsstring[]required
{
  "segmentIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/segment-match-runs" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"segmentIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "segmentId": "string",
      "status": "complete",
      "count": 0,
      "takenAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
itemsPostV1SegmentsByIdMatchRunsResponse[]required
Show child parameters
idstringrequired
segmentIdstringrequired
statusstringrequired
complete
countintegerrequired
takenAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

GEThttps://hermeticor.com/v1/attributes/fields/{key}/lists

Parameters

keystringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/attributes/fields/{key}/lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "key": "string",
  "listIds": [
    "string"
  ]
}
Schema
keystringrequired
listIdsstring[]required
4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

PUThttps://hermeticor.com/v1/attributes/fields/{key}/lists/{listId}

Show this field for people on this list

Parameters

keystringpathrequired
listIdstringpathrequired

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/attributes/fields/{key}/lists/{listId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/attributes/fields/{key}/lists

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

DELETEhttps://hermeticor.com/v1/attributes/fields/{key}/lists/{listId}

Parameters

keystringpathrequired
listIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/attributes/fields/{key}/lists/{listId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/attributes/fields/{key}/lists

4XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

5XX Default Response

Same as 4XX · GET /v1/segments/{id}/match/{profileId}

Updated