put
https://gw.commpeak.com/textpeak/domains/archive/
Description
Summary: Archives or unarchives a domain by its unique identifier. Details: This endpoint toggles the archive state of a specific domain. Archiving a domain effectively deactivates it without permanently deleting it, allowing you to restore it later by setting archive to false. This is useful for temporarily disabling domains that are not currently in use while preserving their configuration.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
Content-Type | Yes | Must be application/json. |
accept | No | Expected response format. Default: application/json. |
Parameters
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
:id | string | Path | Yes | The unique identifier of the domain to archive or unarchive. |
Request Body
The request body must be a JSON object with the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
archive | boolean | Yes | Set to true to archive the domain, or false to unarchive it. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…