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>
POSThttps://hermeticor.com/v1/attributes/field-groups

Request body

application/json
keystringrequired
labelstringrequired
positioninteger
= 0
{
  "key": "string",
  "label": "string",
  "position": 0
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/attributes/field-groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","position":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "key": "string",
  "label": "string",
  "position": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
keystringrequired
labelstringrequired
positionintegerrequired
createdAtstringrequired
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/attributes/field-groups

GEThttps://hermeticor.com/v1/attributes/field-groups/{key}

Parameters

keystringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/attributes/field-groups

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

DELETEhttps://hermeticor.com/v1/attributes/field-groups/{key}

Delete a group; its fields become ungrouped

Parameters

keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/attributes/field-groups/{key}" \
  -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 · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

PATCHhttps://hermeticor.com/v1/attributes/field-groups/{key}

Parameters

keystringpathrequired

Request body

application/json
labelstring
positioninteger
{
  "label": "string",
  "position": 0
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/attributes/field-groups/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","position":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/attributes/field-groups

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

GEThttps://hermeticor.com/v1/stages

Lifecycle stages in order of weight

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "weight": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem12[]required
Show child parameters
idstringrequired
namestringrequired
weightintegerrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

POSThttps://hermeticor.com/v1/stages

Request body

application/json
namestringrequired
weightinteger
= 0
{
  "name": "string",
  "weight": 0
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/stages" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","weight":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "weight": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
weightintegerrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

DELETEhttps://hermeticor.com/v1/stages/{id}

Delete a stage; the people in it end up with no stage

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/attributes/field-groups/{key}

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

PATCHhttps://hermeticor.com/v1/stages/{id}

Rename or reweight; a rename carries the people in it

Parameters

idstringpathrequired

Request body

application/json
namestring
weightinteger
{
  "name": "string",
  "weight": 0
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/stages/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","weight":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/stages

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

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

Move everyone into another stage and remove this one

Parameters

idstringpathrequired

Request body

application/json
intoIdstringrequired
{
  "intoId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/stages/{id}/merge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intoId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "moved": 0
}
Schema
movedintegerrequired
4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

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

Put a contact in the stage (logged in attribute history)

Parameters

idstringpathrequired

Request body

application/json
profileIdstringrequired
{
  "profileId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/stages/{id}/profiles" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/attributes/field-groups/{key}

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

DELETEhttps://hermeticor.com/v1/stages/{id}/profiles/{profileId}

Take a contact out of the stage

Parameters

idstringpathrequired
profileIdstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/attributes/field-groups/{key}

4XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

5XX Default Response

Same as 4XX · POST /v1/attributes/field-groups

Updated