Domains

Returns Domains on Mailgun Optimize services

Will return details on an Mailgun Optimize Domain. If no Domain is provided, then a list of all Mailgun Optimize Domains on an account will be returned.

SecuritybasicAuth
Request
query Parameters
domain
string

Domain name

Responses
200

A 200 response

Response Schema: application/json
required
Array of objects
object
default

A default response

get/v1/inboxready/domains
Request samples
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "paging": {}
}

Add a single domain to an account

SecuritybasicAuth
Request
query Parameters
domain
required
string

Domain name

Responses
200

A 200 response

Response Schema: application/json
message
required
string
required
object
default

A default response

post/v1/inboxready/domains
Request samples
Response samples
application/json
{
  • "message": "The domain has been added",
  • "domain": {
    • "verified": {
      },
    • "services": {
      },
    • "txt_record": "IR-hashed-txt-record-key",
    • "ID": "ObjectID(\"000000000000000000000000\")",
    • "name": "domain.tld"
    }
}

Deletes a single domain from an account

SecuritybasicAuth
Request
query Parameters
domain
required
string

Domain name

Responses
200

A 200 response

Response Schema: application/json
message
required
string
default

A default response

delete/v1/inboxready/domains
Request samples
Response samples
application/json
{
  • "message": "domain.tld has been removed from Mailgun Optimize"
}

Queues a domain to be processed for verification

SecuritybasicAuth
Request
query Parameters
domain
required
string

Domain name

Responses
200

A 200 response

Response Schema: application/json
message
required
string
400

A 400 response

404

A 404 response

default

A default response

put/v1/inboxready/domains/verify
Request samples
Response samples
application/json
{
  • "message": "Domain pending verification"
}