title | description | author | ms.topic | ms.devlang | ms.date | ms.author | ms.reviewer |
---|---|---|---|---|---|---|---|
Update contacts |
Updates a contact object in Dynamics 365 Business Central. |
SusanneWindfeldPedersen |
reference |
al |
05/31/2024 |
solsen |
solsen |
[!INCLUDEapi_v2_note]
Updates the properties of a contact object for [!INCLUDEprod_short].
Replace the URL prefix for [!INCLUDEprod_short] depending on environment following the guideline.
PATCH businesscentralPrefix/companies({id})/contacts({id})
Header | Value |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json |
If-Match | Required. When this request header is included and the eTag provided does not match the current tag on the contact, the contact will not be updated. |
In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.
If successful, this method returns a 200 OK
response code and an updated contact object in the response body.
Request
Here is an example of the request.
PATCH https://{businesscentralPrefix}/api/v2.0/companies({id})/contacts({id})
Content-type: application/json
{
"id" : "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
"number" : "108001"
}
Response Here is an example of the response.
HTTP/1.1 200 OK
Content-type: application/json
{
"id" : "5d115c9c-44e3-ea11-bb43-000d3a2feca1",
"number" : "108001",
"type" : "Company",
"displayName": "CRONUS USA, Inc.",
"companyNumber" : "17806",
"companyName" : "CRONUS US",
"businessRelation" : "Vendor",
"addressLine1": "7122 South Ashford Street",
"addressLine2": "Westminster",
"city": "Atlanta",
"state": "GA",
"country": "US",
"postalCode": "31772",
"phoneNumber": "+1 425 555 0100",
"mobilePhoneNumber" : "",
"email" : "ah@contoso.com",
"website" : "",
"searchName" : "",
"privacyBlocked" : true,
"lastInteractionDate" : "2021-06-01",
"lastModifiedDateTime" : "2021-06-01"
}
This resource type requires [!INCLUDEprod_short] version 18.0.
Tips for working with the APIs
contact
GET contact
DELETE contact
POST contact