diff --git a/source/includes/customers/_clients.md b/source/includes/customers/_clients.md index d88e0f9..ba58eae 100644 --- a/source/includes/customers/_clients.md +++ b/source/includes/customers/_clients.md @@ -32,6 +32,9 @@ "external_ids": { "acumatica_id": "5" }, + "metadata": { + "crm_id": "ABC123" + }, "parent_id": 2345, "contacts": [ { @@ -73,6 +76,7 @@ "zipcode": "32312", "country": "US", "external_ids": null, + "metadata": {}, }, { ... @@ -132,7 +136,8 @@ ID | The ID of the client to retrieve "state": "CA", "zipcode": "92626", "country": "US", - "parent_id": 456 + "parent_id": 456, + "metadata": { "crm_id": "ABC123" } } %> <%= shell_example('/clients', command: 'POST', data: data) %> @@ -162,6 +167,7 @@ website | A website for the client string phone | A phone number for the client string description | A description for the client string parent_id | The parent of the client string +metadata | A JSON object for storing custom key-value data (e.g. external system IDs) object ## Update a client <% @@ -175,7 +181,8 @@ parent_id | The parent of the client string "state": "CA", "zipcode": "92626", "country": "US", - "parent_id": 456 + "parent_id": 456, + "metadata": { "crm_id": "ABC123" } } %> <%= shell_example('/clients/', command: 'PATCH', data: data) %> @@ -206,6 +213,7 @@ website | A website for the client string phone | A phone number for the client string description | A description for the client string parent_id | The parent of the client string +metadata | A JSON object for storing custom key-value data (e.g. external system IDs). Replaces the entire object on update. object ## Delete a client