Track link clicks

For tracking link clicks with a REST API, you need to send a request to the endpoint https://in-automate.brevo.com/api/v2/trackLink with the POST method. This endpoint allows you to get information about the link click. You can consult the sample cURL request below.

curl --request POST \
     --url https://in-automate.brevo.com/api/v2/trackLink \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'ma-key: ' \
     --data '
{
  "properties": {
    "newKey": "New Value"
  },
  "email": "[email protected]",
  "link": "abc.com/document.pdf"
}
'

The attributes for this endpoint are mentioned below.

Attribute	Datatype	Description	Value
`email`	String	Email address to identify the user	[email protected]
`link`	String	Link to be tracked	abc.com/document.pdf
`properties`	Object	This object will contain all your custom fields. Add as many as needed. Keep in mind that those user properties will populate your database on the Marketing Automation platform to create rich scenarios	New field containing (newKey, newValue). The key and value can be any (WebPage Name, Payment Page)

Response

For the response, we have a table to show the response codes below.

Response code	Message	Description
`204`	Link have been tracked successfully	No content is shown in message which shows link has been tracked
`400`	Bad request	Bad request due to invalid, missing or out_of_range parameters