Jump to

• Request
• Response

updateProfileRequest

put

/ccagent/v1/profileRequests/{id}

Update Profile request. This operation is used to update an 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).

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

Body ()

Root Schema : updateProfileRequest_request

Type: object

Show Source

• 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.

{
    "properties":{
        "requestedOrganizationName":{
            "description":"Requested Organization name given by the requester.",
            "type":"string"
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"First name of the profile",
                    "type":"string"
                },
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "email":{
                    "description":"email id of profile",
                    "type":"string"
                }
            },
            "required":[
                "email"
            ]
        },
        "requestedOrganizationID":{
            "description":"Requested Organization ID given by the requester.",
            "type":"string"
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "status":{
            "description":"status of the profile request (review, moreInfoNeeded) are values.",
            "type":"string"
        }
    },
    "example":{
        "requestedOrganizationName":"Sample org",
        "profile":{
            "firstName":"First name",
            "lastName":"last name",
            "customerContactId":"CRMID_1",
            "email":"[e-mail]"
        },
        "requestedOrganizationID":null,
        "requesterComments":"Some comments",
        "status":"review"
    }
}

Example:

{
    "requestedOrganizationName":"Sample org",
    "profile":{
        "firstName":"First name",
        "lastName":"last name",
        "customerContactId":"CRMID_1",
        "email":"[e-mail]"
    },
    "requestedOrganizationID":null,
    "requesterComments":"Some comments",
    "status":"review"
}

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

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First name of the profile",
            "type":"string"
        },
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "email":{
            "description":"email id of profile",
            "type":"string"
        }
    },
    "required":[
        "email"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateProfileRequest_response

Type: object

Show Source

• approverComments(optional): string
  Profile request approver comments
• id(optional): string
  Id of Profile Request
• 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

{
    "properties":{
        "approverComments":{
            "description":"Profile request approver comments",
            "type":"string"
        },
        "requestedOrganizationName":{
            "description":"Requested Organization name given by the requester.",
            "type":"string"
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "firstName":{
                    "description":"First name of the profile",
                    "type":"string"
                },
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "email":{
                    "description":"email id of profile",
                    "type":"string"
                }
            }
        },
        "siteId":{
            "description":"Site captured during request creation",
            "type":"string"
        },
        "requestedOrganizationID":{
            "description":"Requested Organization ID given by the requester.",
            "type":"string"
        },
        "id":{
            "description":"Id of Profile Request",
            "type":"string"
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "status":{
            "description":"Status of Profile Request",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

• customerContactId(optional): string
  The external customer contact id.
• email(optional): 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

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "firstName":{
            "description":"First name of the profile",
            "type":"string"
        },
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "email":{
            "description":"email id of profile",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "approverComments":null,
    "requestedOrganizationName":null,
    "profile":{
        "id":"100001"
    },
    "organization":{
        "id":"150002"
    },
    "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.| |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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top