content

Embed

<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-content"><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/63789c31-47a8-4d74-a5c8-afab04b9d5ce/social-card.svg?v=3e7ae33eec8b" alt="content" width="600" height="315"></a>

GEThttps://hermetica.15.204.158.166.sslip.io/v1/postal-addresses

Saved sender addresses a list can print in its email footer

Parameters

limitintegerquery

= 50

cursorstringquery

qstringquery

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/postal-addresses" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "label": "string",
      "company": "string",
      "line1": "string",
      "line2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string",
      "phone": "string",
      "website": "string",
      "id": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "formatted": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

labelstringrequired

companystringrequired

line1stringrequired

line2stringrequired

citystringrequired

regionstringrequired

postalCodestringrequired

countrystringrequired

phonestringrequired

websitestringrequired

idstringrequired

createdAtstringrequired

formattedstringrequired

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/postal-addresses

POSThttps://hermetica.15.204.158.166.sslip.io/v1/postal-addresses

Request body

application/json

labelstringrequired

companystring

line1stringrequired

line2string

citystringrequired

regionstring

postalCodestring

countrystringrequired

phonestring

websitestring

{
  "label": "string",
  "company": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "region": "string",
  "postalCode": "string",
  "country": "string",
  "phone": "string",
  "website": "string"
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/postal-addresses" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","company":"string","line1":"string","line2":"string","city":"string","region":"string","postalCode":"string","country":"string","phone":"string","website":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "label": "string",
  "company": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "region": "string",
  "postalCode": "string",
  "country": "string",
  "phone": "string",
  "website": "string",
  "id": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "formatted": "string"
}

Schema

labelstringrequired

companystringrequired

line1stringrequired

line2stringrequired

citystringrequired

regionstringrequired

postalCodestringrequired

countrystringrequired

phonestringrequired

websitestringrequired

idstringrequired

createdAtstringrequired

formattedstringrequired

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

GEThttps://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/postal-addresses

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}

Delete an address; lists that used it print the workspace address again

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

PATCHhttps://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}

Parameters

idstringpathrequired

Request body

application/json

labelstring

companystring

line1string

line2string

citystring

regionstring

postalCodestring

countrystring

phonestring

websitestring

{
  "label": "string",
  "company": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "region": "string",
  "postalCode": "string",
  "country": "string",
  "phone": "string",
  "website": "string"
}

Code samples

cURL

curl -X PATCH "https://hermetica.15.204.158.166.sslip.io/v1/postal-addresses/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","company":"string","line1":"string","line2":"string","city":"string","region":"string","postalCode":"string","country":"string","phone":"string","website":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/postal-addresses

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

POSThttps://hermetica.15.204.158.166.sslip.io/v1/templates/import-zip

Create an HTML email template from a theme ZIP (multipart field "file"): one HTML page plus its images. Images become library assets; scripts are stripped

Parameters

namestringqueryrequired

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/templates/import-zip?name=<name>" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "workspaceId": "string",
  "channel": "email",
  "name": "string",
  "kind": "blocks",
  "folder": "string",
  "tags": [
    "string"
  ],
  "currentVersionId": "string",
  "archived": true,
  "folderId": "string",
  "brandKitId": "string",
  "isDefault": false,
  "topicId": null,
  "createdBy": null,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "zip": {
    "htmlFile": "string",
    "imagesHosted": 0,
    "imagesSkipped": [
      "string"
    ]
  }
}

Schema

idstringrequired

workspaceIdstringrequired

channelstringrequired

email | sms | whatsapp | push | postcard

namestringrequired

kindstringrequired

blocks | html | text | sms

folderstringrequired

tagsstring[]required

currentVersionIdstringrequired

archivedbooleanrequired

folderIdstringrequired

brandKitIdstringrequired

isDefaultbooleanrequired

= false

topicIdstringrequired

= null

createdBystringrequired

= null

createdAtstringrequired

updatedAtstringrequired

zipobjectrequired

Show child parameters

htmlFilestringrequired

imagesHostednumberrequired

imagesSkippedstring[]required

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

GEThttps://hermetica.15.204.158.166.sslip.io/v1/brand-kits/{id}/voice

How the brand sounds and which competitors it is compared with

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/brand-kits/{id}/voice" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tone": "string",
  "competitors": [
    "string"
  ],
  "toneDescriptors": [
    "string"
  ],
  "languagePatterns": [
    "string"
  ]
}

Schema

tonestringrequired

competitorsstring[]required

toneDescriptorsstring[]required

languagePatternsstring[]required

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

PUThttps://hermetica.15.204.158.166.sslip.io/v1/brand-kits/{id}/voice

Parameters

idstringpathrequired

Request body

application/json

tonestring

competitorsstring[]

toneDescriptorsstring[]

languagePatternsstring[]

{
  "tone": "string",
  "competitors": [
    "string"
  ],
  "toneDescriptors": [
    "string"
  ],
  "languagePatterns": [
    "string"
  ]
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/brand-kits/{id}/voice" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tone":"string","competitors":["string"],"toneDescriptors":["string"],"languagePatterns":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/brand-kits/{id}/voice

4XX Default Response

Same as 4XX · GET /v1/postal-addresses

5XX Default Response

Same as 4XX · GET /v1/postal-addresses

Next part

Updated Nov 3, 2026

Was this page helpful?