DomainsPause Domain

Pause Domain

Pause a domain (brand) so that its prompts stop being analyzed. The prompt credits of its active prompts go back to the team.

curl --request POST \
  --url https://api.aiclicks.io/api/v1/domains/pause \
  --header 'Authorization: Bearer ak_live_xxx' \
  --header 'Content-Type: application/json' \
  --data '{"domain_id": "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3"}'
{
  "data": {
    "message": "Domain paused successfully",
    "domain_id": "8f1d3c0a-2f9b-4c11-9b80-7a82e1f0c3f3",
    "disabled": true,
    "prompts_refunded": 805,
    "remaining_prompts": 809
  },
  "generated_at": "2026-11-17T08:31:40.872292+00:00"
}

Pauses a domain. A paused domain is not in the next analysis runs. The API keeps the history of the domain. The prompt credits of its active prompts go back to the team. To start the analysis again, use POST /api/v1/domains/resume.

If the domain is already paused, the call changes nothing and returns "Domain is already paused". To see if a domain is paused, read the paused field of GET /api/v1/domains.

A paused domain collects no new answers while it is paused. To resume it later, the team needs one free prompt credit for each active prompt.

Authorizations

header
Authorizationstring
Required

Your API key in the format Bearer ak_live_<your-key>. Create a key in the dashboard under Settings → Developers. The key must have access to the team that owns domain_id.

header
Content-Typestring
Required

Must be application/json.

Body parameters

body
domain_idstring
Required

UUID of the domain to pause. Find it with GET /api/v1/domains.

Response

data.messagestring
Required

Domain paused successfully, or Domain is already paused when the call changed nothing.

data.domain_idstring
Required

UUID of the domain.

data.disabledboolean
Required

Always true. The domain is paused.

data.prompts_refundedinteger

The prompt credits that the team got back. This is one credit for each active prompt of the domain. For a pitch domain, the value is 0. null when the domain was already paused.

data.remaining_promptsinteger

The prompt credits of the team after the refund. null when the domain was already paused.

generated_atstring
Required

ISO-8601 time when the server made this response.

Side effects

  • The domain stops being analyzed. Its old answers stay in the history.
  • The team gets one prompt credit back for each active prompt of the domain.
  • The API clears the cache of GET /api/v1/domains.

Errors

401 Unauthorizederror

The API key is missing, malformed or revoked.

403 Forbiddenerror

The caller is not a member of the team of the domain. Or the API key has no access to this domain. Or the plan of the team does not include API access.

422 Unprocessable Entityerror

The body is not valid. For example, domain_id is missing.

429 Too Many Requestserror

You sent too many requests. Read the Retry-After header to know how long to wait.