Skip to content

Add metadata field to client endpoints #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NickSchimek wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −2
Open

Add metadata field to client endpoints #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions source/includes/customers/_clients.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
"external_ids": {
"acumatica_id": "5"
},
"metadata": {
"crm_id": "ABC123"
},
"parent_id": 2345,
"contacts": [
{
Expand Down Expand Up @@ -73,6 +76,7 @@
"zipcode": "32312",
"country": "US",
"external_ids": null,
"metadata": {},
},
{
...
Expand Down Expand Up @@ -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) %>
Expand Down Expand Up @@ -162,6 +167,7 @@ website | A website for the client <small>string</small>
phone | A phone number for the client <small>string</small>
description | A description for the client <small>string</small>
parent_id | The parent of the client <small>string</small>
metadata | A JSON object for storing custom key-value data (e.g. external system IDs) <small>object</small>

## Update a client
<%
Expand All @@ -175,7 +181,8 @@ parent_id | The parent of the client <small>string</small>
"state": "CA",
"zipcode": "92626",
"country": "US",
"parent_id": 456
"parent_id": 456,
"metadata": { "crm_id": "ABC123" }
}
%>
<%= shell_example('/clients/<ID>', command: 'PATCH', data: data) %>
Expand Down Expand Up @@ -206,6 +213,7 @@ website | A website for the client <small>string</small>
phone | A phone number for the client <small>string</small>
description | A description for the client <small>string</small>
parent_id | The parent of the client <small>string</small>
metadata | A JSON object for storing custom key-value data (e.g. external system IDs). Replaces the entire object on update. <small>object</small>

## Delete a client

Expand Down