1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Agent
  4. Customers

updateProfile

put

/ccagent/v1/profiles/{id}

Update Profile. Updates customer name, email address, phone number, shipping address and email marketing flag status of the profile depending on the profile ID. Dynamic Properties of profile can also be updated like any other attribute ("dynamicPropertyKey":"dynamicPropertyValue"). Takes additonal header parameter x-ccsite corresponding to which site specific properties should be updated. If x-ccsite value is not provided, it indicates default site.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The customer profile id.
Header Parameters
x-ccsite
Type: string
the site id corresponding to which site specific properties should be updated
Body Parameter
Root Schema : updateProfile_request
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Nested Schema : items
Type: object

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : updateProfile_response
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties associated with profile along with meta-data.
Nested Schema : roles
Type: array
List of role assigned to the profile.
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Nested Schema : items
Type: object
Example application/json

{
    "lastName":"Anderson",
    "dynamicProperties":[
        {
            "id":"dynamicPropertyMaritalStatus",
            "label":"Marital Status",
            "type":"string",
            "value":"Married"
        }
    ],
    "contactBillingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "phoneNumber":"212-555-2150",
        "address2":null,
        "city":"Buffalo",
        "address1":"451 Brooks Ave",
        "postalCode":"14201",
        "county":null,
        "repositoryId":"se-990031",
        "state":"NY"
    },
    "receiveEmail":"yes",
    "secondaryAddresses":{
        "Work":{
            "lastName":"Anderson",
            "firstName":"Kim",
            "country":"US",
            "phoneNumber":"212-555-2150",
            "address2":null,
            "city":"Buffalo",
            "address1":"451 Brooks Ave",
            "postalCode":"14201",
            "county":null,
            "repositoryId":"se-970031",
            "state":"NY"
        },
        "Mom' s house":{
            "lastName":"Anderson",
            "firstName":"Dolores",
            "country":"US",
            "phoneNumber":"212-555-4321",
            "address2":null,
            "city":"Dewitt",
            "address1":"41 Wexford Rd ",
            "postalCode":"13214",
            "county":null,
            "repositoryId":"se-140010",
            "state":"NY"
        },
        "Home":{
            "lastName":"dd",
            "firstName":"sdf",
            "country":"US",
            "phoneNumber":"1231231231",
            "address2":"f",
            "city":"f",
            "address1":"dd",
            "postalCode":"36123",
            "county":null,
            "repositoryId":"se-980031",
            "state":"AL"
        }
    },
    "contactShippingAddress":{
        "lastName":"dd",
        "firstName":"sdf",
        "country":"US",
        "phoneNumber":"1231231231",
        "address2":"f",
        "city":"f",
        "address1":"dd",
        "postalCode":"36123",
        "county":null,
        "repositoryId":"se-980031",
        "state":"AL"
    },
    "firstName":"Kim",
    "profileType":"b2b_user",
    "repositoryId":"120117",
    "shippingAddress":{
        "lastName":"Anderson",
        "firstName":"Kim",
        "country":"US",
        "phoneNumber":"212-555-1977",
        "address2":"",
        "city":"Montgomery",
        "address1":"21 Cedar Ave",
        "postalCode":"13202",
        "county":null,
        "repositoryId":"142021",
        "state":"NY"
    },
    "id":"120117",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "shippingAddresses":[
        {
            "lastName":"Anderson",
            "country":"United States",
            "address3":"",
            "address2":"",
            "city":"Syracuse",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":false,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        },
        {
            "lastName":"Anderson",
            "country":"United States",
            "address3":"",
            "address2":"",
            "city":"Montgomery",
            "prefix":"",
            "address1":"21 Cedar Ave",
            "postalCode":"13202",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Kim",
            "phoneNumber":"212-555-1977",
            "faxNumber":"",
            "middleName":"",
            "state":"New York",
            "selectedState":"NY",
            "state_ISOCode":"US-NY"
        }
    ]
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |200012|please provide valid input| |23010|City not specified in shipping address| |23011|Address line 1 not specified in shipping address| |22000|The profile id passes is null or empty.| |23012|No last name specified in shipping address| |22001|Internal error while getting the profile.| |23013|No first name specified in shipping address| |22002|No profile found with the given id.| |23015|Phone number not specified in shipping address| |23005|Invalid phone number in shipping address| |23007|No country specified in shipping address| |23008|Postal code not specified in shipping address|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Request:

{
  "dynamicPropertyMaritalStatus": "Married",
  "lastName": "Anderson",
  "firstName": "Kim",
  "receiveEmail": "yes",
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "shippingAddresses": [
    {
      "lastName": "Anderson",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Syracuse",
      "prefix": "",
      "address1": "21 Cedar Ave",
      "postalCode": "13202",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": false,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "faxNumber": "",
      "middleName": "",
      "state": "New York",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    {
      "lastName": "Anderson",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Montgomery",
      "prefix": "",
      "address1": "21 Cedar Ave",
      "postalCode": "13202",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": true,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "faxNumber": "",
      "middleName": "",
      "state": "New York",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    }
  ]
}

Sample Response Payload returned by endpoint:

{
  "lastName": "Anderson",
  "dynamicProperties": [{
    "id": "dynamicPropertyMaritalStatus",
    "label": "Marital Status",
    "type": "string",
    "value": "Married"
  }],
  "contactBillingAddress": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "country": "US",
    "phoneNumber": "212-555-2150",
    "address2": null,
    "city": "Buffalo",
    "address1": "451 Brooks Ave",
    "postalCode": "14201",
    "county": null,
    "repositoryId": "se-990031",
    "state": "NY"
  },
  "receiveEmail": "yes",
  "secondaryAddresses": {
    "Work": {
      "lastName": "Anderson",
      "firstName": "Kim",
      "country": "US",
      "phoneNumber": "212-555-2150",
      "address2": null,
      "city": "Buffalo",
      "address1": "451 Brooks Ave",
      "postalCode": "14201",
      "county": null,
      "repositoryId": "se-970031",
      "state": "NY"
    },
    "Mom' s house": {
      "lastName": "Anderson",
      "firstName": "Dolores",
      "country": "US",
      "phoneNumber": "212-555-4321",
      "address2": null,
      "city": "Dewitt",
      "address1": "41 Wexford Rd ",
      "postalCode": "13214",
      "county": null,
      "repositoryId": "se-140010",
      "state": "NY"
    },
    "Home": {
      "lastName": "dd",
      "firstName": "sdf",
      "country": "US",
      "phoneNumber": "1231231231",
      "address2": "f",
      "city": "f",
      "address1": "dd",
      "postalCode": "36123",
      "county": null,
      "repositoryId": "se-980031",
      "state": "AL"
    }
  },
  "contactShippingAddress": {
    "lastName": "dd",
    "firstName": "sdf",
    "country": "US",
    "phoneNumber": "1231231231",
    "address2": "f",
    "city": "f",
    "address1": "dd",
    "postalCode": "36123",
    "county": null,
    "repositoryId": "se-980031",
    "state": "AL"
  },
  "firstName": "Kim",
  "profileType": "b2b_user",
  "repositoryId": "120117",
  "shippingAddress": {
    "lastName": "Anderson",
    "firstName": "Kim",
    "country": "US",
    "phoneNumber": "212-555-1977",
    "address2": "",
    "city": "Montgomery",
    "address1": "21 Cedar Ave",
    "postalCode": "13202",
    "county": null,
    "repositoryId": "142021",
    "state": "NY"
  },
  "id": "120117",
  "email": "kim@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "shippingAddresses": [
    {
      "lastName": "Anderson",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Syracuse",
      "prefix": "",
      "address1": "21 Cedar Ave",
      "postalCode": "13202",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": false,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "faxNumber": "",
      "middleName": "",
      "state": "New York",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    },
    {
      "lastName": "Anderson",
      "country": "United States",
      "address3": "",
      "address2": "",
      "city": "Montgomery",
      "prefix": "",
      "address1": "21 Cedar Ave",
      "postalCode": "13202",
      "jobTitle": "",
      "companyName": "",
      "county": "",
      "isDefaultAddress": true,
      "suffix": "",
      "selectedCountry": "US",
      "firstName": "Kim",
      "phoneNumber": "212-555-1977",
      "faxNumber": "",
      "middleName": "",
      "state": "New York",
      "selectedState": "NY",
      "state_ISOCode": "US-NY"
    }
  ]
}