SIsinch
Domains

Create a domain

Changed on

Creates a new domain on the specified service to host email templates.

post/v3/projects/{projectId}/services/{serviceId}/domains/{domainName}

Request

  • Base URL
    https://fax.api.sinch.com
  • URL
    https://fax.api.sinch.com/v3/projects/{projectId}/services/{serviceId}/domains/{domainName}
  • Auth
    • HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://auth.sinch.com/oauth2/token

Path parameters

serviceIdstring required
Example:01GVRB50KEQFFE1SGMPFRNBG6J

The serviceId where you want to create a domain.

domainNamestring required
Example:yourdomain.com

The name of the domain to create.

Response

The created domain.

resultstring

The result of the create domain operation.

Example response

{
  "result": "domain and route created",
  "records": {
    "receivingRecords": [
      {
        "priority": 10,
        "recordType": "TXT",
        "valid": "valid",
        "value": "mailgun.org"
      }
    ],
    "sendingRecords": [
      {
        "name": "my.domain.com",
        "recordType": "TXT",
        "valid": "valid",
        "value": "mailgun.org"
      }
    ]
  }
}

Changes