(Quick Reference) Service: Update

Description: This web service is used in order to updates a existing customer group object into the database



URL with external_id:


Method: PUT

Request content type: application/json


NameDescriptionTypeRequiredexample values
idid of the segment to updateLong/StringYes777
referencethe new reference valueStringYes 
namethe new name valueStringYes 
descriptionthe new description valueStringNo 
reference must be unique

Success Output

Success case: response.status=200
    "id": 4,
    "name": "new Name",
    "reference": "777",
    "organization": "Lyon",
    "description": null,
    "dateCreated": "2016-08-16T15:36:21Z",
    "lastUpdated": "2016-08-16T15:52:11Z"

Failure Output

Failure case:response.status = 404
    "error": "not_found",
    "error_description": "The customer group with the id 999 doesn't exist."

Failure case:response.status = 400
    "error": "invalid_param_type",
    "error_description": "The type of parameter id you provided is not valid for this request."
    "error": "missing_param",
    "error_description": "reference parameter is missing"
    "error": "not_unique",
    "error_description": "reference already used"
     "error": "save_failed",
     "error_description": "Failed to save instance"

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