> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /contacts/{id} PATCH https://api.merge.dev/api/accounting/v1/contacts/{id} Content-Type: application/json Updates a `Contact` object with the given `id`. Reference: https://docs.merge.dev/merge-unified/accounting/common-models/contacts/retrieve ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) ## Request ### Path parameters - `id` (string, required) ### Query parameters - `is_debug_mode` (boolean, optional) — Whether to include debug fields (such as log file links) in the response. - `run_async` (boolean, optional) — Whether or not third-party updates should be run asynchronously. ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ### Body (application/json) This endpoint expects a PatchedContactEndpointRequest. - `model` (PatchedContactRequest, required) — # The Contact Object ### Description A `Contact` is an individual or business entity to which products and services are sold to or purchased from. The `Contact` model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from. * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. * A `Contact` is a customer if the `is_customer` property is true. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company's contacts. ## Response ### 200 - `model` (Contact, required) — # The Contact Object ### Description A `Contact` is an individual or business entity to which products and services are sold to or purchased from. The `Contact` model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from. * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. * A `Contact` is a customer if the `is_customer` property is true. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company's contacts. - `warnings` (list of WarningValidationProblem, required) - `errors` (list of ErrorValidationProblem, required) - `logs` (list of DebugModeLog, optional) ## Types ### PatchedContactRequest # The Contact Object ### Description A `Contact` is an individual or business entity to which products and services are sold to or purchased from. The `Contact` model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from. * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. * A `Contact` is a customer if the `is_customer` property is true. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company's contacts. - `name` (string, optional, nullable) — The contact's name. - `is_supplier` (boolean, optional, nullable) — Whether the contact is a supplier. - `is_customer` (boolean, optional, nullable) — Whether the contact is a customer. - `email_address` (string, optional, nullable) — The contact's email address. - `tax_number` (string, optional, nullable) — The contact's tax number. - `status` (enum, optional, nullable) — The contact's status - Allowed values: `ACTIVE`, `ARCHIVED` - `currency` (string, optional, nullable) — The currency the contact's transactions are in. - `company` (string, optional, nullable) — The company the contact belongs to. - `addresses` (list of AddressRequest, optional) — `Address` object IDs for the given `Contacts` object. - `phone_numbers` (list of AccountingPhoneNumberRequest, optional) — `AccountingPhoneNumber` object for the given `Contacts` object. - `contact_url` (string, optional, nullable) — The 3rd party URL of the contact. - `integration_params` (map from string to any, optional, nullable) - `linked_account_params` (map from string to any, optional, nullable) - `remote_fields` (list of RemoteFieldRequest, optional) - `status_native` (string, optional, nullable) — The third-party value for `status`, sent to the integration without enum normalization. Cannot be combined with `status`. ### Contact # The Contact Object ### Description A `Contact` is an individual or business entity to which products and services are sold to or purchased from. The `Contact` model contains both Customers, in which products and services are sold to, and Vendors (or Suppliers), in which products and services are purchased from. * A `Contact` is a Vendor/Supplier if the `is_supplier` property is true. * A `Contact` is a customer if the `is_customer` property is true. ### Usage Example Fetch from the `LIST Contacts` endpoint and view a company's contacts. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `name` (string, optional, nullable) — The contact's name. - `is_supplier` (boolean, optional, nullable) — Whether the contact is a supplier. - `is_customer` (boolean, optional, nullable) — Whether the contact is a customer. - `email_address` (string, optional, nullable) — The contact's email address. - `tax_number` (string, optional, nullable) — The contact's tax number. - `status` (enum, optional, nullable) — The contact's status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=status` to receive the integration's own value instead. - Allowed values: `ACTIVE`, `ARCHIVED` - `currency` (string, optional, nullable) — The currency the contact's transactions are in. - `remote_updated_at` (datetime, optional, nullable) — When the third party's contact was updated. - `company` (string, optional, nullable) — The company the contact belongs to. - `addresses` (list of Address, optional) — `Address` object IDs for the given `Contacts` object. - `phone_numbers` (list of AccountingPhoneNumber, optional) — `AccountingPhoneNumber` object for the given `Contacts` object. - `contact_url` (string, optional, nullable) — The 3rd party URL of the contact. - `remote_was_deleted` (boolean, optional) — Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (ContactFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) - `remote_fields` (list of RemoteField, optional) ### WarningValidationProblem - `title` (string, required) - `detail` (string, required) - `problem_type` (string, required) - `source` (ValidationProblemSource, optional) - `block_merge_link` (boolean, optional) - `raw_error` (string, optional) - `error_code` (integer, optional) ### ErrorValidationProblem - `title` (string, required) - `detail` (string, required) - `problem_type` (string, required) - `source` (ValidationProblemSource, optional) - `block_merge_link` (boolean, optional) - `raw_error` (string, optional) - `error_code` (integer, optional) ### DebugModeLog - `log_id` (string, required) - `dashboard_view` (string, required) - `log_summary` (DebugModelLogSummary, required) ### AddressRequest # The Address Object ### Description The `Address` object is used to represent a contact's or company's address. ### Usage Example Fetch from the `GET CompanyInfo` endpoint and view the company's addresses. - `type` (enum, optional, nullable) — The address type. - Allowed values: `BILLING`, `SHIPPING` - `street_1` (string, optional, nullable) — Line 1 of the address's street. - `street_2` (string, optional, nullable) — Line 2 of the address's street. - `city` (string, optional, nullable) — The address's city. - `country_subdivision` (string, optional, nullable) — The address's state or region. - `country` (enum, optional, nullable) — The address's country. The country code in ISO 3166-1 alpha-2 format. - Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW` - `zip_code` (string, optional, nullable) — The address's zip code. - `integration_params` (map from string to any, optional, nullable) - `linked_account_params` (map from string to any, optional, nullable) ### AccountingPhoneNumberRequest # The AccountingPhoneNumber Object ### Description The `AccountingPhoneNumber` object is used to represent a contact's or company's phone number. ### Usage Example Fetch from the `GET CompanyInfo` endpoint and view the company's phone numbers. - `number` (string, optional, nullable) — The phone number. - `type` (string, optional, nullable) — The phone number's type. - `integration_params` (map from string to any, optional, nullable) - `linked_account_params` (map from string to any, optional, nullable) ### RemoteFieldRequest - `remote_field_class` (string, required) - `value` (map from string to any, optional) ### Address # The Address Object ### Description The `Address` object is used to represent a contact's or company's address. ### Usage Example Fetch from the `GET CompanyInfo` endpoint and view the company's addresses. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `type` (enum, optional, nullable) — The address type. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=type` to receive the integration's own value instead. - Allowed values: `BILLING`, `SHIPPING` - `street_1` (string, optional, nullable) — Line 1 of the address's street. - `street_2` (string, optional, nullable) — Line 2 of the address's street. - `city` (string, optional, nullable) — The address's city. - `state` (any, optional, nullable) — The address's state or region. - `country_subdivision` (string, optional, nullable) — The address's state or region. - `country` (enum, optional, nullable) — The address's country. The country code in ISO 3166-1 alpha-2 format. - Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CG`, `CD`, `CK`, `CR`, `CI`, `HR`, `CU`, `CW`, `CY`, `CZ`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `KP`, `MK`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `RE`, `RO`, `RU`, `RW`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `KR`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW` - `zip_code` (string, optional, nullable) — The address's zip code. ### AccountingPhoneNumber # The AccountingPhoneNumber Object ### Description The `AccountingPhoneNumber` object is used to represent a contact's or company's phone number. ### Usage Example Fetch from the `GET CompanyInfo` endpoint and view the company's phone numbers. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `number` (string, optional, nullable) — The phone number. - `type` (string, optional, nullable) — The phone number's type. ### ContactFieldMappings - `organization_defined_targets` (map from string to any, optional) - `linked_account_defined_targets` (map from string to any, optional) ### RemoteData # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ### RemoteField - `remote_field_class` (RemoteFieldClass, required) - `value` (map from string to any, optional) ### ValidationProblemSource - `pointer` (string, required) ### DebugModelLogSummary - `url` (string, required) - `method` (string, required) - `status_code` (integer, required) ### RemoteFieldClass - `id` (string, optional) - `display_name` (string, optional) - `remote_key_name` (string, optional) - `description` (string, optional) - `is_custom` (boolean, optional) - `is_common_model_field` (boolean, optional) - `is_required` (boolean, optional) - `field_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `field_choices` (list of string, optional) - `item_schema` (ItemSchema, optional) ### ItemSchema - `item_type` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_format` (enum, optional) - Allowed values: `string`, `number`, `date`, `datetime`, `bool`, `list` - `item_choices` (list of string, optional) ## Examples **Request** ```json {} ``` **Response** ```json { "model": { "id": "c640b80b-fac9-409f-aa19-1f9221aec445", "remote_id": "11167", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "name": "Gil Feig's pickleball store", "is_supplier": true, "is_customer": true, "email_address": "pickleball@merge.dev", "tax_number": "12-3456789", "status": "ACTIVE", "currency": "USD", "remote_updated_at": "2020-03-31T00:00:00Z", "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5", "addresses": [ {}, {} ], "phone_numbers": [ { "number": "+3198675309", "type": "Mobile" } ], "contact_url": "https://qbo.intuit.com/app/contact/11167", "remote_was_deleted": true, "field_mappings": { "organization_defined_targets": { "custom_key": "custom_value" }, "linked_account_defined_targets": { "custom_key": "custom_value" } }, "remote_data": [ { "path": "/actions", "data": null } ], "remote_fields": [ { "remote_field_class": { "id": "string", "display_name": "string", "remote_key_name": "string", "description": "string", "is_custom": true, "is_common_model_field": true, "is_required": true, "field_type": "string", "field_format": "string", "field_choices": [ "string" ], "item_schema": { "item_type": "string", "item_format": "string", "item_choices": [ "string" ] } }, "value": "string" } ] }, "warnings": [ { "title": "Unrecognized Field", "detail": "An unrecognized field, age, was passed in with request data.", "problem_type": "UNRECOGNIZED_FIELD", "source": { "pointer": "/age" }, "block_merge_link": true, "raw_error": "string", "error_code": 1 } ], "errors": [ { "title": "Missing Required Field", "detail": "custom_fields is a required field on model.", "problem_type": "MISSING_REQUIRED_FIELD", "source": { "pointer": "/model/custom_fields" }, "block_merge_link": true, "raw_error": "string", "error_code": 1 } ], "logs": [ { "log_id": "99433219-8017-4acd-bb3c-ceb23d663832", "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832", "log_summary": { "url": "www.exampleintegration.com/api/v1/exampleapi", "method": "POST", "status_code": 200 } } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/accounting/v1/contacts/id" payload = {} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/accounting/v1/contacts/id'; const options = { method: 'PATCH', headers: { 'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/accounting/v1/contacts/id" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/accounting/v1/contacts/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.merge.dev/api/accounting/v1/contacts/id") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.merge.dev/api/accounting/v1/contacts/id', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/accounting/v1/contacts/id"); var request = new RestRequest(Method.PATCH); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/accounting/v1/contacts/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```