Skip to main content
PUT
/
v1
/
domains
/
{id}
Update domain
curl --request PUT \
  --url https://api.shingleai.com/v1/domains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "source": "registered",
  "status": "active",
  "zoneId": "<string>",
  "data": {},
  "verificationAttempts": 1,
  "verificationStatus": "pending",
  "verifiedAt": "2023-11-07T05:31:56Z",
  "verificationToken": "<string>",
  "verificationExpiresAt": "2023-11-07T05:31:56Z",
  "resendApiKey": "<string>",
  "resendEmailEnabled": true,
  "resendFromEmail": "<string>",
  "resendDomainId": "<string>",
  "resendDomainRecords": [
    {
      "record": "SPF",
      "name": "<string>",
      "value": "<string>",
      "type": "MX",
      "ttl": "<string>",
      "priority": 123
    }
  ]
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "source": "<string>",
    "status": "<string>",
    "zoneId": "<string>",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "data": {},
    "verificationAttempts": 123,
    "verificationStatus": "<string>",
    "verifiedAt": "2023-11-07T05:31:56Z",
    "verificationToken": "<string>",
    "verificationExpiresAt": "2023-11-07T05:31:56Z",
    "resendApiKey": "<string>",
    "resendEmailEnabled": true,
    "resendFromEmail": "<string>",
    "resendDomainId": "<string>",
    "resendDomainRecords": [
      "<unknown>"
    ]
  },
  "meta": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "hasMore": true,
      "total": 123
    }
  }
}

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Path Parameters

id
string<uuid>
required

Domain UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
domain
string
source
enum<string>
Available options:
registered,
verified
status
enum<string>
Available options:
active,
expiring,
expired,
pending
zoneId
string | null
data
object
verificationAttempts
integer
Required range: x >= 0
verificationStatus
enum<string>
Available options:
pending,
verified,
failed
verifiedAt
string<date-time> | null
verificationToken
string | null
verificationExpiresAt
string<date-time> | null
resendApiKey
string | null
resendEmailEnabled
boolean
resendFromEmail
string | null
resendDomainId
string | null
resendDomainRecords
object[] | null
  • Option 1
  • Option 2

Response

Domain updated successfully

data
object
required
meta
object