Loading...

Delete an Agreement

Deletes a previously created agreement

Send request

  • POST https://api.zigned.io/rest/v2/agreements/[id]
  • Content-type: application/json
const fetch = require('node-fetch'); let url = 'https://api.zigned.io/rest/v2/agreements/9aaf52be-0c51-4445-82a1-a2789657700e'; let options = { method: 'DELETE', headers: {'x-zigned-api-key': 'Your API key'}, body: '{"dsf":"sdf"}' }; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err));

Success response

Description

Details

  • HTTP Status: 201
  • Mime type: application/json

Response body

messageString

Message confirming the agreement was successfully deleted.

Code Example

{ "message": "Agreement deleted" }

Error responses

Description

Something went wrong on the server while trying to delete the agreement.

Details

  • HTTP Status: 500
  • Mime type: application/json
  • Message: Could not delete the agreement.

Code Example

{ "status": 500, "message": "Could not delete the agreement." }