Hold a domain

Reserve this listing inside the directory. It requires a reveal of the same listing by this account first (`POST /domains/{id}/reveal`), never spends one, and refuses with `hold_code` `HELD_BY_OTHER` while somebody else holds it, `HOLD_CAP_REACHED` at the plan's ceiling, or `HOLD_COOLDOWN` for 30 days after YOUR OWN hold on that listing ends — another account's ended hold never blocks you, and the listing is free the moment their window closes. A hold reserves the listing here and nothing else: registrability on the open internet is not guaranteed.

POST/api/v1/domains/{id}/hold

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstringrequired

A listing id, exactly as the feed issued it: eight characters, CASE-SENSITIVE — `00aLaXEG`, not `00alaxeg`.

Example: 00aLaXEG

Responses

The hold. Returned unchanged when this account already holds the listing — taking a hold you already have is not a second hold.

holdobjectrequired

holdsobjectrequired

curl --request POST \
  --url "https://getrevised.com/api/v1/domains/00aLaXEG/hold" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://getrevised.com/api/v1/domains/00aLaXEG/hold", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.post("https://getrevised.com/api/v1/domains/00aLaXEG/hold", headers=headers)
r.raise_for_status()
data = r.json()

{
  "hold": {
    "can_extend": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "extend_hours": 123,
    "held_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "listing_id": "<string>"
  },
  "holds": {
    "active": 123,
    "hold_hours": 123,
    "limit": 123,
    "plan": "<string>"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}

{
  "error": {
    "available_at": "2023-11-07T05:31:56Z",
    "code": "forbidden",
    "expires_at": "2023-11-07T05:31:56Z",
    "hold_code": "ALREADY_EXTENDED",
    "limit": 123,
    "message": "<string>",
    "resets_at": "2023-11-07T05:31:56Z",
    "reveal_code": "FEATURED_REQUIRES_PRO"
  }
}