---
title: "Cancel credential by credential name"
method: PUT
path: "/api/v2/credential/{name}/cancel"
tags: ["Delegated RA"]
---

# Cancel credential by credential name

`PUT /api/v2/credential/{name}/cancel`

## Request

- Base URL: `https://one.digicert.com/documentmanager`
- URL: `https://one.digicert.com/documentmanager/api/v2/credential/{name}/cancel`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/digicert/apis/digicert-content-trust-manager/docs/api/v2/credential/:name/cancel/put.ts> (a function with typed inputs; its response is checked against the schema)

Use this API to cancel the credential in-case credential was created with wrong organization data.<br> This API can be called only if status of credential is 'pending_issuance' state.

## Path parameters

- `name` string, required: Credential Name

## Query parameters

- `user_id` string

## Request body

- CancelCredentialRequest
  - `notes` string, required: Cancellation notes

## Response `200`

OK

- CredentialsDetailsResponseV2
  - `created_by` string
  - `modified_on` string, date-time
  - `modified_by` string
  - `created_on` string, date-time
  - `id` string: Identifier
  - `name` string: Credential Name
  - `user_id` string: DTM user id
  - `account_id` string: DigiCert One Account ID
  - `profile_id` string: Credential Profile ID
  - `first_credential` boolean: This field identify if the credential is a first credential
  - `status` string: Credential Status (ACTIVE, PENDING_ISSUANCE, DEACTIVATED, REVOKED, SUSPENDED)
  - `cc_order_id` string: Cert central order id

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/digicert/apis/digicert-content-trust-manager.md) - [All operations](https://skmtc.dev/digicert/apis/digicert-content-trust-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/digicert/apis/digicert-content-trust-manager/revisions/8dec322a0e2b?raw)