Add domain

This method allows you to add new domains with a limit to create a maximum of 1000 domains in a day.

post/email/1/domains

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Request body

domainNamestring required

Unique name for the domain.

dkimKeyLength1024 | 2048

Value for DKIM key length.

targetedDailyTrafficinteger required

Targeted daily traffic.

applicationIdstring

Required for application use in a send request for outbound traffic. Returned in notification events.

entityIdstring

Required for entity use in a send request for outbound traffic. Returned in notification events.

Example request

{
  "domainName": "example.com",
  "dkimKeyLength": 1024,
  "targetedDailyTraffic": 1000
}

Response

domainIdinteger

Id of the domain.

domainNamestring

Name of the domain.

activeboolean

Activation status of the domain.

blockedboolean

Status if the domain is blocked.

createdAtstring date-time

Date the domain was created. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

blocklistConfigurationLevel'FROM_SENDER' | 'FROM_DOMAIN'

Defines the level at which Infobip stores unsubscribe preferences.

Note: When you change the unsubscribe configuration from a more global level (such as FROM_DOMAIN) to a more specific level (such as FROM_SENDER), remember that anyone who previously unsubscribed at the domain level chose to stop receiving all messages from your domain. These existing unsubscribe records will not automatically update to reflect the new sender-level setting. As a result, individuals who unsubscribed from your domain will continue to not receive messages, even after the change. To prevent confusion and respect user preferences, carefully manage and, if necessary, update these records when altering unsubscribe settings.

brandedDomainNamestring

Branded tracking domain name assigned to the domain.

Example response

{
  "domainId": 1,
  "domainName": "example.com",
  "createdAt": "2021-01-02T01:00:00.123Z",
  "blocklistConfigurationLevel": "FROM_SENDER",
  "brandedDomainName": "branded.example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.