Domain Tracking

Get tracking status

get/v3/domains/{name}/tracking

Use to check if open, click and unsubscribe tracking are active/inactive.

SecuritybasicAuth
Request
path Parameters
name
required
string

The name of the domain to fetch tracking details for.

Responses
200

A 200 response

Response Schema: application/json
required
object
required
object
required
object
required
object
401

A 401 response

404

A 404 response

Request samples 
Response samples 
application/json
{
  • "tracking": {
    • "click": {
      },
    • "unsubscribe": {
      },
    • "open": {
      }
    }
}
Update click tracking settings
put/v3/domains/{name}/tracking/click
Use to turn on/off the click tracking at the domain level.


SecuritybasicAuth 
Request 
path Parameters
name
required
string
The name of the domain you want to update


 
Request Body schema: multipart/form-data
required
active
string
Set param to htmlonly, true, or false.  Omit this param to make no change to the active status. Click tracking is consider as active if it's in the 'htmlonly' or 'true' state


 
Responses 
200
A 200 response


Response Schema: application/json
message
required
string
 
required
object
 
401
A 401 response


404
A 404 response


Request samples 
Response samples 
application/json
{
  • "message": "Domain tracking settings have been updated",
  • "click": {
    • "active": true
    }
}
Update open tracking settings
put/v3/domains/{name}/tracking/open
Use to turn on/off the open tracking at the domain level.


SecuritybasicAuth 
Request 
path Parameters
name
required
string
The name of the domain you want to update


 
Request Body schema: multipart/form-data
required
place_at_the_top
boolean
Setting this param to true will place the open tracking pixel at the top of the HTML body when inserted into the email mime. Omit this param to keep current setting.


 
active
boolean
Set this param to true or false to toggle open tracking active status. Omit this param to keep current settings.


 
Responses 
200
A 200 response


Response Schema: application/json
message
required
string
 
required
object
 
401
A 401 response


404
A 404 response


Request samples 
Response samples 
application/json
{
  • "message": "Domain tracking settings have been updated",
  • "open": {
    • "active": true
    }
}
Update unsubscribe tracking settings
put/v3/domains/{name}/tracking/unsubscribe
Use to turn on/off the unsubscribe tracking at the domain level.


SecuritybasicAuth 
Request 
path Parameters
name
required
string
The name of the domain you want to update


 
Request Body schema: multipart/form-data
required
text_footer
string
Updates the text footer for the unsubscribe link inserted into the email plain part of the mime.


 
active
boolean
This param will toggle the active status of unsubscribe tracking on the domain.


 
html_footer
string
Updates the html footer for the unsubscribe link inserted into the email html part of the mime.


 
Responses 
200
A 200 response


Response Schema: application/json
message
required
string
 
required
object
 
401
A 401 response


404
A 404 response


Request samples 
Response samples 
application/json
{
  • "message": "Domain tracking settings have been updated",
  • "unsubscribe": {
    • "active": true,
    • "html_footer": "<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
    • "text_footer": "To unsubscribe click: <%unsubscribe_url%>\n\n"
    }
}
Cookie PolicyGDPR Email ComplianceAcceptable Use PolicyTerms of ServicePrivacy Policy
© 2024 Sinch Mailgun. All rights reserved.