Delete a contract

Deleting a contract moves it to trash; it is not permanently deleted until the trash is emptied.

You can view deleted contracts in the Oneflow web app by going to Documents > Trash.

Step 1. Obtain necessary information

To run the script described in this tutorial, you’ll need the following data:

Step 2. Run the code

Replace the values of the parameters in the following command with the actual data from your account and run it.

curl --request DELETE \
  --url https://api.oneflow.com/v1/contracts/CONTRACT_ID \
  --header 'x-oneflow-api-token: API_TOKEN' \
  --header 'x-oneflow-user-email: USER_EMAIL'

import requests

headers = {
    'x-oneflow-api-token': API_TOKEN,
    'x-oneflow-user-email': USER_EMAIL
    }

response = requests.delete('https://api.oneflow.com/v1/contracts/CONTRACT_ID', 
                           headers=headers)

print(response.json())

Expected response

This operation will move the specified contract to trash and display an empty body in the response. You can view contracts in trash from the Oneflow web app by going to Documents > Trash.

Please see the Contract section in the Data model category for more information about the output.

Response codes