DgVerseDgVerse
Home
Get Started
  • Auth Endpoint
  • Create Collection
  • Create Certificate
  • Create Directory
  • Transfer Certificate Via Wallet
  • Transfer Certificate Via Mail
  • Cancel Claim
  • Freeze User
  • Un-freeze User
  • Pause Collection
  • Un-Pause Collection
  • Delete Collection
  • Invalidate Certificates
  • Delete Certificates
  • Get Collection
  • Get Certificates
  • Get Directory of a Collection
Home
Get Started
  • Auth Endpoint
  • Create Collection
  • Create Certificate
  • Create Directory
  • Transfer Certificate Via Wallet
  • Transfer Certificate Via Mail
  • Cancel Claim
  • Freeze User
  • Un-freeze User
  • Pause Collection
  • Un-Pause Collection
  • Delete Collection
  • Invalidate Certificates
  • Delete Certificates
  • Get Collection
  • Get Certificates
  • Get Directory of a Collection
  • Delete Collection

Delete Collection

Path: v1/hts/api/integration/delete-collection

How to use:

The ‘collectionId’ of an existing collection has to be provided to delete a collection. screenshot

Parameter List

Below table represents the parameters, data type of parameter and whether the parameter is required or not for deleting the collection.

FieldTypeRequiredUsage
collectionIdStringRequired“collectionId” is used to identify the collection to consider for deletion.

cURL command

curl --request POST \
  --url http://<dgverse-api-base-url>/v1/hts/api/integration/delete-collection \
  --header 'Authorization: Bearer <YOUR TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"collectionId": "<VALUE>"}'

Response

When the collection is deleted successfully, a '200 Ok' response message will be generated. screenshot

Error Troubleshooting

  • 500 Internal Server Error: collection doesn’t exist. It was already deleted.
  • 400 Bad Request: ‘collection’ provided as ‘collectionId’ doesn’t exist with this account.
Last Updated:
Contributors: John
Prev
Un-pause collection
Next
Invalidate certificate