Nenhum parâmetro

{}

{"error":"Os valores dos parâmetros (template_slug, message_html) são inválidos. Impossível enviar email sem o parâmetro \"template_slug\". É preciso fornecer o parâmetro \"template_slug\" ou \"message_html\""}

Apenas o parâmetro 'template_slug'

{
    'template_slug': 'tpl-teste',
}

{"error":"Os valores dos parâmetros (subject, use_tpl_default_subject) são inválidos. Impossível enviar email sem o parâmetro \"subject\". É preciso fornecer o parâmetro \"subject\", ou \"use_tpl_default_subject\""}

Os parâmetros 'template_slug' e dois parâmetros onde qualquer um pode ser usado como 'subject'

{
    'subject': 'teste', 
    OU 
    'use_tpl_default_subject': True,
    'template_slug': 'tpl-teste',
}

{"error":"Os valores dos parâmetros (from, use_tpl_default_email) são inválidos. Impossível enviar email sem o parâmetro \"from\". É preciso fornecer o parâmetro \"from\" ou \"use_tpl_default_email\""}

Os parâmetros 'template_slug', 'subject' e 'from', sendo que este está no formato errado

{
    'subject': 'teste',
    'template_slug': 'tpl-teste',
    'from': 'foo@alterdata.com.br'
}

{"error":"O valor do parâmetro 'from' é inválido. Ou o valor não é um e-mail válido ou não está seguindo o formato \"Nome <email>\"."}

Os parâmetros 'template_slug', 'subject' e dois parâmetros onde qualquer um pode ser usado como 'from'

{
    'subject': 'teste',
    'template_slug': 'tpl-teste',
    'from': '<foo@alterdata.com.br>',
    OU
    'use_tpl_default_email': True,
}

{"error":"Impossível enviar emails sem lista de destinatários, parâmetro \"recipient_list\" vazio."}

Os parâmetros 'template_slug', 'subject', 'from' e 'recipient_list', sendo que este está no formato errado

{
    'subject': 'teste',
    'template_slug': 'tpl-teste',
    'from': '<foo@alterdata.com.br>',
    'recipient_list': [
        'Thiago do Cirrus thiago.dsn.cir@alterdata.com.br',
        'Alexandro do Cirrus alexandro.dsn.cir@alterdata.com.br',
    ],
}

{"error":"Impossível enviar emails sem lista de destinatários, parâmetro \"recipient_list\" vazio."}

Obs.: O erro é o mesmo que enviar uma lista vazia ou sequer enviar o parâmetro, porquê nesse caso o e-mail do destinatário não está no formato correto, veja no próximo exemplo.

Os parâmetros 'template_slug', 'subject', 'from' e 'recipient_list', sendo que este está no formato certo

{
    'subject': 'teste', 
    OU 
    'use_tpl_default_subject': True,
    'template_slug': 'tpl-teste',
    'from': '<foo@alterdata.com.br>'
    OU
    'use_tpl_default_email': True,
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>
    ],
}

{u'emails_invalidos': [], u'emails_enviados': [{u'uuid': u'e93288598d8b4e4', u'email': u'thiago.dsn.cir@alterdata.com.br'}, {u'uuid': u'30aa139264574dc', u'email': u'alexandro.dsn.cir@alterdata.com.br'}]}

Uso dos parâmetros 'use_tpl_default_subject', 'use_tpl_default_email' e 'use_tpl_default_name'

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,    |
    'use_tpl_default_email': True,      | - Esses três parâmetros substituem os parâmetros: 'subject' e 'from'
    'use_tpl_default_name': True,       |
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>'
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>
    ],

}

Caso o valor desses parâmetros for qualquer coisa diferente de um booleano, a resposta será sempre a mesma:

{"error":"Tipo inválido para o parâmetro 'use_tpl_default_name'. Tipo esperado '<type 'bool'>'"} {"error":"Tipo inválido para o parâmetro 'use_tpl_default_email'. Tipo esperado '<type 'bool'>'"} {"error":"Tipo inválido para o parâmetro 'use_tpl_default_subject'. Tipo esperado '<type 'bool'>'"}

Uso do parâmetro 'activate_tracking'

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,
    'use_tpl_default_email': True,
    'use_tpl_default_name': True,
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>'
    ],
    'activate_tracking': True, | - Parâmetro que sobrescreve a configuração do app, para rastrear a visualização e cliques nesse email
}

Caso o valor desse parâmetro for qualquer coisa diferente de um booleano, a resposta será sempre a mesma:

{"error":"Tipo inválido para o parâmetro 'activate_tracking'. Tipo esperado '<type 'bool'>'"}

Uso do parâmetro 'send_at'

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,
    'use_tpl_default_email': True,
    'use_tpl_default_name': True,
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>'
    ],
    'send_at': '2030-01-01 12:12:12', | - Parâmetro usado para agendar o envio de email
}

Caso o valor desse parâmetro for qualquer coisa diferente de um unicode/string essa será a resposta:

{"error":"Tipo inválido para o parâmetro 'send_at'. Tipo esperado '<type 'unicode'>'"}

Se o valor for não seguir o formato 'YYYY-MM-DD HH:mm:ss'

{"error":"O valor do parâmetro 'send_at' é inválido. Formato incorreto para data, deveria ser 'YYYY-MM-DD HH:mm:ss', exemplo '2019-01-01 23:59:59'"}

Uso dos parâmetros de rastreio individuais 'track_open', 'track_html_link', 'track_text_link'

Obs.: são parâmetros usados para rastreio sem a necessidade de rastrear tudo. Portanto, é possível desligar o rastreio de cliques, e manter apenas a visualização.

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,
    'use_tpl_default_email': True,
    'use_tpl_default_name': True,
    'track_open': True,         | - parâmetro para rastrear a visualização
    'track_html_link': True,    | - parâmetro para rastrear o clique dos links no html
    'track_text_link' True,     | - parâmetro para rastrear o clique dos links no texto
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>'
    ],

}

Se o valor desses parâmetros for qualquer coisa diferente de um booleano, a resposta será sempre a mesma:

{"error":"Tipo inválido para o parâmetro 'track_open'. Tipo esperado '<type 'bool'>'"} {"error":"Tipo inválido para o parâmetro 'track_html_link'. Tipo esperado '<type 'bool'>'"}

Uso do parâmetro 'headers'

Obs.: este é um parâmetro usado para que se o destinatário quiser responder a mensagem, ele irá responder a outro remetente.

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,
    'use_tpl_default_email': True,
    'use_tpl_default_name': True,
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>'
    ],
    'headers': {'Reply-To': 'Nano <foo@alterdata.com.br>'}
}

Caso o valor desse parâmetro for qualquer um dos abaixo, todos terão a mesma resposta, que segue:

'headers': {'Reply-To': 123}
'headers': {'Reply-To': '123'}
'headers': {'Reply-To': False}
'headers': {'Reply-To': 'Nano foo@alterdata.com.br'}

{"error":"O valor do parâmetro 'headers' é inválido. O parâmetro \"Reply-To\" tem que seguir o formato \"Nome <email>\"."}

Uso dos parâmetros 'context' e 'context_per_recipient'

Obs.: esses parâmetros servem para adicionar valores dinâmicos no conteúdo.

{
    'template_slug': 'tpl-teste',
    'use_tpl_default_subject': True,
    'use_tpl_default_email': True,
    'use_tpl_default_name': True,
    'recipient_list': [
        'Thiago do Cirrus <thiago.dsn.cir@alterdata.com.br>',
        'Alexandro do Cirrus <alexandro.dsn.cir@alterdata.com.br>'
    ],
    'context': {'NAME': 'Teste teste testando'},
    'context_per_recipient': {
        'thiago.dsn.cir@alterdata.com.br': {'BIRTHDAY': '12/12'},
        'alexandro.dsn.cir@alterdata.com.br': {'BIRTHDAY': '11/11'},
    },
}

Se o formato do parâmetro 'context_per_recipient' não for válido a resposta é a seguinte:

{"error":"O valor do parâmetro 'context_per_recipient' é inválido. O formato para o parâmetro de 'context_per_recipient' está incorreto. O formato esperado é {'EMAIL_DO_DESTINATARIO': {'NOME_VARIAVEL': 'valor da variavel'} }"}