1. REST API for Oracle Commerce Cloud 21B
  2. Tasks
  3. Admin
  4. Profiles

updateProfile

put

/ccadmin/v1/profiles/{id}

Update Profile. This operation is used to update customer name, email address, phone number, shipping address and email marketing flag status of a customer profile. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Path Parameters
Query Parameters
  • As an alternative to the fields parameter, which explicitly specifies the properties to include, you can use the exclude parameter to include all properties except the ones specified. For example, to return all of the properties of profile except shippingAddresses.
  • Expand controls which properties are returned. Possible values for the expand query parameter are 'none' to get only the user ID or 'globalRoles' to include global roles along with the user's organizational roles.
  • You can use the fields parameter to restrict the set of properties returned to only those you explicitly specify. The properties are specified as a comma-separated list. For example, id and email properties of profile.
Header Parameters
Body ()
Root Schema : updateProfile_request
Type: object
Show Source
Example:
{
    "firstName":"Jack",
    "lastName":"Black",
    "GDPRProfileP13nConsentGranted":false,
    "gender":"male",
    "receiveEmail":"yes",
    "dateOfBirth":"null",
    "locale":"en",
    "email":"jack@example.com",
    "shippingAddresses":[
        {
            "lastName":"Black",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"405 Example Street",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":true,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jack",
            "phoneNumber":"555123456",
            "alias":"Address",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        },
        {
            "lastName":"Hill",
            "country":"United States",
            "types":[
                {
                    "id":"ss-100002"
                }
            ],
            "address3":"",
            "address2":"",
            "city":"Wake Forest",
            "prefix":"",
            "address1":"415 Example Road",
            "defaultCountryCode":"US",
            "postalCode":"27587",
            "jobTitle":"",
            "companyName":"",
            "county":"",
            "isDefaultAddress":false,
            "suffix":"",
            "selectedCountry":"US",
            "firstName":"Jill",
            "phoneNumber":"55512345",
            "alias":"Address##0",
            "faxNumber":"",
            "middleName":"",
            "state":"North Carolina",
            "selectedState":"NC",
            "state_ISOCode":"US-NC"
        }
    ]
}
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : updateProfile_response
Type: object
Show Source
Nested Schema : catalog
Type: object
The catalog associated with this profile.
Show Source
Nested Schema : contactBillingAddress
Type: object
The default billing address for B2B contact.
Show Source
Nested Schema : contactShippingAddress
Type: object
The default shipping address for B2B contact
Show Source
Nested Schema : currentOrganization
Type: object
The current Organization
Show Source
Nested Schema : dynamicProperties
Type: array
Read-only list of dynamic properties associated with profile along with meta-data.
Show Source
Nested Schema : loyaltyPrograms
Type: array
Loyalty Programs Information
Show Source
Nested Schema : parentOrganization
Type: object
The parent Organization associated with the B2B customer profile.
Show Source
Nested Schema : priceListGroup
Type: object
Price list group properties
Show Source
Nested Schema : roles
Type: array
List of roles assigned to the profile.
Show Source
Nested Schema : secondaryAddresses
Type: object
Secondary addresses for B2B contact.
Show Source
Nested Schema : secondaryOrganizations
Type: array
List of secondary organizations that need to associate with the user.
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the profile (Deprecated, please use 'shippingAddresses' instead).
Show Source
Nested Schema : shippingAddresses
Type: array
List of shipping addresses associated with profile.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : currency
Type: object
Currency of the price list group
Show Source
Nested Schema : listPriceList
Type: object
Show Source
Nested Schema : salePriceList
Type: object
Sale price list properties
Show Source
Nested Schema : shippingSurchargePriceList
Type: object
Shipping surcharge price list properties
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : types
Type: array
The types tagged to the address
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "derivedPriceListGroup":null,
    "lastName":"Anderson",
    "GDPRProfileP13nConsentDate":null,
    "GDPRProfileP13nConsentGranted":false,
    "gender":"female",
    "catalog":null,
    "roles":[
        {
            "function":"buyer",
            "relativeTo":{
                "id":"900004"
            },
            "repositoryId":"100006",
            "type":"organizationalRole"
        }
    ],
    "locale":"en",
    "parentOrganization":{
        "name":"Oracle",
        "repositoryId":"900004",
        "description":"Oracle Org",
        "active":true,
        "shippingAddress":{
        },
        "secondaryAddresses":[
            {
                "firstName":"Harry",
                "lastName":"Potter",
                "country":"United States",
                "externalAddressId":"EXT_ADDR_1",
                "types":[
                    {
                        "displayName":"Billing",
                        "repositoryId":"ss-10002",
                        "id":"ss-10002"
                    }
                ],
                "phoneNumber":"9088988999",
                "city":"Arcadia",
                "address2":"Suite 400",
                "address1":"Grundy Lane",
                "postalCode":"91006",
                "repositoryId":"110033",
                "state":"CA"
            }
        ],
        "id":"900004",
        "billingAddress":{
        },
        "externalOrganizationId":"EXT_ORG_1"
    },
    "shippingSurchargePriceList":null,
    "receiveEmailDate":null,
    "profileType":"b2b_user",
    "translations":{
    },
    "loyaltyPrograms":[
        {
            "programName":"XTRAREWARDS",
            "repositoryId":100001,
            "membershipId":"abc123",
            "programId":"prog1",
            "status":"Enrolled"
        },
        {
            "programName":"XTRAMILES",
            "repositoryId":100002,
            "membershipId":"xyz123",
            "programId":"prog2",
            "status":"RequestForEnrollment"
        }
    ],
    "id":"se-570031",
    "email":"kim@example.com",
    "daytimeTelephoneNumber":"212-555-1977",
    "derivedSalePriceList":null,
    "taxExempt":false,
    "customerContactId":"CRMID_12345",
    "receiveEmail":"no",
    "active":"true",
    "priceListGroup":null,
    "dateOfBirth":null,
    "firstName":"Kim",
    "repositoryId":"se-570031",
    "shippingAddress":{
    },
    "billingAddress":{
    },
    "userType":null,
    "derivedShippingSurchargePriceList":null,
    "secondaryOrganizations":[
    ],
    "shippingAddresses":[
    ]
}

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| |------------------|------------------| |100088|You cannot remove the Approver role from this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval.| |22000|If the profile id passes is null or empty| |100089|You cannot deactivate this contact. The account has no other active Approvers. Approvals are still enabled and/or there are orders pending approval| |22001|If there was any internal error while getting the profile| |22002|If there was no profile found with the given id| |89003|If user is removing admin role for himself| |22007|If invalid input is provided| |89001|If invalid roles are provided| |22024|{0}({1}) must be a String| |22025|Format for loyaltyPrograms is incorrect. Please refer to API doc for more information| |22026|{0} is either missing or incorrect.| |22027|Invalid state is provided.| |180106|One or more address type ID is invalid| |23041|You cannot activate or inactivate this profile as it is linked to multiple accounts.| |
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top