lists

Embed
Preview of the card
<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/copy-from

Add every active member of another list

Parameters

idstringpathrequired

Request body

application/json
sourceListIdstringrequired
{
  "sourceListId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/lists/{id}/members/copy-from" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sourceListId":"string"}'
TypeScript
Python
Go
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/copy-from

POSThttps://hermeticor.com/v1/lists/{id}/members/change

Add and remove list members in one atomic call (the whole request rolls back if any step fails)

Parameters

idstringpathrequired

Request body

application/json
addstring[]
= []
removestring[]
= []
{
  "add": [],
  "remove": []
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/lists/{id}/members/change" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"add":[],"remove":[]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "added": 0,
  "removed": 0
}
Schema
addedintegerrequired
removedintegerrequired
4XX Default Response

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

5XX Default Response

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

GEThttps://hermeticor.com/v1/list-conversions

Parameters

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

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/list-conversions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "direction": "list_to_segment",
      "sourceId": "string",
      "sourceName": "string",
      "runAt": "2024-01-01T00:00:00Z",
      "targetName": "string",
      "retireSource": true,
      "status": "scheduled",
      "targetId": "string",
      "error": "string",
      "finishedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem176[]required
Show child parameters
idstringrequired
directionstringrequired
list_to_segment | segment_to_list
sourceIdstringrequired
sourceNamestringrequired
runAtstringrequired
targetNamestringrequired
retireSourcebooleanrequired
statusstringrequired
scheduled | done | failed | cancelled
targetIdstringrequired
errorstringrequired
finishedAtstringrequired
nextCursorstringrequired
4XX Default Response

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

5XX Default Response

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

PUThttps://hermeticor.com/v1/list-conversions

Schedule a conversion; replaces a pending one for the same source

Request body

application/json
directionstringrequired
list_to_segment | segment_to_list
sourceIdstringrequired
runAtstringrequired
targetNamestring
retireSourceboolean
= false
{
  "direction": "list_to_segment",
  "sourceId": "string",
  "runAt": "2024-01-01T00:00:00Z",
  "targetName": "string",
  "retireSource": false
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/list-conversions" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"direction":"list_to_segment","sourceId":"string","runAt":"2024-01-01T00:00:00Z","targetName":"string","retireSource":false}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "direction": "list_to_segment",
  "sourceId": "string",
  "sourceName": "string",
  "runAt": "2024-01-01T00:00:00Z",
  "targetName": "string",
  "retireSource": true,
  "status": "scheduled",
  "targetId": "string",
  "error": "string",
  "finishedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
directionstringrequired
list_to_segment | segment_to_list
sourceIdstringrequired
sourceNamestringrequired
runAtstringrequired
targetNamestringrequired
retireSourcebooleanrequired
statusstringrequired
scheduled | done | failed | cancelled
targetIdstringrequired
errorstringrequired
finishedAtstringrequired
4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/list-conversions/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/list-conversions/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

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

5XX Default Response

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

Updated