Skip to main content
POST
/
branded-links
Create a branded link
curl --request POST \
  --url https://api.reply.io/v3/branded-links \
  --header 'X-API-Key: <api-key>'
{
  "id": 12345,
  "domain": "links.company.com",
  "status": "Active",
  "verificationRecord": {
    "type": "TXT",
    "host": "_reply-verify.links.company.com",
    "value": "reply-verification=abc123def456"
  },
  "created": "2024-03-08T10:00:00Z",
  "lastVerificationAttempt": "2024-03-08T10:05:00Z",
  "isDefault": true
}

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header

Response

201 - application/json

Branded link created successfully

​
id
integer
required

Unique identifier for the branded link

​
domain
string<hostname>
required

Domain name for the branded link

​
status
enum<string>
required

Current status of the domain verification

Available options:
Active,
Pending,
Failed
​
verificationRecord
object
required

DNS record information required for domain verification

​
created
string<date-time>

Date when the branded link was created

​
lastVerificationAttempt
string<date-time>

Date of the last verification attempt

​
isDefault
boolean

Whether this is the default branded domain

​
errorMessage
string

Error message if verification failed