Update vendor (partial)
Update specific fields on a vendor. Send only the fields you want to change — anything you don't send stays as it is. To clear a nullable field, send null.
Example — rename a vendor and update its TIN:
{"name": "Acme Supply Co.", "tin": "12-3456789", "tin_type": "ein"}
Example — change payment routing:
{"bank_account_number": "000123456789", "bank_routing_number": "021000021"}
Existing attachments are preserved unless you explicitly send the attachments field; use the dedicated attachments endpoint to manage them.
Custom fields
Set custom fields by name:
{"custom_fields": [{"Partner": true}, {"Tier": "Gold"}]}
Each item is a one-key object where the key is the custom field's name and the value is whatever you want to set. Use null to clear a field. If the name doesn't match a custom field in your organization you'll get a 422 back — we won't silently ignore it. If you happen to have two custom fields with the same name, use the id-based shape:
{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}
Omitting custom_fields from the request leaves existing values untouched.
Path parameters
Headers
Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.
Request body
Response
OK
Changes
Changed in 3 of the 14 revisions of this API.13
- ○
added the required property
created_atto the response with the200statusresponse-required-property-added
- ○
added the required property
updated_atto the response with the200statusresponse-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
changed the pattern of the request property
phonefrom^[0-9\s\+\-\.\(\)]*$to(?i)^(?:[0-9\s+\-.\(\)]*|[0-9\s+\-.\(\)]+(?:\s*(?:x|ext\.?|extension)\s*\d+))$request-property-pattern-changed
- ●
- ○
added the new optional
headerrequest parameterIdempotency-Keynew-optional-request-parameter
- ○