Archive Domain

Safely archive domains that are no longer in use, helping you manage and declutter your active domains list.

Curl

curl --location 'https://api.maximise.ai/v1/whitelabel-api/archive-domain' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "id": "SPzRnUKSwB0jPWaD"
}'

JavaScript

const axios = require('axios');

axios.post('https://api.maximise.ai/v1/whitelabel-api/archive-domain',
{
    "did": "SPzRnUKSwB0jPWaD"
}, {
    headers: {accept: 'application/json', Authorization: 'Bearer <token>'}
})
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.log(error);
  });

Python

import requests
import json

url = "https://api.maximise.ai/v1/whitelabel-api/archive-domain"

payload = json.dumps({
  "did": "SPzRnUKSwB0jPWaD"
})
headers = {
  'Authorization': 'Bearer <token>',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"did\": \"SPzRnUKSwB0jPWaD\"\n}");
Request request = new Request.Builder()
  .url("https://api.maximise.ai/v1/whitelabel-api/archive-domain")
  .method("POST", body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.maximise.ai/v1/whitelabel-api/archive-domain")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "did": "SPzRnUKSwB0jPWaD"
})

response = https.request(request)
puts response.read_body

Php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.maximise.ai/v1/whitelabel-api/archive-domain',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "did": "SPzRnUKSwB0jPWaD"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer <token>',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Example response

Status Code: 200 OK

{
    "message": "Successfully archived domain for this whitelabeled account",
    "uid": "22bb64ef-0c82-4870-a5ef-082084b4295a",
    "id": "KA-nyoNJWbjWglN5P",
    "domain": "example.com",
    "team": "670296297231defa325d5c0f4",
    "active": false,
    "archived": true,
    "verified": false,
    "capturing": false,
    "identification_preferences": {
        "accounts": true
    },
    "whitelabel": "66795bdfa4dace0e98d77bed",
    "createdAt": "2024-10-07T22:08:48.859Z"
}