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}/members

Parameters

idstringpathrequired

Request body

application/json

profileIdsstring[]required

{
  "profileIds": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "changed": [
    "string"
  ]
}

Schema

changedstring[]required

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}/members

GEThttps://hermeticor.com/v1/lists/{id}/size-history

List size at the end of each of the last N days, or of each day between `from` and `to`

Parameters

daysintegerquery

= 30

fromstringquery

tostringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "day": "string",
      "size": 0,
      "added": 0,
      "removed": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

daystringrequired

sizeintegerrequired

addedintegerrequired

= 0

removedintegerrequired

= 0

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

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

Members oldest-joined first, with join time and source

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "listId": "string",
      "profileId": "string",
      "meta": {},
      "addedAt": "2024-01-01T00:00:00Z",
      "source": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem5[]required

Show child parameters

listIdstringrequired

profileIdstringrequired

metaobjectrequired

addedAtstringrequired

sourcestringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

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

The data stored on one membership

Parameters

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "listId": "string",
  "profileId": "string",
  "meta": {},
  "addedAt": "2024-01-01T00:00:00Z",
  "source": "string"
}

Schema

listIdstringrequired

profileIdstringrequired

metaobjectrequired

addedAtstringrequired

sourcestringrequired

4XX Default Response

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

5XX Default Response

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

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

Parameters

reasonstringquery

unsubscribed | cleaned | deleted | removed = removed

idstringpathrequired

profileIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

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

5XX Default Response

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

PUThttps://hermeticor.com/v1/lists/{id}/members/{profileId}/meta

Replace the data stored on one membership

Parameters

idstringpathrequired

profileIdstringpathrequired

Request body

application/json

metaobjectrequired

{
  "meta": {}
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/lists/{id}/members/{profileId}

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/lists/{id}/opt-in

Request double opt-in: emails a confirmation link; the person joins the list and is granted consent only when they confirm

Parameters

idstringpathrequired

Request body

application/json

emailstringrequired

firstNamestring

lastNamestring

consentTextstringrequired

consentVersionstring

pageUrlstring

connectionIdstring

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "consentText": "string",
  "consentVersion": "string",
  "pageUrl": "string",
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/lists/{id}/opt-in" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","firstName":"string","lastName":"string","consentText":"string","consentVersion":"string","pageUrl":"string","connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "status": "pending",
  "profileId": "string"
}

Schema

statusstringrequired

pending | already_member

profileIdstringrequired

4XX Default Response

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

5XX Default Response

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

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

People who asked to join a double opt-in list and have not confirmed yet

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "profileId": "string",
      "email": "string",
      "requestedAt": "2024-01-01T00:00:00Z",
      "expiresAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

profileIdstringrequired

emailstringrequired

requestedAtstringrequired

expiresAtstringrequired

nextCursorstringrequired

4XX Default Response

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

5XX Default Response

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

POSThttps://hermeticor.com/v1/lists/{id}/pending/resend

Re-send the confirmation email to everyone still waiting (up to 500); suppressed or withdrawn people are skipped

Parameters

idstringpathrequired

Request body

application/json

connectionIdstring

{
  "connectionId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/lists/{id}/pending/resend" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"connectionId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "sent": 0,
  "skipped": 0
}

Schema

sentintegerrequired

skippedintegerrequired

4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/l/c/{*}

List double opt-in confirmation page (does not change state)

Parameters

*stringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/l/c/{*}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

"string"

4XX Default Response

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

5XX Default Response

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

Next part

Updated Nov 8, 2026

Was this page helpful?