# Inbox Placement

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

## List Seed Lists

 - [GET /v4/inbox/seedlists](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-seedlists.md)

## Generate a New Seed List

 - [POST /v4/inbox/seedlists](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/post-v4-inbox-seedlists.md)

## List Available Attributes for Seed Lists

 - [GET /v4/inbox/seedlists/a](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-seedlists-a.md)

## Get List of Values for Seed List Attribute

 - [GET /v4/inbox/seedlists/a/{attribute}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-seedlists-a--attribute-.md)

## Get List of Available Seed List Filters

 - [GET /v4/inbox/seedlists/_filters](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-seedlists--filters.md)

## Get Seed List

 - [GET /v4/inbox/seedlists/{address}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-seedlists--address-.md)

## Update Seed List

 - [PUT /v4/inbox/seedlists/{address}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/put-v4-inbox-seedlists--address-.md)

## Delete a Seed List

 - [DELETE /v4/inbox/seedlists/{address}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/delete-v4-inbox-seedlists--address-.md)

## List Results

 - [GET /v4/inbox/results](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-results.md): Get the details for all placement test results.

## List Available Attributes for Results

 - [GET /v4/inbox/results/a](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-results-a.md): The attributes that can have values listed (for autocomplete).

## Get List of Values for a Result Attribute

 - [GET /v4/inbox/results/a/{attribute}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-results-a--attribute-.md): For the given attribute list the known values (for autocomplete).

## List available filters for Results

 - [GET /v4/inbox/results/_filters](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-results--filters.md): The filters that can be used when querying for results.

## Get Result Details

 - [GET /v4/inbox/results/{result}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-results--result-.md): Get the details for a single result.

## Delete Result

 - [DELETE /v4/inbox/results/{result}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/delete-v4-inbox-results--result-.md): Delete the result and all associated information.

## Get Result Sharing Status

 - [GET /v4/inbox/sharing/{result}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-sharing--result-.md): The sharing status of a result.

## Update Result Sharing Status

 - [PUT /v4/inbox/sharing/{result}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/put-v4-inbox-sharing--result-.md): Change the sharing status of a result or create a new share URL

## Get Result by a Share ID

 - [GET /v4/inbox/sharing/public/{shareid}](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-sharing-public--shareid-.md): Get a result by the share ID.

## Run Inbox Placement Test

 - [POST /v4/inbox/tests](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/post-v4-inbox-tests.md): 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%.

## List Email Providers

 - [GET /v4/inbox/providers](https://documentation.mailgun.com/docs/inboxready/api-reference/openapi-final/inbox-placement/get-v4-inbox-providers.md): List all available email providers.