Reject profile request
post
/ccagent/v1/profileRequests/{id}/reject
endpoint. This operation is used to reject profile request in Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the Profile request.
Header Parameters
-
X-CCAgentContext: string
The Agent Context is a JSON object with shopperProfileId as a property.
-
X-CCOrganization: string
The organization Id associated with the shopper profile
Root Schema : rejectProfileRequest_request
Type:
Show Source
object
-
approverComments:
string
Approver comments during request rejection, these are optional.
Example:
{
"approverComments":"This request is rejected"
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : rejectProfileRequest_response
Type:
Show Source
object
-
status(optional):
string
Status of Profile Request
Example Response (application/json)
{
"status":"rejected"
}
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.|
|101008|This operation is not allowed as registration request is already in approved/rejected state.|
|100091|Agent does not have permission to perform this action.|
|89101|If the shopperProfile passed in the AgentContext header is not an administrator for the account
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