Skip to content
Tallyraydocs

Add a custom tracking domain, pending, with the CNAME and TXT records to add to its DNS: your workspace's owner

POST
/v1/buyer/domains
curl --request POST \
  --url https://example.com/v1/buyer/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "host": "example", "root_redirect_url": "example" }'

Who: a workspace’s owner. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
<= 64 characters

Made once per action and sent again on every retry of it, so the service acts once: the request_id of the create or money-moving call; a new one when left out

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
host
string
root_redirect_url
string | null

Example generated

{
  "host": "example",
  "root_redirect_url": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
certificate
required
Any of:
object
issuer
required
string
not_after
required
string format: date-time
not_before
required
string format: date-time
renew_at
required
string format: date-time
serial_number
required
string
certificate_error
required
string
check_error
required
string
cname_target
required
string
created_at
required
string format: date-time
host
required
string
id
required
integer format: int64
last_checked_at
required
string | null format: date-time
next_check_at
required
string | null format: date-time
root_redirect_url
required
string
sequence
required
integer format: int64
status
required
string | null
Allowed values: pending verified active failed
txt_name
required
string
txt_value
required
string
updated_at
required
string format: date-time
verified_at
required
string | null format: date-time
workspace_id
required
integer format: int64

Example 

{
  "status": "pending"
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}