API Documentation

API Endpoint

Custom domain

Custom domains

Supported filter params

  • id

  • name

GET /api/v2/custom_domains
Requestsreturns custom domains

GET  /api/v2/custom_domains

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "custom_domains",
      "attributes": {
        "name": "areto.com",
        "verified_at": null,
        "email_sender_name": null,
        "email_sender_address": null,
        "mailgun_dkim": "DKIM",
        "mailgun_spf": "SPF",
        "mailgun_mx": [
          "mxa.mailgun.org",
          "mxb.mailgun.org"
        ],
        "allow_user_email": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "259"
          }
        },
        "subsidiaries": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/custom_domains?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/api/v2/custom_domains?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200
  }
}

Get custom domains
GET/api/v2/custom_domains

GET /api/v2/custom_domains/1
Requestsreturns custom domain

GET  /api/v2/custom_domains/2

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "custom_domains",
    "attributes": {
      "name": "areto.com",
      "verified_at": null,
      "email_sender_name": null,
      "email_sender_address": null,
      "mailgun_dkim": "DKIM",
      "mailgun_spf": "SPF",
      "mailgun_mx": [
        "mxa.mailgun.org",
        "mxb.mailgun.org"
      ],
      "allow_user_email": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "260"
        }
      },
      "subsidiaries": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

Gets a custom domain
GET/api/v2/custom_domains/{id}

URI Parameters
HideShow
id
number (required) Example: 1

custom domain id

name
string (required) Example: productive.io

custom domain name

POST /api/v2/custom_domains
Requestscreates a custom domainreturns error

POST  /api/v2/custom_domains

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_domains",
    "attributes": {
      "name": "productive.io",
      "email_type_id": 1
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4",
    "type": "custom_domains",
    "attributes": {
      "name": "productive.io",
      "verified_at": null,
      "email_sender_name": null,
      "email_sender_address": null,
      "mailgun_dkim": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxhSVoPVPEPfsb8I+B8n2V9cmIbCKQQF2DrjDEMhhOyD1rcq4Hh7C4Nyb/e42phDj4EmIjRc1notcetepg2hIKE++uLBw+C8n81cLuB1KVvrtANHvWRvofF4dgbi88Qgd6LlUVIA8topWA+NNk03Qfal9jJnsrkc/xe8yZNXsOmwIDAQAB",
      "mailgun_spf": "v=spf1 include:mailgun.org ~all",
      "mailgun_mx": [
        "mxa.mailgun.org",
        "mxb.mailgun.org"
      ],
      "allow_user_email": false
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": "261"
        }
      },
      "subsidiaries": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "meta": {}
}

POST  /api/v2/custom_domains

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_domains",
    "attributes": {
      "email_type_id": 1
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Create a custom domain
POST/api/v2/custom_domains

URI Parameters
HideShow
name
string (required) Example: Name

name

emial_type_id
number (required) Example: 1

custom domain email type id

DELETE /api/v2/custom_domains/1
Requestsdeletes a custom_domain

DELETE  /api/v2/custom_domains/7

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a custom domain
DELETE/api/v2/custom_domains/{id}

URI Parameters
HideShow
id
number (required) Example: 1

custom domain id

name
string (required) Example: productive.io

custom domain name

Generated by aglio on 02 Aug 2025