Skip to content

Commit 9bf64c8

Browse files
committed
Add delete documentation for clients and contacts
1 parent 571cd2e commit 9bf64c8

2 files changed

Lines changed: 37 additions & 0 deletions

File tree

source/includes/customers/_clients.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,3 +206,21 @@ website | A website for the client <small>string</small>
206206
phone | A phone number for the client <small>string</small>
207207
description | A description for the client <small>string</small>
208208
parent_id | The parent of the client <small>string</small>
209+
210+
## Delete a client
211+
212+
<%= shell_example('/clients/<ID>', command: 'DELETE') %>
213+
214+
> Status: 204 No Content
215+
216+
This endpoint allows you to delete a client.
217+
218+
### HTTP Request
219+
220+
`DELETE <%= api_url('/clients/<ID>') %>`
221+
222+
### URL Parameters
223+
224+
Parameter | Description
225+
--------- | -----------
226+
ID | The ID of the client to delete

source/includes/customers/clients/_contacts.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,3 +137,22 @@ phone_number_1 | The first phone number for the contact <small>string</small>
137137
phone_number_2 | A second phone number for the contact <small>string</small>
138138
description | A description for the contact <small>string</small>
139139
primary | If this is the primary contact for the client (true/false) <small>boolean</small>
140+
141+
## Delete a contact
142+
143+
<%= shell_example('/clients/<CLIENT_ID>contacts/<ID>', command: 'DELETE') %>
144+
145+
> Status: 204 No Content
146+
147+
This endpoint allows you to delete a contact.
148+
149+
### HTTP Request
150+
151+
`DELETE <%= api_url('/clients/<CLIENT_ID>contacts/<ID>') %>`
152+
153+
### URL Parameters
154+
155+
Parameter | Description
156+
--------- | -----------
157+
CLIENT_ID | The ID of the client
158+
ID | The ID of the contact to delete

0 commit comments

Comments
 (0)