REST API for Oracle Commerce Cloud

createProfileRequest

post

/ccadmin/v1/webhook/createProfileRequest

The details of profile request created on the Oracle Commerce Cloud. The request includes profile and organization details

Request

Supported Media Types

application/json

Root Schema : createProfileRequest_request

Type: object

Show Source

profile(required): object profile

Profile
requestedOrganization: object requestedOrganization

Requested Organization
requesterComments: string

Requester comments given at time of creating request

{
    "properties":{
        "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"
                },
                "receiveEmail":{
                    "description":"Receive email newsletters",
                    "type":"string"
                },
                "partyId":{
                    "description":"Party id of Contact",
                    "type":"number"
                },
                "partyNumber":{
                    "description":"Party number of Contact",
                    "type":"string"
                },
                "email":{
                    "description":"email id of profile",
                    "type":"string"
                }
            },
            "required":[
                "email",
                "firstName",
                "lastName"
            ]
        },
        "requesterComments":{
            "description":"Requester comments given at time of creating request",
            "type":"string"
        },
        "requestedOrganization":{
            "description":"Requested Organization",
            "type":"object",
            "properties":{
                "name":{
                    "description":"The name for Organization",
                    "type":"string"
                },
                "id":{
                    "description":"ID of an Organization",
                    "type":"string"
                }
            }
        }
    },
    "required":[
        "profile"
    ],
    "example":{
        "profile":{
            "firstName":"First name",
            "lastName":"last name",
            "customerContactId":"CRMID_1",
            "email":"user@temp.com"
        },
        "requesterComments":"Some comments",
        "requestedOrganization":{
            "name":"Oracle"
        }
    }
}

Example:

{
    "profile":{
        "firstName":"First name",
        "lastName":"last name",
        "customerContactId":"CRMID_1",
        "email":"user@temp.com"
    },
    "requesterComments":"Some comments",
    "requestedOrganization":{
        "name":"Oracle"
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

customerContactId: string

The external customer contact id.
email(required): string

email id of profile
firstName(required): string

First name of the profile
lastName(required): string

Last name of the profile
partyId: number

Party id of Contact
partyNumber: string

Party number of Contact
receiveEmail: string

Receive email newsletters

{
    "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"
        },
        "receiveEmail":{
            "description":"Receive email newsletters",
            "type":"string"
        },
        "partyId":{
            "description":"Party id of Contact",
            "type":"number"
        },
        "partyNumber":{
            "description":"Party number of Contact",
            "type":"string"
        },
        "email":{
            "description":"email id of profile",
            "type":"string"
        }
    },
    "required":[
        "email",
        "firstName",
        "lastName"
    ]
}

Nested Schema : requestedOrganization

Type: object

Requested Organization

Show Source

id: string

ID of an Organization
name: string

The name for Organization

{
    "description":"Requested Organization",
    "type":"object",
    "properties":{
        "name":{
            "description":"The name for Organization",
            "type":"string"
        },
        "id":{
            "description":"ID of an Organization",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

No response is returned as this is an event webhook

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}