Archive destination

Archive one configured Outlit automation destination by id. Archived destinations are disabled and removed from normal lists.

POST /api/destinations/{id}/archive

Archive destination

cURL

curl --request POST \
  --url https://app.outlit.ai/api/destinations/{id}/archive \
  --header 'Authorization: Bearer <token>'

200

{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "destination": {
        "id": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Outlit API key using the Bearer ok_... format.

Path Parameters

id · string<uuid> · required

Destination ID.

Response

200

application/json

Archive destination completed.

ok · boolean · required

commandId · string · required

Allowed value: "destination.archive"

commandVersion · integer · required

correlationId · string · required

result · object · required

Show child attributes