Archive Guest Profile

POST https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive

Archive a guest profile and its associated project. This sets the status to ARCHIVED.

Example request

curl -X POST "https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_TOKEN"

const options = {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  }
};

fetch("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive", options)
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

import requests

headers = {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.post("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive", headers=headers)
print(response.json())

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;

var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "YOUR_API_TOKEN");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

var response = await client.PostAsync("https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive");
var data = await response.Content.ReadAsStringAsync();
Console.WriteLine(data);

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.podengine.ai/api/v1/guest-profiles/:guestProfileId/archive", nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "YOUR_API_TOKEN")
	
	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import { PodEngine } from '@podengine/sdk';

const pe = new PodEngine({ apiKey: process.env.PODENGINE_API_KEY });

const data = await pe.guestProfiles.archiveGuestProfile({
  guestProfileId: 'example-guest-profile-id',
});

console.log(data);

import os

from podengine import PodEngine

pe = PodEngine(api_key=os.environ["PODENGINE_API_KEY"])

data = pe.guest_profiles.archive_guest_profile(
    guest_profile_id="example-guest-profile-id",
)

print(data)

200

Example response

{
  "status": "OK",
  "data": {
    "success": true
  }
}

Request

Path parameters

guestProfileIdstringrequired

The guest profile ID

Response

200 application/json

statusliteral: OKrequired

dataobjectrequired1 field

successbooleanrequired