Jump to: navigation, search

updateCustomerProfile

Purpose

Overrides the attributes of the customer profile—prior attribute values are lost and replaced with the attribute list specified in the body of the request. This operation uses the standard convention for HTTP PUT, which requires you to update the profile with the complete profile to avoid losing information. Your application should use this operation in conjunction with the Query Customer Profile operation:

  • Query the Customer Profile
  • Modify the Customer Profile data
  • Update the Customer Profile.

Extensions can be part of the profile used for the update: If your application does not include any extensions in the body, no modification occurs on extensions. If your application specifies extension values, extension information is overridden. Your application must specify the complete extension set to avoid losing data.

URL

  • PUT /profiles/{customer_id}

Request

URL Parameters

Key ValueType Value Description Mandatory Unique Default
customer_id String customerId The unique ID of the given customer. 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" The complete set of customer attributes, where (attribute n) is the attribute name. See the configuration options for further details. The date/time formats are ISO 8601: [YYYY]-[MM]-[DD]T[HH]:[mm]:[ss].[SSS]Z.

Note: Attributes will be overridden. This representation must contain all the profile attributes' values, including those that were not modified.

true true
extension n String Extensions, where (extension n) corresponds to the unique name of the profile extension resource.

Note: If you specify extensions, extensions are overridden. If you wish to modify an extension value, this representation must contain all the profile extensions, including those that were not modified.

false true


Sample

PUT http://ucsserver.mycompany.com:8080/path/profiles/00027a52JCGY000M
Content-Location /profiles/00027a52JCGY000M
Content-Type: application/json
  {
 "FirstName": "Bruce", 
 "LastName": "Banner",
 "DOB": "1962-05-10",
 "EmailAddress": [
      "bruce.banner@marvelous.com",
      "b.banner@hulk.dom"
 ],
 "Address": { "Type":1, "Address":"21 JumpStreet", "City":"Hollywood", 
              "County":"Santa Barbara", "PostCode":"555", "Country":"United States" }
}

Responses

Success

ReturnCode ReturnString Description
200 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.