Update a contact if found. To call this, you need to have edit contact right of 090300.
curl -X PATCH "https://api.example.com/restapi/v1/contacts/123" \
-H "Content-Type: application/json"
import requests
import json
url = "https://api.example.com/restapi/v1/contacts/123"
headers = {
"Content-Type": "application/json"
}
response = requests.patch(url, headers=headers)
print(response.json())
const response = await fetch("https://api.example.com/restapi/v1/contacts/123", {
method: "PATCH",
headers: {
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("PATCH", "https://api.example.com/restapi/v1/contacts/123", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.example.com/restapi/v1/contacts/123')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
response = http.request(request)
puts response.body
[
{
"id": 123,
"contactType": "example_string",
"salutation": "mr",
"title": "example_string",
"firstName": "John Doe",
"lastName": "John Doe",
"company": "example_string",
"companyId": 123,
"email": "user@example.com",
"website": "example_string",
"contactCategoriesId": [
123
],
"defaultAddress": [
{
"id": 123,
"addressType": 42,
"parentContact": "example_string",
"parentContactId": 123,
"isDefault": true,
"position": "example_string",
"department": "example_string",
"street": "example_string",
"houseNumber": "example_string",
"addition": "example_string",
"zip": "example_string",
"city": "New York",
"state": "example_string",
"country": "USA",
"emails": [
{
"id": 123,
"email": "user@example.com"
}
],
"phones": [
{
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
}
]
}
],
"defaultPhone": {
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
},
"defaultFax": {
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
},
"defaultMobile": {
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
},
"allAddress": [
{
"id": 123,
"addressType": 42,
"parentContact": "example_string",
"parentContactId": 123,
"isDefault": true,
"position": "example_string",
"department": "example_string",
"street": "example_string",
"houseNumber": "example_string",
"addition": "example_string",
"zip": "example_string",
"city": "New York",
"state": "example_string",
"country": "USA",
"emails": [
{
"id": 123,
"email": "user@example.com"
}
],
"phones": [
{
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
}
]
}
],
"invoiceAddress": [
{
"id": 123,
"addressType": 42,
"parentContact": "example_string",
"parentContactId": 123,
"isDefault": true,
"position": "example_string",
"department": "example_string",
"street": "example_string",
"houseNumber": "example_string",
"addition": "example_string",
"zip": "example_string",
"city": "New York",
"state": "example_string",
"country": "USA",
"emails": [
{
"id": 123,
"email": "user@example.com"
}
],
"phones": [
{
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
}
]
}
],
"invoiceSendAddress": [
{
"id": 123,
"addressType": 42,
"parentContact": "example_string",
"parentContactId": 123,
"isDefault": true,
"position": "example_string",
"department": "example_string",
"street": "example_string",
"houseNumber": "example_string",
"addition": "example_string",
"zip": "example_string",
"city": "New York",
"state": "example_string",
"country": "USA",
"emails": [
{
"id": 123,
"email": "user@example.com"
}
],
"phones": [
{
"id": 123,
"type": "example_string",
"countryCode": "USA",
"areaCode": "example_string",
"number": "example_string"
}
]
}
],
"extNewsletter": [
[
{
"cmain_id": 123,
"ext_type": "example_string",
"ext_id": "example_string",
"is_active": 42,
"ext_opt_in": 42,
"ext_opt_in_executed": 42
}
]
]
}
]
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Error",
"message": "Methode not allowed",
"code": 405
}
PATCH
/contacts/{contactId}PATCH
Base URLstring
Target server for requests. Edit to use your own host.
path
contactIdinteger
RequiredID of contact that have to be update
Content-Typestring
RequiredThe media type of the request body
Options: application/json
No request body parameters defined
Request Preview
Response
Response will appear here after sending the request
Path Parameters
contactIdinteger
RequiredID of contact that have to be update
Body
application/json
datastring
RequiredRaw application/json data
Responses
idinteger
contactTypestring
salutationstring
Allowed values:
mrmstitlestring
firstNamestring
lastNamestring
companystring
companyIdinteger
emailstring
websitestring
contactCategoriesIdinteger[]
defaultAddressarray
defaultPhoneobject
defaultFaxobject
defaultMobileobject
allAddressarray
invoiceAddressarray
invoiceSendAddressarray
extNewsletterarray[]
Was this page helpful?