Send message

Post /messages/send

Parameters:

Name

Description

Type

Mandatory

An array of recipient information

Name	Description	Type	Mandatory
address		String	Yes
personalName		String	No

Array

Yes

msg

Name

Description

Type

Mandatory

from

Name	Description	Type	Mandatory
address		String	Yes
personalName		String	No

Struct

subject

String

replyTo

Name	Description	Type	Mandatory
address		String	Yes
personalName		String	No

Struct

html

String

text

String

attachments

Name	Description	Type	Mandatory
content	Encoded on base 64	String	No
filename		String	No
type	Mime type	String	No

Array

images

Name	Description	Type	Mandatory
contentType	Encoded on base 64	String	No
filename		String	No
type	Mime type	String	No
contentId	Content Id where to place the image	String	No

Array

Struct

Yes

headers

Header on JSON format

Struct

apiKey

Id of the api key used to send emails. If empty, we used apikey from authentication

String

Response:

Name	Description	Type
status	success / failure	String

PHP : With a dedicated library

Attention : the following PHP code require to install the Tipimail's library. For this, download and install 'Composer' and then in the folder where your script is saved, execute in the terminal console the following line : composer require tipimail/tipimail

Programming language:

Request exemple:

{
    "to": [
        {
            "address":"to1@example.com",
            "personalName":"Nameto1"
        },
        {
            "address":"to2@example.com",
            "personalName":"Nameto2"
        }
    ],
    "msg": {
        "from": {
            "personalName": "Fromname",
            "address": "from@example.com"
        },
        "replyTo": {
            "personalName": "Replytoname",
            "address": "reply@example.com"
        },
        "subject": "Subject",
        "text": "Text content",
        "html": "<p>Html content</p>",
        "images": [
            {
                "contentType": "image/png",
                "filename": "IMAGECID",
                "content": "azerty"
            }
        ],
        "attachments": [
            {
                "contentType": "text/plain",
                "filename": "myfile.txt",
                "content": "azerty"
            }
        ],
    },
    "headers": {
        "X-TM-META":
        {
            "orderId": 123456789,
            "shipmentId": 123456789
        },
        "X-TM-SUB":
        [
            {
                "email":"email1@example.com",
                "values":
                {
                    "firstName": "Name1",
                    "uniqueId": 132456798
                }
            },
            {
                "email":"email2@example.com",
                "values":
                {
                    "subject": "mon mail numero 2",
                    "firstName": "Name2",
                    "meta":
                    {
                        "uniqueId": 987654321,
                        "orderId": 132456798,
                        "shipmentId": 1237498798
                    }
                }
            }
        ],
        "X-TM-TAGS": ["welcome", "website1"]
    }
}

Response exemple:

{
    "status": "success"
}