segments

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-segments"><img src="https://hermetica.15.204.158.166.sslip.io/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://hermetica.15.204.158.166.sslip.io/v1/attributes/fields

Declared custom fields (merge fields) with type, default and display order

Parameters

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

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "type": "text",
      "required": true,
      "hidden": true,
      "defaultValue": {},
      "unique": false,
      "selfServe": false,
      "precision": null,
      "choices": [
        "string"
      ],
      "position": 0,
      "groupKey": "string",
      "listIds": [],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
keystringrequired
labelstringrequired
typestringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
requiredbooleanrequired
hiddenbooleanrequired
defaultValuerequired
uniquebooleanrequired
= false
selfServebooleanrequired
= false
precisionintegerrequired
= null
choicesstring[]required
positionintegerrequired
groupKeystringrequired
listIdsstring[]required
= []
createdAtstringrequired
nextCursorstringrequired
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/attributes/fields

POSThttps://hermetica.15.204.158.166.sslip.io/v1/attributes/fields

Request body

application/json
keystringrequired
labelstringrequired
typestring
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale = text
requiredboolean
= false
hiddenboolean
= false
defaultValue
uniqueboolean
= false
selfServeboolean
= false
precisioninteger
choicesstring[]
positioninteger
= 0
groupKeystring
listIdsstring[]
{
  "key": "string",
  "label": "string",
  "type": "text",
  "required": false,
  "hidden": false,
  "defaultValue": {},
  "unique": false,
  "selfServe": false,
  "precision": 0,
  "choices": [
    "string"
  ],
  "position": 0,
  "groupKey": "string",
  "listIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","type":"text","required":false,"hidden":false,"defaultValue":{},"unique":false,"selfServe":false,"precision":0,"choices":["string"],"position":0,"groupKey":"string","listIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "key": "string",
  "label": "string",
  "type": "text",
  "required": true,
  "hidden": true,
  "defaultValue": {},
  "unique": false,
  "selfServe": false,
  "precision": null,
  "choices": [
    "string"
  ],
  "position": 0,
  "groupKey": "string",
  "listIds": [],
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
keystringrequired
labelstringrequired
typestringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
requiredbooleanrequired
hiddenbooleanrequired
defaultValuerequired
uniquebooleanrequired
= false
selfServebooleanrequired
= false
precisionintegerrequired
= null
choicesstring[]required
positionintegerrequired
groupKeystringrequired
listIdsstring[]required
= []
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/attributes/fields

5XX Default Response

Same as 4XX · GET /v1/attributes/fields

POSThttps://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/batch

create | read (by key) | update | archive up to 50 fields in one transaction

Request body

application/json
Example
{
  "op": "create",
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": false,
      "hidden": false,
      "defaultValue": {},
      "unique": false,
      "selfServe": false,
      "precision": 0,
      "choices": [
        "string"
      ],
      "position": 0,
      "groupKey": "string",
      "listIds": [
        "string"
      ]
    }
  ]
}
Option 1
opstringrequired
create
itemsobject[]required
Show child parameters
keystringrequired
labelstringrequired
typestring
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale = text
requiredboolean
= false
hiddenboolean
= false
defaultValue
uniqueboolean
= false
selfServeboolean
= false
precisioninteger
choicesstring[]
positioninteger
= 0
groupKeystring
listIdsstring[]
{
  "op": "create",
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": false,
      "hidden": false,
      "defaultValue": {},
      "unique": false,
      "selfServe": false,
      "precision": 0,
      "choices": [
        "string"
      ],
      "position": 0,
      "groupKey": "string",
      "listIds": [
        "string"
      ]
    }
  ]
}
Option 2
opstringrequired
read
keysstring[]required
{
  "op": "read",
  "keys": [
    "string"
  ]
}
Option 3
opstringrequired
update
itemsobject[]required
Show child parameters
keystringrequired
patchobjectrequired
Show child parameters
labelstring
typestring
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
requiredboolean
hiddenboolean
defaultValue
uniqueboolean
selfServeboolean
precisioninteger
choicesstring[]
positioninteger
groupKeystring
listIdsstring[]
{
  "op": "update",
  "items": [
    {
      "key": "string",
      "patch": {
        "label": "string",
        "type": "text",
        "required": true,
        "hidden": true,
        "defaultValue": {},
        "unique": true,
        "selfServe": true,
        "precision": 0,
        "choices": [
          "string"
        ],
        "position": 0,
        "groupKey": "string",
        "listIds": [
          "string"
        ]
      }
    }
  ]
}
Option 4
opstringrequired
archive
keysstring[]required
{
  "op": "archive",
  "keys": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/batch" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"op":"create","items":[{"key":"string","label":"string","type":"text","required":false,"hidden":false,"defaultValue":{},"unique":false,"selfServe":false,"precision":0,"choices":["string"],"position":0,"groupKey":"string","listIds":["string"]}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "label": "string",
      "type": "text",
      "required": true,
      "hidden": true,
      "defaultValue": {},
      "unique": false,
      "selfServe": false,
      "precision": null,
      "choices": [
        "string"
      ],
      "position": 0,
      "groupKey": "string",
      "listIds": [],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "archived": 0,
  "missing": [
    "string"
  ]
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
keystringrequired
labelstringrequired
typestringrequired
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
requiredbooleanrequired
hiddenbooleanrequired
defaultValuerequired
uniquebooleanrequired
= false
selfServebooleanrequired
= false
precisionintegerrequired
= null
choicesstring[]required
positionintegerrequired
groupKeystringrequired
listIdsstring[]required
= []
createdAtstringrequired
archivedintegerrequired
missingstring[]
4XX Default Response

Same as 4XX · GET /v1/attributes/fields

5XX Default Response

Same as 4XX · GET /v1/attributes/fields

GEThttps://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}

Parameters

keystringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/attributes/fields

4XX Default Response

Same as 4XX · GET /v1/attributes/fields

5XX Default Response

Same as 4XX · GET /v1/attributes/fields

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}

Parameters

keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/attributes/fields

5XX Default Response

Same as 4XX · GET /v1/attributes/fields

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}

Parameters

keystringpathrequired

Request body

application/json
labelstring
typestring
text | textarea | number | date | datetime | time | boolean | enum | multi_enum | phone | email | url | address | file | country | region | timezone | locale
requiredboolean
hiddenboolean
defaultValue
uniqueboolean
selfServeboolean
precisioninteger
choicesstring[]
positioninteger
groupKeystring
listIdsstring[]
{
  "label": "string",
  "type": "text",
  "required": true,
  "hidden": true,
  "defaultValue": {},
  "unique": true,
  "selfServe": true,
  "precision": 0,
  "choices": [
    "string"
  ],
  "position": 0,
  "groupKey": "string",
  "listIds": [
    "string"
  ]
}

Code samples

cURL
curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/attributes/fields/{key}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","type":"text","required":true,"hidden":true,"defaultValue":{},"unique":true,"selfServe":true,"precision":0,"choices":["string"],"position":0,"groupKey":"string","listIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/attributes/fields

4XX Default Response

Same as 4XX · GET /v1/attributes/fields

5XX Default Response

Same as 4XX · GET /v1/attributes/fields

Updated