settings

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-settings"><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/0593b314-c2d5-4887-8506-0921dafccae7/social-card.svg?v=3e7ae33eec8b" alt="settings" width="600" height="315"></a>
PUThttps://hermetica.15.204.158.166.sslip.io/v1/standard-fields/{key}

Parameters

keystringpathrequired
email | firstName | lastName | phone

Request body

application/json
requiredbooleanrequired
visiblebooleanrequired
defaultValuestring
{
  "required": true,
  "visible": true,
  "defaultValue": "string"
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/standard-fields/{key}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"required":true,"visible":true,"defaultValue":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "email",
      "required": true,
      "visible": true,
      "defaultValue": "string"
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
keystringrequired
email | firstName | lastName | phone
requiredbooleanrequired
visiblebooleanrequired
defaultValuestringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/unconfirmed-purge

Days after which contacts that never confirmed an opt-in are deleted (null = off)

Code samples

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

Responses

200 Default Response
Example
{
  "days": 0
}
Schema
daysintegerrequired
4XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

5XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

PUThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/unconfirmed-purge

Request body

application/json
daysintegerrequired
{
  "days": 0
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/compliance/unconfirmed-purge" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/unconfirmed-purge

4XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

5XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

GEThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/export-retention

Days an export file is kept before it is deleted

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/compliance/unconfirmed-purge

4XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

5XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

PUThttps://hermetica.15.204.158.166.sslip.io/v1/compliance/export-retention

Request body

application/json
daysintegerrequired
{
  "days": 0
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/compliance/export-retention" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"days":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/compliance/unconfirmed-purge

4XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

5XX Default Response

Same as 4XX · PUT /v1/standard-fields/{key}

Updated