POST
/
v1
/
public
/
accounts
/
{account_id}
/
domains
/
purchase
Purchase Domains
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/domains/purchase \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_info": {
    "address_1": "<string>",
    "city": "<string>",
    "country": "<string>",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "organization": "<string>",
    "phone": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "domains": [
    "<string>"
  ],
  "workspace_id": "<string>"
}
'
{
  "results": [
    {
      "domain_name": "<string>",
      "status": "<string>",
      "error": "<string>",
      "error_code": "<string>",
      "id": "<string>"
    }
  ],
  "currency": "<string>",
  "estimated_total": "<string>",
  "failed_count": 0,
  "payment_url": "<string>",
  "purchase_batch_id": "<string>",
  "successful_count": 0
}

Authorizations

​
Authorization
string
header
required

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Path Parameters

​
account_id
string<uuid>
required

Body

application/json

Schema for purchasing one or more domains.

​
contact_info
ContactInfo · object
required

Schema for domain registrant contact information.

​
domains
string[]
required
Minimum array length: 1
​
workspace_id
string<uuid4>
required

Response

​
results
DomainPurchaseResult · object[]
required
​
currency
string | null
​
estimated_total
string | null
​
failed_count
integer
default:0
​
payment_url
string | null
​
purchase_batch_id
string | null
​
successful_count
integer
default:0