Ir para o conteúdo

Lista de Contactos — Segmentos (Coleção)

Endpoint

Método URL
GET /contact_list/<list>/segments

GET /contact_list/<list>/segments

Parâmetro Tipo Descrição
page int Página a devolver. Por defeito 1.
pagesize int Segmentos por página. Por defeito 20.
sort string <campo>,ASC ou <campo>,DESC. Por defeito name,ASC.
q string Devolve só os segmentos cujo nome contém este texto (sem distinguir maiúsculas de minúsculas).

Devolve: A coleção de segmentos e o número de páginas.

Exemplo:

curl -u "username:api_key" -H "Accept: application/json" \
  https://app.duo.pt/contact_list/{list_id}/segments

Resposta:

{
  "success": true,
  "data": {
    "pageCount": 1,
    "segments": [
      {
        "id": 7,
        "list": 1,
        "name": "Subscribed at example.com",
        "filter": {
          "operator": "AND",
          "arguments": [
            {"operator": "ENDSWITH", "leftArg": "email", "rightArg": "@example.com"},
            {"operator": "==", "leftArg": "subscription_state", "rightArg": "SUBSCRIBED"}
          ]
        }
      }
    ],
    "contact_list": { "id": 1, "owner": 1, "name": "Example..." },
    "page": 1
  }
}

Use o id do segmento no parâmetro segments[] de uma Campanha, ou em GET /contact_list/<list>/contacts?segment=<id>.