Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

List Seed Lists

SecuritybasicAuth
Request
query Parameters
time_after
string
time_before
string
name
string
cursor
string
sort
string
offset
integer
ascending
boolean
limit
integer
Responses
200

A 200 response

Response Schema: application/json
property name*
additional property
object
get/v4/inbox/seedlists
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "total": 1
}
Generate a New Seed List
SecuritybasicAuth 
Request 
query Parameters
sending_domains
string
Deprecated.


 
name
string
 
provider_filter
string
Array of provider domains. Omitting means all providers.


 
remote_id
string
 
Responses 
200
A 200 response


Response Schema: application/json
kid
required
string
 
created_at
required
string <date-time> 
 
updated_at
required
string <date-time> 
 
last_result_at
required
string <date-time> 
 
target_email
required
string
 
sending_domains
required
Array of strings
 
has_results
required
boolean
 
name
required
string
 
seed_filter
required
string
 
provider_filter
required
Array of strings
[] means all providers; null means that only seed_filter is used


 
mailing_list
required
string
 
previous_mailing_list
required
string
List before last regen


 
required
object
 
is_auto_generated
required
boolean
 
version
required
integer <int32> 
 
regen_needed
required
boolean
 
regen_at
required
string <date-time> 
 
object
 
post/v4/inbox/seedlists
Request samples 
Response samples 
application/json
{
  • "created_at": "0001-01-01 00:00:00 +0000 UTC",
  • "updated_at": "0001-01-01 00:00:00 +0000 UTC",
  • "last_result_at": "0001-01-01 00:00:00 +0000 UTC",
  • "regen_at": "0001-01-01 00:00:00 +0000 UTC"
}
List Available Attributes for Seed Lists
SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/seedlists/a
Request samples 
Response samples 
application/json
null
Get List of Values for Seed List Attribute
SecuritybasicAuth 
Request 
path Parameters
attribute
required
string
 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/seedlists/a/{attribute}
Request samples 
Response samples 
application/json
null
Get List of Available Seed List Filters
SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/seedlists/_filters
Request samples 
Response samples 
application/json
null
Get Seed List
SecuritybasicAuth 
Request 
path Parameters
address
required
string
 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
404
A 404 response


get/v4/inbox/seedlists/{address}
Request samples 
Response samples 
application/json
null
Update Seed List
SecuritybasicAuth 
Request 
path Parameters
address
required
string
 
query Parameters
name
string
 
provider_filter
string
Array of provider domains. Omitting means no changes.


 
regen
boolean
Regenerate the mailing_list. Only for v2 Seed List.


 
sending_domains
string
Deprecated.


 
Responses 
200
A 200 response


Response Schema: application/json
kid
required
string
 
created_at
required
string <date-time> 
 
updated_at
required
string <date-time> 
 
last_result_at
required
string <date-time> 
 
target_email
required
string
 
sending_domains
required
Array of strings
 
has_results
required
boolean
 
name
required
string
 
seed_filter
required
string
 
provider_filter
required
Array of strings
[] means all providers; null means that only seed_filter is used


 
mailing_list
required
string
 
previous_mailing_list
required
string
List before last regen


 
required
object
 
is_auto_generated
required
boolean
 
version
required
integer <int32> 
 
regen_needed
required
boolean
 
regen_at
required
string <date-time> 
 
object
 
404
A 404 response


put/v4/inbox/seedlists/{address}
Request samples 
Response samples 
application/json
{
  • "updated_at": "0001-01-01 00:00:00 +0000 UTC",
  • "created_at": "0001-01-01 00:00:00 +0000 UTC",
  • "last_result_at": "0001-01-01 00:00:00 +0000 UTC",
  • "regen_at": "0001-01-01 00:00:00 +0000 UTC"
}
Delete a Seed List
SecuritybasicAuth 
Request 
path Parameters
address
required
string
 
Responses 
200
A 200 response


404
A 404 response


delete/v4/inbox/seedlists/{address}
Request samples 
Response samples 
application/json
{
  • "Description": "string"
}
List Results
Get the details for all placement test results.


SecuritybasicAuth 
Request 
query Parameters
sender
string
 
subject
string
 
provider
string
 
target_email
string
 
time_after
string
 
time_before
string
 
cursor
string
 
sort
string
 
offset
integer
 
ascending
boolean
 
limit
integer
 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/results
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ],
  • "total": 1
}
List Available Attributes for Results
The attributes that can have values listed (for autocomplete).


SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/results/a
Request samples 
Response samples 
application/json
null
Get List of Values for a Result Attribute
For the given attribute list the known values (for autocomplete).


SecuritybasicAuth 
Request 
path Parameters
attribute
required
string
 
query Parameters
sender
string
 
subject
string
 
provider
string
 
target_email
string
 
time_after
string
 
time_before
string
 
cursor
string
 
sort
string
 
offset
integer
 
ascending
boolean
 
limit
integer
 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/results/a/{attribute}
Request samples 
Response samples 
application/json
null
List available filters for Results
The filters that can be used when querying for results.


SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
get/v4/inbox/results/_filters
Request samples 
Response samples 
application/json
null
Get Result Details
Get the details for a single result.


SecuritybasicAuth 
Request 
path Parameters
result
required
string
 
query Parameters
provider
string
 
Responses 
200
A 200 response


Response Schema: application/json
property name*
additional property
object
 
404
A 404 response


get/v4/inbox/results/{result}
Request samples 
Response samples 
application/json
null
Delete Result
Delete the result and all associated information.


SecuritybasicAuth 
Request 
path Parameters
result
required
string
 
query Parameters
provider
string
 
Responses 
200
A 200 response


404
A 404 response


500
A 500 response


delete/v4/inbox/results/{result}
Request samples 
Response samples 
application/json
{
  • "message": "string"
}
Get Result Sharing Status
The sharing status of a result.


SecuritybasicAuth 
Request 
path Parameters
result
required
string
 
Responses 
200
A 200 response


Response Schema: application/json
result_id
required
string
 
expires_at
required
string <date-time> 
 
enabled
required
boolean
 
url_id
required
string
 
url
required
string
 
api_url
required
string
 
404
A 404 response


get/v4/inbox/sharing/{result}
Request samples 
Response samples 
application/json
{
  • "expires_at": "0001-01-01 00:00:00 +0000 UTC"
}
Update Result Sharing Status
Change the sharing status of a result or create a new share URL


SecuritybasicAuth 
Request 
path Parameters
result
required
string
 
query Parameters
enabled
required
boolean
 
Responses 
200
A 200 response


Response Schema: application/json
result_id
required
string
 
expires_at
required
string <date-time> 
 
enabled
required
boolean
 
url_id
required
string
 
url
required
string
 
api_url
required
string
 
404
A 404 response


put/v4/inbox/sharing/{result}
Request samples 
Response samples 
application/json
{
  • "expires_at": "0001-01-01 00:00:00 +0000 UTC"
}
Get Result by a Share ID
Get a result by the share ID.


SecuritybasicAuth 
Request 
path Parameters
shareid
required
string
 
Responses 
200
A 200 response


Response Schema: application/json
rid
required
string
 
result_id
required
string
 
keybox_email
required
string
 
subject
required
string
 
sender
required
string
 
seedlist_name
required
string
 
created_at
required
string <date-time> 
 
updated_at
required
string <date-time> 
 
status
required
string
 
required
object
 
campaign_id
required
string
 
sharing_enabled
required
boolean
 
sharing_id
required
string
 
sharing_expires_at
required
string <date-time> 
 
required
Array of objects
 
required
object
 
required
object
 
body
required
string
Only for GET /inbox/results/{result}


 
404
A 404 response


get/v4/inbox/sharing/public/{shareid}
Request samples 
Response samples 
application/json
{
  • "BasicTestResult": {
    • "sharing_expires_at": "0001-01-01 00:00:00 +0000 UTC",
    • "created_at": "0001-01-01 00:00:00 +0000 UTC",
    • "updated_at": "0001-01-01 00:00:00 +0000 UTC"
    }
}
Run Inbox Placement Test
Create and run a new inbox placement test. 


Either 'html' or 'template_name' field should be provided.


'variables' are Template variables,
which could be used in html or template.
You can use next recipient variables inside Template variables, 
which will be filled for every seed automatically:
%recipient.first_name%, %recipient.last_name%.


SecuritybasicAuth 
Request 
Request Body schema: application/json
required
from
required
string
 
subject
required
string
 
provider_filter
Array of strings
missing/null/[] means all providers


 
html
string
 
template_name
string
template from Mailgun Send


 
object
 
seed_list
string
Use existing Seed List. If omitted creates new Seed List


 
Responses 
202
A 202 response


400
A 400 response


404
A 404 response


post/v4/inbox/tests
Request samples 
application/json
{
  • "from": "First Last <mail@example.com>",
  • "subject": "Buy our elephants",
  • "seed_list": "ibp-123@mailgun.com",
  • "template_name": "template1",
  • "variables": {
    • "first_name": "%recipient.first_name%",
    • "last_name": "%recipient.last_name%",
    • "address": "108, Robinson Ave, Richmond"
    },
  • "provider_filter": [
    • "gmail.com",
    • "hotmail.com"
    ],
  • "html": "<html><body>Hello {{first_name}} {{last_name}}. Visit our new shop at {{address}}. <b>Our elephants are the best.</b> </body></html>"
}
Response samples 
application/json
{}
List Email Providers
List all available email providers.


SecuritybasicAuth 
Responses 
200
A 200 response


Response Schema: application/json
required
Array of objects
 
 Array 
domain
required
string
 
display_name
required
string
 
region
required
string
 
created_at
required
string <date-time> 
 
updated_at
required
string <date-time> 
 
max_email_count
required
integer <int32> 
 
seeds_limit
required
integer <int32> 
 
required
object
 
virtual
required
boolean
 
get/v4/inbox/providers
Request samples 
Response samples 
application/json
{
  • "items": [
    • {
      }
    ]
}
Cookie PolicyGDPR Email ComplianceAcceptable Use PolicyTerms of ServicePrivacy Policy
© 2024 Sinch Mailgun. All rights reserved.