Jump to

• Request
• Response

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

Body ()

Root Schema : createProfileRequest_request

Type: object

Show Source

• profileRequest: object profileRequest

{
    "properties":{
        "profileRequest":{
            "properties":{
                "lastModifiedTime":{
                    "format":"date-time",
                    "description":"The date profile request was modified",
                    "type":"string"
                },
                "requestedOrganizationName":{
                    "description":"Requested Organization name given by the requester",
                    "type":"string"
                },
                "profile":{
                    "description":"Profile",
                    "type":"object",
                    "properties":{
                        "numberOfVisits":{
                            "description":"Number of visits related to profile",
                            "type":"integer"
                        },
                        "lastName":{
                            "description":"Last name of the profile",
                            "type":"string"
                        },
                        "firstName":{
                            "description":"first name of the profile",
                            "type":"string"
                        },
                        "GDPRProfileP13nConsentDate":{
                            "description":"The date on which GDPR personalization consent is granted for the profile.",
                            "type":"string"
                        },
                        "customerContactId":{
                            "description":"The external customer contact id.",
                            "type":"string"
                        },
                        "GDPRProfileP13nConsentGranted":{
                            "description":"This is GDPR profile personalization consent flag. can be true or false.",
                            "type":"boolean"
                        },
                        "profileType":{
                            "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
                            "type":"string"
                        },
                        "id":{
                            "description":"Repository Id of the profile",
                            "type":"string"
                        },
                        "partyId":{
                            "description":"CDM PartyId for this Profile",
                            "type":"number"
                        },
                        "partyNumber":{
                            "description":"CDM PartyNumber for this Profile",
                            "type":"string"
                        },
                        "receiveEmailDate":{
                            "description":"The date on which email marketing consent is granted for the profile.",
                            "type":"string"
                        },
                        "email":{
                            "description":"Email id of the profile",
                            "type":"string"
                        }
                    }
                },
                "organization":{
                    "description":"Organization",
                    "properties":{
                        "id":{
                            "description":"Repository Id of the Organization",
                            "type":"string"
                        }
                    }
                },
                "requestedOrganizationId":{
                    "description":"Requested Organization ID given by requester",
                    "type":"string"
                },
                "createdTime":{
                    "format":"date-time",
                    "description":"The date profile request was created",
                    "type":"string"
                },
                "siteId":{
                    "description":"Site captured during request creation",
                    "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 : profileRequest

Type: object

Show Source

• createdTime: string(date-time)
  The date profile request was created
• id: string
  Id of Profile Request
• lastModifiedTime: string(date-time)
  The date profile request was modified
• organization: object organization
  Organization
• profile: object profile
  Profile
• requestedOrganizationId: string
  Requested Organization ID given by requester
• requestedOrganizationName: string
  Requested Organization name given by the requester
• requesterComments: string
  Requester comments given at time of creating request
• siteId: string
  Site captured during request creation
• status: string
  Status of Profile Request

{
    "properties":{
        "lastModifiedTime":{
            "format":"date-time",
            "description":"The date profile request was modified",
            "type":"string"
        },
        "requestedOrganizationName":{
            "description":"Requested Organization name given by the requester",
            "type":"string"
        },
        "profile":{
            "description":"Profile",
            "type":"object",
            "properties":{
                "numberOfVisits":{
                    "description":"Number of visits related to profile",
                    "type":"integer"
                },
                "lastName":{
                    "description":"Last name of the profile",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the profile",
                    "type":"string"
                },
                "GDPRProfileP13nConsentDate":{
                    "description":"The date on which GDPR personalization consent is granted for the profile.",
                    "type":"string"
                },
                "customerContactId":{
                    "description":"The external customer contact id.",
                    "type":"string"
                },
                "GDPRProfileP13nConsentGranted":{
                    "description":"This is GDPR profile personalization consent flag. can be true or false.",
                    "type":"boolean"
                },
                "profileType":{
                    "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
                    "type":"string"
                },
                "id":{
                    "description":"Repository Id of the profile",
                    "type":"string"
                },
                "partyId":{
                    "description":"CDM PartyId for this Profile",
                    "type":"number"
                },
                "partyNumber":{
                    "description":"CDM PartyNumber for this Profile",
                    "type":"string"
                },
                "receiveEmailDate":{
                    "description":"The date on which email marketing consent is granted for the profile.",
                    "type":"string"
                },
                "email":{
                    "description":"Email id of the profile",
                    "type":"string"
                }
            }
        },
        "organization":{
            "description":"Organization",
            "properties":{
                "id":{
                    "description":"Repository Id of the Organization",
                    "type":"string"
                }
            }
        },
        "requestedOrganizationId":{
            "description":"Requested Organization ID given by requester",
            "type":"string"
        },
        "createdTime":{
            "format":"date-time",
            "description":"The date profile request was created",
            "type":"string"
        },
        "siteId":{
            "description":"Site captured during request creation",
            "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 : organization

Type: object

Organization

Show Source

• id: string
  Repository Id of the Organization

{
    "description":"Organization",
    "properties":{
        "id":{
            "description":"Repository Id of the Organization",
            "type":"string"
        }
    }
}

Nested Schema : profile

Type: object

Profile

Show Source

• customerContactId: string
  The external customer contact id.
• email: string
  Email id of the profile
• firstName: string
  first name of the profile
• GDPRProfileP13nConsentDate: string
  The date on which GDPR personalization consent is granted for the profile.
• GDPRProfileP13nConsentGranted: boolean
  This is GDPR profile personalization consent flag. can be true or false.
• id: string
  Repository Id of the profile
• lastName: string
  Last name of the profile
• numberOfVisits: integer
  Number of visits related to profile
• partyId: number
  CDM PartyId for this Profile
• partyNumber: string
  CDM PartyNumber for this Profile
• profileType: string
  Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'
• receiveEmailDate: string
  The date on which email marketing consent is granted for the profile.

{
    "description":"Profile",
    "type":"object",
    "properties":{
        "numberOfVisits":{
            "description":"Number of visits related to profile",
            "type":"integer"
        },
        "lastName":{
            "description":"Last name of the profile",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the profile",
            "type":"string"
        },
        "GDPRProfileP13nConsentDate":{
            "description":"The date on which GDPR personalization consent is granted for the profile.",
            "type":"string"
        },
        "customerContactId":{
            "description":"The external customer contact id.",
            "type":"string"
        },
        "GDPRProfileP13nConsentGranted":{
            "description":"This is GDPR profile personalization consent flag. can be true or false.",
            "type":"boolean"
        },
        "profileType":{
            "description":"Type of profile. It can be 'b2c_user', 'b2b_user' or 'b2b_user_pending'",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the profile",
            "type":"string"
        },
        "partyId":{
            "description":"CDM PartyId for this Profile",
            "type":"number"
        },
        "partyNumber":{
            "description":"CDM PartyNumber for this Profile",
            "type":"string"
        },
        "receiveEmailDate":{
            "description":"The date on which email marketing consent is granted for the profile.",
            "type":"string"
        },
        "email":{
            "description":"Email id of the profile",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top