Domains

Archive/Unarchive domain

Changed on Nov 3, 2026

Archive or unarchive a domain. Send archive: true to archive, or archive: false to restore it.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

put/domains/archive/{id}

Request

Base URL
https://api.commpeak.com/textpeak
URL
https://api.commpeak.com/textpeak/domains/archive/{id}
Auth
API key in header Authorization

Path parameters

idinteger required

Unique identifier of the resource.

Request body

archiveboolean nullable

true archives the domain (status ARCHIVED, removed from link shortening). false unarchives it and restarts its configuration. Omitted: nothing changes.

Example request

{
  "archive": true
}

Response

Successful Response

idinteger required

Unique domain identifier.

namestring required

The domain name.

ipstring required

IP address the domain must point to (an A record). Set by TextPeak; read-only.

Example response

{
  "id": 12,
  "ip": "192.0.2.10",
  "name": "demo.example.com",
  "status": "NOT_CONFIGURED"
}

Changes

Nov 3, 20265012671cf95d Revision changes
- breaking
  added the new path request parameter id
- info
  api operation id archiveUnarchiveDomain removed and replaced with archive_domain
- info
  the endpoint scheme security APIKeyHeader was added to the API
- info
  the request property became optional
- info
  request property list-of-types was widened by adding types null to media type application/json
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status

Operation history