Delete an SLA policy

Deletes one SLA policy from the current organization. Admin access is required. Use this when a policy should no longer be evaluated for new or existing conversations. Access requires an active organization administrator session or an organization API key with the `sla:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.

DELETE/api/sla/policies/{id}

Authorization

AuthorizationBearer <token>

Organization API key supplied as Authorization: Bearer convor_sk_....

In: header

Path Parameters

id*string

Response Body

`application/json`

{
  "success": true,
  "deleted": true
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found.",
    "correlationId": "req_01K0MANAGEMENT404"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request DELETE \
  'https://api.convor.io/api/sla/policies/11111111-1111-4111-8111-111111111111' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/sla/policies/11111111-1111-4111-8111-111111111111", {
  method: "DELETE",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete an SLA policy

DELETE/api/sla/policies/{id}

Authorization

AuthorizationBearer <token>

Organization API key supplied as Authorization: Bearer convor_sk_....

In: header

Path Parameters

id*string

Response Body

`application/json`

{
  "success": true,
  "deleted": true
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found.",
    "correlationId": "req_01K0MANAGEMENT404"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request DELETE \
  'https://api.convor.io/api/sla/policies/11111111-1111-4111-8111-111111111111' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/sla/policies/11111111-1111-4111-8111-111111111111", {
  method: "DELETE",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete an SLA policy

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Delete an SLA policy

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Delete an SLA policy

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Delete an SLA policy

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`