POST /v1/registrar/domains/{domain}/buy

Buy a domain

Servers

Path parameters

Name Type Required Description
domain String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

Request body fields

Name Type Required Description
expectedPrice Number Yes

The expected price for the domain. Use the Get price data for a domain endpoint to retrieve the price data for a domain.

years Number Yes

The number of years to purchase the domain for.

autoRenew Boolean Yes

Whether the domain should be auto-renewed before it expires. This can be configured later through the Vercel Dashboard or the Update auto-renew for a domain endpoint.

contactInformation Object Yes

The contact information for the domain. Some TLDs require additional contact information. Use the Get contact info schema endpoint to retrieve the required fields.

contactInformation.address2 String No

a non empty string

contactInformation.address1 String Yes

a non empty string

contactInformation.state String Yes

a non empty string

contactInformation.city String Yes

a non empty string

contactInformation.companyName String No

a non empty string

contactInformation.email String Yes

a non empty string

contactInformation.fax String No

A valid E.164 phone number

contactInformation.lastName String Yes

a non empty string

contactInformation.zip String Yes

a non empty string

contactInformation.phone String Yes

A valid E.164 phone number

contactInformation.firstName String Yes

a non empty string

contactInformation.country String Yes

A valid ISO 3166-1 alpha-2 country code

contactInformation.additional Object No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.