How do I add a domain using the Vercel API?

With the Vercel API, you can add domains to your Vercel accounts by sending a POST request to this endpoint: https://api.vercel.com/v4/domains. To test a POST request to this endpoint, you can use the curl command in the terminal. You will also need to add a testing token inside your POST request.

Personal Account

Here is an example request for adding a domain to a Vercel personal account.

curl -X POST "https://api.vercel.com/v4/domains" \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example.com"
}'

Adding example.com to your Vercel personal account.

Team Account

First, you will need to obtain the team ID using a GET request to this endpoint: https://api.vercel.com/v1/teams.

curl "https://api.vercel.com/v1/teams" \
  -H "Authorization: Bearer TOKEN"

Listing all the teams associated with your Vercel personal account.

Here is an example request for adding a domain to a Vercel team account.

curl -X POST "https://api.vercel.com/v4/domains?teamId=TEAM_ID" \
  -H "Authorization: Bearer TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example.com"
}'

Adding example.com to a Vercel team account.

Note:

Make sure to completely replace TOKEN and TEAM_ID with their respective token and ID before making a Vercel API request.

Updated October 14th 2020