Update a counterpart

PATCH

/counterparts/:counterpart_id

Path parameters

counterpart_idstringRequired

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

Counterpart Individual Root Update Payloadobject

Counterpart Organization Root Update Payloadobject

Response

Successful Response

Counterpart Individual Root Responseobject

Counterpart Organization Root Responseobject

Errors

PATCH

1 curl -X PATCH https://api.sandbox.monite.com/v1/counterparts/counterpart_id \
2      -H "x-monite-version: 2024-01-31" \
3      -H "x-monite-entity-id: x-monite-entity-id" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "individual": {}
8 }'

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "created_automatically": true,
6   "default_billing_address_id": "default_billing_address_id",
7   "default_shipping_address_id": "default_shipping_address_id",
8   "created_by_entity_user_id": "created_by_entity_user_id",
9   "individual": {
10     "email": "asingh@example.net",
11     "first_name": "Adnan",
12     "is_customer": true,
13     "is_vendor": true,
14     "last_name": "Singh",
15     "phone": "5553211234",
16     "tags": [
17       {
18         "id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19         "created_at": "2022-09-07T16:35:18Z",
20         "updated_at": "2022-09-07T16:35:18Z",
21         "created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
22         "description": "Tag for the Marketing Department",
23         "name": "Marketing"
24       }
25     ],
26     "title": "Mr."
27   },
28   "language": "ab",
29   "reminders_enabled": true,
30   "tax_id": "tax_id",
31   "type": "individual"
32 }

Get counterpart metadata

Up Next

1	curl -X PATCH https://api.sandbox.monite.com/v1/counterparts/counterpart_id \
2	-H "x-monite-version: 2024-01-31" \
3	-H "x-monite-entity-id: x-monite-entity-id" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"individual": {}
8	}'

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"created_automatically": true,
6	"default_billing_address_id": "default_billing_address_id",
7	"default_shipping_address_id": "default_shipping_address_id",
8	"created_by_entity_user_id": "created_by_entity_user_id",
9	"individual": {
10	"email": "asingh@example.net",
11	"first_name": "Adnan",
12	"is_customer": true,
13	"is_vendor": true,
14	"last_name": "Singh",
15	"phone": "5553211234",
16	"tags": [
17	{
18	"id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
19	"created_at": "2022-09-07T16:35:18Z",
20	"updated_at": "2022-09-07T16:35:18Z",
21	"created_by_entity_user_id": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
22	"description": "Tag for the Marketing Department",
23	"name": "Marketing"
24	}
25	],
26	"title": "Mr."
27	},
28	"language": "ab",
29	"reminders_enabled": true,
30	"tax_id": "tax_id",
31	"type": "individual"
32	}