(Quick Reference) Service: Update a contact

Description: Returns the updated contact in json format when successful. Returns a json response, describing the failure condition when unsuccessful.



Method: POST

Request content type: application/x-www-form-urlencoded or multipart/form-data


NameDescriptionTypeRequiredExample values
idThe numerical ID of the desired contactLongyes123
firstName Stringyes 
lastName Stringyes 
customerId Long/Stringyes 
fonction Stringno 
countryISO county codeStringnoFR
city Stringno 
postalCode Stringno 
address Stringno 
email Stringno 
phone Stringno 
phone2 Stringno 
mobile Stringno 
fax Stringno 
imageFileImage can be in jpg, gif, png or bmp formatMultipartno 
useExternalIdBy default, it is set to false. set it to true if you want to use external ids.Booleannotrue , false

Success Output

Success case: response.status=200

  "id": 5,
  "customerReference": "C0959",
  "customer": {
    "id": 3229,
    "reference": "C0959",
    "name": "Marie's Jewelry",
    "href": "/api/v1.0/customers/3229"
  "firstName": "Marie",
  "lastName": "Schrader",
  "mobile": "",
  "fax": "",
  "email": "",
  "fonction": "Commercial",
  "phone": "",
  "phone2": "",
  "comment": "",
  "country": "",
  "city": "Any town",
  "postalCode": "",
  "address": "Main street",
  "isDecisionMaker": true,
  "photo": "BASE_URL/entity1-1450169988465/photoContact/1471508040029_2938_marie_schrader.png",
  "user": {
    "id": 4,
    "reference": "emp-00",
    "href": "/api/v1.0/users/4"
  "organization": "entity1",
  "dateCreated": "2015-12-18T13:21:18Z",
  "lastUpdated": "2016-08-16T13:35:20Z"

To get resized images, add prefix small_ or medium_ to the link url before the image's name, for example:

Failure Output

Failure case:response.status = 400

  "error": "save_failed",
  "error_description": "Failed to save instance."

  "error": "missing_param",
  "error_description": "customerId parameter is missing"
  "error_description": "The type of parameter customerId you provided is not valid for this request."
  "error": "email_validation_error",
  "error_description": "Failed to "+operation+" the contact : incorrect Email format"
  "error": "country_error",
  "error_description": "Failed to "+operation+" the contact : incorrect country code"
  "error": "exceeded_file_size",
  "error_description": "image size should not exceed 2Mo
  "error": "unsupported_file_type",
  "error_description": "image format not supported."

Failure case:response.status = 404

  "error": "not_found",
  "error_description": "The customer with the id 31888 doesn't exist."

Failure case:response.status = 500
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."