updateProfileRequest
put
/ccstore/v1/profileRequests/{id}
Update Profile request. This operation is used to update Profile request in Oracle Commerce Cloud for a customer.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the Profile request to be updated.
Query Parameters
-
expand(optional): string
Expand query param : currently used to expand profile and request Info.(Allowed Values: profile - profile static data, profileAll - profile static & dynamic data, requestAll - profileRequest static & dynamic data).
Root Schema : updateProfileRequest_request
Type:
Show Source
object
-
organization(optional):
object organization
Organization
-
profile(optional):
object profile
Profile
-
requestedOrganizationID(optional):
string
Requested Organization ID given by the requester.
-
requestedOrganizationName(optional):
string
Requested Organization name given by the requester.
-
requesterComments(optional):
string
Requester comments given at time of creating request
-
status(optional):
string
status of the profile request (review, moreInfoNeeded) are values.
Example:
{
"requestedOrganizationName":"Sample org",
"organization":{
"id":"or-100001"
},
"profile":{
"firstName":"First name",
"lastName":"last name",
"customerContactId":"CRMID_1",
"email":"user@temp.com"
},
"requestedOrganizationID":null,
"requesterComments":"Some comments",
"status":"review"
}
Nested Schema : organization
Type:
object
Organization
Show Source
-
id(optional):
string
Repository Id of organization
Nested Schema : profile
Type:
object
Profile
Show Source
-
customerContactId(optional):
string
The external customer contact id.
-
email:
string
email id of profile
-
firstName(optional):
string
First name of the profile
-
id(optional):
string
Repository Id of the profile
-
lastName(optional):
string
Last name of the profile
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateProfileRequest_response
Type:
Show Source
object
-
approvedBy(optional):
string
Approved user of Profile Request
-
approvedSource(optional):
string
Approved source of Profile Request
-
approverComments(optional):
string
Profile request approver comments
-
createdTime(optional):
string
Created time of Profile Request
-
id(optional):
string
Id of Profile Request
-
lastModifiedTime(optional):
string
Lat modified time of Profile Request
-
organization(optional):
object organization
Organization
-
profile(optional):
object profile
Profile
-
requestedOrganizationID(optional):
string
Requested Organization ID given by the requester.
-
requestedOrganizationName(optional):
string
Requested Organization name given by the requester.
-
requesterComments(optional):
string
Requester comments given at time of creating request
-
siteId(optional):
string
Site captured during request creation
-
status(optional):
string
Status of Profile Request
Nested Schema : organization
Type:
object
Organization
Show Source
-
id(optional):
string
Repository Id of the Organization
Nested Schema : profile
Type:
object
Profile
Show Source
-
customerContactId(optional):
string
Customer contact ID of profile
-
email(optional):
string
email id of profile
-
firstName(optional):
string
First name of the profile
-
GDPRProfileP13nConsentDate(optional):
string
GDPR profile consent date of the profile
-
GDPRProfileP13nConsentGranted(optional):
boolean
GDPR profile consent granted flag
-
id(optional):
string
Repository Id of the profile
-
lastName(optional):
string
Last name of the profile
-
numberOfVisits(optional):
string
Number of vists of the profile
-
profileType(optional):
string
Profile type of profile
-
receiveEmailDate(optional):
string
Received email date of profile
Example Response (application/json)
{
"approverComments":null,
"requestedOrganizationName":null,
"profile":{
"id":"100001"
},
"siteId":"siteUS",
"requestedOrganizationID":null,
"id":"100001",
"requesterComments":"None",
"status":"review"
}
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|
|------------------|------------------|
|102000|Invalid Profile Request ID.|
|10001|Organization ID is required.|
|00004|Data value too long.|
|101008|This operation is not allowed as registration request is already in approved/rejected state.|
|101007|Invalid status for registration request. Allowed status are [review, moreInfoNeeded]|
|100018|If there was any internal error while updating the Organization|
|101014|Cannot update the status of this registration request to any value except "Rejected", because the requester's profile no longer exists|
|101017|This operation is not allowed as requester's profile no longer exists.
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code