Buscar lista de contatos

gethttps://app.madmail.com.br/api/v1/contactBooks/{contactBookId}

Requer autenticação: Authorization: Bearer us_SUA_CHAVE

Parâmetros de caminho

contactBookIdstringObrigatório

Exemplo de requisição

curl -X GET "https://app.madmail.com.br/api/v1/contactBooks/{contactBookId}" \
  -H "Authorization: Bearer us_SUA_CHAVE"

Resposta

200

Recupera a lista de contatos

idstringObrigatório

ID da lista de contatos

namestringObrigatório

Nome da lista de contatos

teamIdnumberObrigatório

ID do workspace

propertiesobjectObrigatório

Propriedades personalizadas da lista de contatos

variablesarray<string>Obrigatório

Variáveis de personalização permitidas para os contatos desta lista

emojistringObrigatório

Emoji associado à lista de contatos

doubleOptInEnabledbooleanOpcional

Indica se o double opt-in está ativo para novos contatos

doubleOptInFromstring | nullOpcional

Remetente usado nos e-mails de double opt-in (precisa usar um domínio verificado)

doubleOptInSubjectstring | nullOpcional

Assunto usado no e-mail de confirmação do double opt-in

doubleOptInContentstring | nullOpcional

Conteúdo JSON do editor usado na confirmação do double opt-in

createdAtstringObrigatório

Data e hora de criação

updatedAtstringObrigatório

Data e hora da última atualização

_countobjectOpcional

contactsnumberObrigatório

Quantidade de contatos na lista

{
  "id": "clx1234567890",
  "name": "Newsletter Subscribers",
  "teamId": 1,
  "properties": {
    "customField1": "value1"
  },
  "variables": [
    "registrationCode",
    "company"
  ],
  "emoji": "📙",
  "createdAt": "string",
  "updatedAt": "string"
}

403

Proibido - a chave de API não tem acesso a esta lista de contatos

errorstringObrigatório

{
  "error": "string"
}

404

Lista de contatos não encontrada

errorstringObrigatório

{
  "error": "string"
}