lists

Embed

<a href="https://hermeticor.com/docs/ref-lists"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/dea5db4d-524b-41d3-8271-fa7e50897c07/social-card.svg?v=3e7ae33eec8b" alt="lists" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/lists/{id}/restore

Undo a list delete; members come back with it

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/lists/{id}/restore" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "description": "string",
  "kind": "string",
  "settings": {
    "doubleOptIn": true,
    "subscribeAddress": "string",
    "permissionReminder": "string",
    "defaultFromName": "string",
    "defaultFromEmail": "string",
    "defaultSubject": "string",
    "defaultReplyTo": "string",
    "allowedFormTags": [
      "string"
    ],
    "defaultLanguage": "string",
    "companyName": "string",
    "contactAddress": "string",
    "postalAddressId": "string",
    "footer": "string",
    "contactEmail": "string",
    "homepageUrl": "string",
    "segmentScopeId": "string",
    "unsubscribeMode": "confirm",
    "unsubscribeRedirectUrl": "string",
    "unsubscribedMessage": "string",
    "notifyOnSubscribe": "string",
    "notifyOnUnsubscribe": "string",
    "archived": true,
    "emoji": "string",
    "publicDirectory": true,
    "expiresAt": "2024-01-01T00:00:00Z",
    "exclusion": true,
    "defaultConnectionId": "string",
    "defaultPoolId": "string"
  },
  "tags": [
    "string"
  ],
  "folderId": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

descriptionstringrequired

kindstringrequired

settingsobjectrequired

Show child parameters

doubleOptInboolean

subscribeAddressstring

permissionReminderstring

defaultFromNamestring

defaultFromEmailstring

defaultSubjectstring

defaultReplyTostring

allowedFormTagsstring[]

defaultLanguagestring

companyNamestring

contactAddressstring

postalAddressIdstring

footerstring

contactEmailstring

homepageUrlstring

segmentScopeIdstring

unsubscribeModestring

confirm | one_click

unsubscribeRedirectUrlstring

unsubscribedMessagestring

notifyOnSubscribestring

notifyOnUnsubscribestring

archivedboolean

emojistring

publicDirectoryboolean

expiresAtstring

exclusionboolean

defaultConnectionIdstring

defaultPoolIdstring

tagsstring[]

folderIdstring

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/lists/{id}/restore

GEThttps://hermeticor.com/v1/lists/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/lists/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/lists/{id}/restore

4XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

5XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

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

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/lists/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

5XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

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

Parameters

idstringpathrequired

Request body

application/json

namestring

descriptionstring

settingsobject

Show child parameters

doubleOptInboolean

subscribeAddressstring

permissionReminderstring

defaultFromNamestring

defaultFromEmailstring

defaultSubjectstring

defaultReplyTostring

allowedFormTagsstring[]

defaultLanguagestring

companyNamestring

contactAddressstring

postalAddressIdstring

footerstring

contactEmailstring

homepageUrlstring

segmentScopeIdstring

unsubscribeModestring

confirm | one_click

unsubscribeRedirectUrlstring

unsubscribedMessagestring

notifyOnSubscribestring

notifyOnUnsubscribestring

archivedboolean

emojistring

publicDirectoryboolean

expiresAtstring

exclusionboolean

defaultConnectionIdstring

defaultPoolIdstring

folderIdstring

{
  "name": "string",
  "description": "string",
  "settings": {
    "doubleOptIn": true,
    "subscribeAddress": "string",
    "permissionReminder": "string",
    "defaultFromName": "string",
    "defaultFromEmail": "string",
    "defaultSubject": "string",
    "defaultReplyTo": "string",
    "allowedFormTags": [
      "string"
    ],
    "defaultLanguage": "string",
    "companyName": "string",
    "contactAddress": "string",
    "postalAddressId": "string",
    "footer": "string",
    "contactEmail": "string",
    "homepageUrl": "string",
    "segmentScopeId": "string",
    "unsubscribeMode": "confirm",
    "unsubscribeRedirectUrl": "string",
    "unsubscribedMessage": "string",
    "notifyOnSubscribe": "string",
    "notifyOnUnsubscribe": "string",
    "archived": true,
    "emoji": "string",
    "publicDirectory": true,
    "expiresAt": "2024-01-01T00:00:00Z",
    "exclusion": true,
    "defaultConnectionId": "string",
    "defaultPoolId": "string"
  },
  "folderId": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/lists/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","settings":{"doubleOptIn":true,"subscribeAddress":"string","permissionReminder":"string","defaultFromName":"string","defaultFromEmail":"string","defaultSubject":"string","defaultReplyTo":"string","allowedFormTags":["string"],"defaultLanguage":"string","companyName":"string","contactAddress":"string","postalAddressId":"string","footer":"string","contactEmail":"string","homepageUrl":"string","segmentScopeId":"string","unsubscribeMode":"confirm","unsubscribeRedirectUrl":"string","unsubscribedMessage":"string","notifyOnSubscribe":"string","notifyOnUnsubscribe":"string","archived":true,"emoji":"string","publicDirectory":true,"expiresAt":"2024-01-01T00:00:00Z","exclusion":true,"defaultConnectionId":"string","defaultPoolId":"string"},"folderId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/lists/{id}/restore

4XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

5XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

PUThttps://hermeticor.com/v1/lists/{id}/tags

Parameters

idstringpathrequired

Request body

application/json

tagsstring[]required

{
  "tags": [
    "string"
  ]
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/lists/{id}/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tags": [
    "string"
  ]
}

Schema

tagsstring[]required

4XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

5XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

GEThttps://hermeticor.com/v1/lists/{id}/members

List members, with the same filters as GET /v1/profiles

Parameters

qstringquery

tagstringquery

tagsAnystringquery

tagsAllstringquery

emailstringquery

phonestringquery

createdSincestringquery

createdBeforestringquery

updatedSincestringquery

updatedBeforestringquery

attrKeystringquery

attrOpstringquery

eq | contains | gt | lt = eq

attrValuestringquery

vipstringquery

true | false

consentStatusstringquery

granted | revoked | pending_confirmation | none

consentChannelstringquery

email | sms | whatsapp | push | postcard

consentSincestringquery

topicIdstringquery

countrystringquery

regionstringquery

citystringquery

segmentIdstringquery

eventNamestringquery

eventSincestringquery

eventBeforestringquery

sourcestringquery

archivedstringquery

only | include

sortstringquery

newest | oldest = newest

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/lists/{id}/members" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "emailPrimary": "string",
      "phonePrimary": "string",
      "firstName": "string",
      "lastName": "string",
      "timezone": "string",
      "locale": "string",
      "country": "string",
      "city": "string",
      "region": "string",
      "source": "string",
      "lifecycleStage": "string",
      "ownerUserId": "string",
      "attributes": {},
      "tags": [
        "string"
      ],
      "mergedIntoId": "string",
      "archivedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "consentIgnored": [
        "email"
      ]
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem2[]required

Show child parameters

idstringrequired

emailPrimarystringrequired

phonePrimarystringrequired

firstNamestringrequired

lastNamestringrequired

timezonestringrequired

localestringrequired

countrystringrequired

citystringrequired

regionstringrequired

sourcestringrequired

lifecycleStagestringrequired

ownerUserIdstringrequired

attributesobjectrequired

tagsstring[]required

mergedIntoIdstringrequired

archivedAtstring

createdAtstringrequired

updatedAtstringrequired

consentIgnoredstring[]

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

5XX Default Response

Same as 4XX · POST /v1/lists/{id}/restore

Next part

Updated Nov 8, 2026

Was this page helpful?