Delete contact documents

Deletes specified contact documents with the following validations:

Document Validation:
- All specified documents must exist and belong to the contact
- Contact must have at least one document remaining after deletion
- Cannot delete all documents from a contact
Default Document Handling:
- If the default document is deleted, the first remaining document will be set as default
- Documents are ordered by creation date for default selection
Permissions:
- User must have MERCHANT_CONTACTS_EDIT_CONTACT permission

Deletes specified contact documents with the following validations: 1. **Document Validation**: - All specified documents must exist and belong to the contact - Contact must have at least one document remaining after deletion - Cannot delete all documents from a contact 2. **Default Document Handling**: - If the default document is deleted, the first remaining document will be set as default - Documents are ordered by creation date for default selection 3. **Permissions**: - User must have MERCHANT_CONTACTS_EDIT_CONTACT permission

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

Organization ID

merchantIdstringRequired

Merchant ID

contactIdstringRequired

ID of the contact whose documents will be deleted

Request

This endpoint expects an object.

documentslist of stringsRequired

Array of document IDs to delete. Contact must have at least one document remaining after deletion.

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/organizations/org_12345/merchants/mer_67890/contacts/con_a627a569-51c4-4fc4-ace6-a43482f1b08b/documents"
4
5	payload = { "documents": ["cdoc_a627a569-51c4-4fc4-ace6-a43482f1b08b", "cdoc_b627a569-51c4-4fc4-ace6-a43482f1b08c"] }
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.delete(url, json=payload, headers=headers)
12
13	print(response.json())

Delete contact documents

Authentication

Path parameters

Headers

Request

Errors