Jump to: navigation, search

updateRecordInProfileExtension

Purpose

Updates the content of a single record in a multi-valued extension. The attributes which are part of the 'unique' list specified at the Extension Schema creation are passed in the body and used to find the correct record to update. This update cannot change the values of the attributes which are part of the 'unique' list of the Extension Schema; 'unique' attributes are used as identifiers for the given record.

Workaround: If you wish to update a value for an attribute stamped as unique, you must delete the concerned record, then recreate this record with its correct values.

URL

  • PUT /profiles/{customer_id}/extensions/{extension_name}/by/unique

Request

URL Parameters

Key ValueType Value Description Mandatory Unique Default
customer_id String The unique ID of the given customer. true true
extension_name String The name of the Profile Extension to update. true true

HTTP Headers

Key ValueType Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true

Body

Key ValueType Value Description Mandatory Unique Default
attribute n String "single-valued" or "multi-valued" Individual attributes defined in the Profile Extension Schema.

(attribute n) corresponds to the attribute name defined in the schema. If the attribute is unique, its value is used to select the record to update. It is not updated. If the attribute is not unique, its value is updated.

true true


Sample

PUT /profiles/0000Sb5U97XE000Y/extensions/Phone/by/unique
 "PhoneType":0, 
 "prefix":"+33", 
 "PhoneNumber":"3145926535",
 "description":"family phone", 
 "start_availability":"2009-12-18T18:30:00.000Z", 
 "end_availability":"2009-12-18T21:40:00.000Z"
}

Responses

Success

ReturnCode ReturnString Description
204 OK Request successful

Error

FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.