Criar lista de contatos

posthttps://app.madmail.com.br/api/v1/contactBooks

Requer autenticação: Authorization: Bearer us_SUA_CHAVE

Corpo da requisição

namestringObrigatório

Tamanho:: mín. 1

emojistringOpcional

propertiesobjectOpcional

doubleOptInEnabledbooleanOpcional

doubleOptInFromstring | nullOpcional

doubleOptInSubjectstringOpcional

doubleOptInContentstringOpcional

Tamanho:: máx. 1048576

variablesarray<string>Opcional

Exemplo de requisição

curl -X POST "https://app.madmail.com.br/api/v1/contactBooks" \
  -H "Authorization: Bearer us_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Exemplo"
  }'

Resposta

200

Cria uma nova 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"
}