# Upsert Universal Profile Endpoint: POST /profile/upsert Version: 3.0.0 Security: bearerAuth, apiKeyAuth ## Security: - `bearerAuth` (unknown) http bearer Token - `apiKeyAuth` (unknown) apiKey in header Key ## Request fields (application/json): - `id` (string) Unique identifier of the unified profile - `contact` (object) Contact Information of the profile. - `contact.firstName` (string) First Name of the profile - `contact.maidenName` (string) Maiden Name of the profile - `contact.lastName` (string) Last Name of the profile - `contact.fullName` (string) Full Name of the profile - `contact.email` (string) Email id of the profile - `contact.username` (string) Username of the profile - `contact.phoneNo` (string) Phone number of the profile - `contact.address` (object) Address of the profile - `contact.address.street1` (string) First line of the user's address - `contact.address.street2` (string) Second line of the user's address - `contact.address.city` (string) The city of the user's address to help identify the location. - `contact.address.state` (string) The state of the user's address. - `contact.address.country` (string) The country of the user's address. - `contact.address.postalCode` (string) ZIP Code of the address - `contact.website` (array) List of websites for the profile - `contact.phoneDetails` (array) phoneDetails for the profile - `contact.phoneDetails.phoneNo` (string) Phone No of the profile - `contact.phoneDetails.countryCode` (string) Country Code of the profile - `contact.emailDetails` (array) emailDetails for the profile - `contact.emailDetails.email` (string) Email id of the profile - `contact.emailDetails.type` (string) type of email - `demographics` (object) Demographic details of the profile. - `demographics.age` (integer) Age of the profile - `demographics.location` (string) Location of the profile - `demographics.gender` (string) Gender of the profile - `demographics.language` (string) Language of the profile - `demographics.additional` (object) Additional demographics - `works` (array) Work history of the profile. - `works.name` (string) Name of a company - `works.description` (string) Description of a company - `works.title` (string) Title of profile in company - `works.startDate` (string) Start date in a company - `works.endDate` (string) End date in a company - `works.location` (string) Location of a company - `works.department` (string) Department of a profile in company - `profiles` (array) List of social identities linked to the profile. - `profiles.name` (string, required) name of the person - `profiles.channelType` (string, required) channel type of the profile. e.g. twitter - `profiles.channelId` (string, required) unique id of the profile on channel - `profiles.permalink` (string, required) link of the profile on social channel - `profiles.avatarUrl` (string) profile image link - `profiles.profileImageUrl` (string) profile image link - `profiles.coverImageUrl` (string) cover image link - `profiles.bio` (string) Detailed description about the user - `profiles.followers` (integer) followers count of the user - `profiles.following` (integer) count of users/pages being followed by this user - `profiles.username` (string) unique identifier of the user - `profiles.verified` (boolean) true if the user is verified by the channel - `profiles.unSubscribed` (boolean) true if the user is subscribed for email and other activities - `profiles.deleted` (boolean) true if profile is deleted natively - `profiles.snCreatedTime` (integer) Social Channel Created Time - `profiles.snModifiedTime` (integer) Social Channel Modified Time - `profiles.statusCount` (integer) Status count for profile - `profiles.accountSpecificInfos` (array) Account Specific Info - `profiles.accountSpecificInfos.accountId` (integer) - `profiles.accountSpecificInfos.externalId` (string) - `profiles.accountSpecificInfos.lastBrandEngagedTime` (integer) - `profiles.accountSpecificInfos.lastFanEngagedTime` (integer) - `profiles.accountSpecificInfos.optIn` (boolean) - `profiles.accountSpecificInfos.fanSubscriptionState` (string) - `profiles.accountSpecificInfos.activeUser` (boolean) - `profiles.accountSpecificInfos.invited` (boolean) - `profiles.additional` (object) Additional Info for profile - `profiles.birthDate` (string) Birth Date for profile - `profiles.url` (string) Url for profile - `profiles.maritalStatus` (string) Marital Status for profile - `profileWorkflow` (object) List of social identities linked to the profile. - `profileWorkflow.profileLists` (array) Partner profile lists on the profile, if any. - `profileWorkflow.customProperties` (object) Partner custom properties on the profile, if any. - `profileWorkflow.profileSpaceWorkflows` (array) List of client level workflows on the profile, if any. - `profileWorkflow.profileSpaceWorkflows.spaceId` (string, required) client id - `profileWorkflow.profileSpaceWorkflows.modifiedTime` (integer) Last modified time of the space workflow - `profileWorkflow.profileSpaceWorkflows.customProperties` (object) Client custom properties on the asset, if any. - `profileWorkflow.profileSpaceWorkflows.queues` (array) Client queue details of the message, if any. - `profileWorkflow.profileSpaceWorkflows.queues.queueId` (integer) queue identifier to add the message to queue. - `profileWorkflow.profileSpaceWorkflows.queues.assignmentTime` (integer) assignment time of the queue to the message. - `profileWorkflow.profileSpaceWorkflows.profileLists` (array) Client profile lists on the profile, if any. - `profileWorkflow.profileSpaceWorkflows.tags` (array) Client tags on the profile, if any. - `createdTime` (integer) Created time of the profile in sprinklr. - `modifiedTime` (integer) Last modified time of the profile in sprinklr. - `organizations` (array) Organizations of the profile - `organizations.description` (string) Description of Organization - `organizations.endMonthYear` (string) End Month Year of Organization - `organizations.name` (string) Name of Organization - `organizations.position` (string) Position in Organization - `organizations.startMonthYear` (string) Start Month Year of Organization - `certificates` (array) Certificates of the profile - `certificates.authority` (string) Providing Authority of Certificate - `certificates.company` (object) Company that provided Certificate - `certificates.endMonthYear` (string) End Month Year of Certificate - `certificates.licenseNumber` (string) License Number of Certificate - `certificates.name` (string) Name of Certificate - `certificates.startMonthYear` (string) Start Month Year of Certificate - `certificates.url` (string) URL of Certificate - `recommendations` (array) Recommendations of the profile - `recommendations.subject` (string) Subject of Recommendation - `recommendations.recommendationText` (string) Text of Recommendation - `recommendations.recommendee` (string) Recommendee of Recommendation - `recommendations.recommender` (string) Recommender of Recommendation - `recommendations.recommenderName` (string) Recommender Name of Recommendation - `recommendations.status` (string) Status of Recommendation - `recommendations.recommendeeEntity` (string) Recommendee Entity of Recommendation - `recommendations.recommendeePosition` (string) Recommendee Position of Recommendation - `recommendations.relationship` (string) Relationship with recommender - `recommendations.relationshipDescription` (string) Relationship Description with recommender - `recommendations.createdTime` (integer) Created time of Recommendation - `recommendations.lastModifiedTime` (integer) Last Modified time of Recommendation - `recommendations.visibilityForRecommender` (string) Visibility For Recommender - `educations` (array) Educations of the profile - `educations.name` (string) Name of a Education Institution - `educations.type` (string) Type of a Education - `educations.year` (string) Passing year - `educations.startMonthYear` (string) Start time of Education - `educations.grade` (string) Grade Achieved - `educations.notes` (string) Some extra notes - `educations.activities` (string) Activities performed while Education - `educations.fieldsOfStudy` (string) Study fields of Education - `languages` (array) Languages of the profile - `languages.name` (string) Name of Language - `languages.proficiency` (string) Proficiency in Language - `skills` (array) Skills of the profile - `skills.label` (string) Label for Skill - `courses` (array) Courses of the profile - `courses.name` (string) Name of course - `courses.number` (string) Number in course - `honors` (array) Honors of the profile - `honors.description` (string) Description of Honors - `honors.issueDate` (string) Issue Date of Honors - `honors.issuer` (string) Issuer of Honors - `honors.title` (string) Title of Honors - `patents` (array) Patents of the profile - `patents.applicationNumber` (string) Application Number of Patent - `patents.description` (string) Description of Patent - `patents.filingDate` (string) Filing date of Patent - `patents.issueDate` (string) Issue date of Patent - `patents.issuer` (string) Issuer of Patent - `patents.title` (string) Title of Patent - `patents.url` (string) URL of Patent - `projects` (array) Projects of the profile - `projects.description` (string) Description of project - `projects.endMonthYear` (string) End Month Year of project - `projects.singleDate` (string) Description of project - `projects.startMonthYear` (string) Single date of project - `projects.title` (string) Start Month Year of project - `projects.url` (string) URL of project - `publications` (array) Publications of the profile - `publications.date` (string) Date of publication - `publications.description` (string) Description of publication - `publications.name` (string) Name of publication - `publications.publisher` (string) Publisher of publication - `publications.url` (string) URL of publication - `testScores` (array) Test scores of the profile - `testScores.date` (string) Date of Score - `testScores.description` (string) Description of Score - `testScores.name` (string) Name of Score - `testScores.score` (string) Score for Profile - `voluntaryExp` (array) Voluntary Experience of the profile - `voluntaryExp.cause` (string) Cause of Voluntary Experience - `voluntaryExp.companyName` (string) Company Name of Voluntary Experience - `voluntaryExp.description` (string) Cause of Voluntary Experience - `voluntaryExp.endMonthYear` (string) End Month Year of Voluntary Experience - `voluntaryExp.role` (string) Role of Voluntary Experience - `voluntaryExp.singleDate` (string) Single Date of Voluntary Experience - `voluntaryExp.startMonthYear` (string) Start Month Year of Voluntary Experience - `operatingHours` (object) Operating Hours of the profile - `operatingHours.regularHours` (array) Regular Hours of the Operating Hours - `operatingHours.regularHours.startDate` (integer) Start Date of the Time Period - `operatingHours.regularHours.endDate` (integer) End Date of the Time Period - `operatingHours.regularHours.openDay` (string) Open day of the Time Period - `operatingHours.regularHours.openTime` (string) Open time of the Time Period - `operatingHours.regularHours.closeDay` (string) Close day of the Time Period - `operatingHours.regularHours.closeTime` (string) Close time of the Time Period - `operatingHours.regularHours.closed` (boolean) is Closed for Time Period - `operatingHours.specialHours` (array) Special Hours of the Operating Hours - `customPropertiesMetadata` (array) Custom Property details - `customPropertiesMetadata.fieldName` (string) CustomField fieldName - `customPropertiesMetadata.type` (string) CustomField type - `customPropertiesMetadata.label` (string) CustomField label - `customPropertiesMetadata.clientCustomProperty` (boolean) Client CustomField - `customPropertiesMetadata.values` (array) Custom Field values - `restricted` (boolean) Profile Masked Flag ## Response 200: - `200` (unknown) Success ## Response 200 fields (application/json): - `id` (string) Unique identifier of the unified profile - `contact` (object) Contact Information of the profile. - `contact.firstName` (string) First Name of the profile - `contact.maidenName` (string) Maiden Name of the profile - `contact.lastName` (string) Last Name of the profile - `contact.fullName` (string) Full Name of the profile - `contact.email` (string) Email id of the profile - `contact.username` (string) Username of the profile - `contact.phoneNo` (string) Phone number of the profile - `contact.address` (object) Address of the profile - `contact.address.street1` (string) First line of the user's address - `contact.address.street2` (string) Second line of the user's address - `contact.address.city` (string) The city of the user's address to help identify the location. - `contact.address.state` (string) The state of the user's address. - `contact.address.country` (string) The country of the user's address. - `contact.address.postalCode` (string) ZIP Code of the address - `contact.website` (array) List of websites for the profile - `contact.phoneDetails` (array) phoneDetails for the profile - `contact.phoneDetails.phoneNo` (string) Phone No of the profile - `contact.phoneDetails.countryCode` (string) Country Code of the profile - `contact.emailDetails` (array) emailDetails for the profile - `contact.emailDetails.email` (string) Email id of the profile - `contact.emailDetails.type` (string) type of email - `demographics` (object) Demographic details of the profile. - `demographics.age` (integer) Age of the profile - `demographics.location` (string) Location of the profile - `demographics.gender` (string) Gender of the profile - `demographics.language` (string) Language of the profile - `demographics.additional` (object) Additional demographics - `works` (array) Work history of the profile. - `works.name` (string) Name of a company - `works.description` (string) Description of a company - `works.title` (string) Title of profile in company - `works.startDate` (string) Start date in a company - `works.endDate` (string) End date in a company - `works.location` (string) Location of a company - `works.department` (string) Department of a profile in company - `profiles` (array) List of social identities linked to the profile. - `profiles.name` (string, required) name of the person - `profiles.channelType` (string, required) channel type of the profile. e.g. twitter - `profiles.channelId` (string, required) unique id of the profile on channel - `profiles.permalink` (string, required) link of the profile on social channel - `profiles.avatarUrl` (string) profile image link - `profiles.profileImageUrl` (string) profile image link - `profiles.coverImageUrl` (string) cover image link - `profiles.bio` (string) Detailed description about the user - `profiles.followers` (integer) followers count of the user - `profiles.following` (integer) count of users/pages being followed by this user - `profiles.username` (string) unique identifier of the user - `profiles.verified` (boolean) true if the user is verified by the channel - `profiles.unSubscribed` (boolean) true if the user is subscribed for email and other activities - `profiles.deleted` (boolean) true if profile is deleted natively - `profiles.snCreatedTime` (integer) Social Channel Created Time - `profiles.snModifiedTime` (integer) Social Channel Modified Time - `profiles.statusCount` (integer) Status count for profile - `profiles.accountSpecificInfos` (array) Account Specific Info - `profiles.accountSpecificInfos.accountId` (integer) - `profiles.accountSpecificInfos.externalId` (string) - `profiles.accountSpecificInfos.lastBrandEngagedTime` (integer) - `profiles.accountSpecificInfos.lastFanEngagedTime` (integer) - `profiles.accountSpecificInfos.optIn` (boolean) - `profiles.accountSpecificInfos.fanSubscriptionState` (string) - `profiles.accountSpecificInfos.activeUser` (boolean) - `profiles.accountSpecificInfos.invited` (boolean) - `profiles.additional` (object) Additional Info for profile - `profiles.birthDate` (string) Birth Date for profile - `profiles.url` (string) Url for profile - `profiles.maritalStatus` (string) Marital Status for profile - `profileWorkflow` (object) List of social identities linked to the profile. - `profileWorkflow.profileLists` (array) Partner profile lists on the profile, if any. - `profileWorkflow.customProperties` (object) Partner custom properties on the profile, if any. - `profileWorkflow.profileSpaceWorkflows` (array) List of client level workflows on the profile, if any. - `profileWorkflow.profileSpaceWorkflows.spaceId` (string, required) client id - `profileWorkflow.profileSpaceWorkflows.modifiedTime` (integer) Last modified time of the space workflow - `profileWorkflow.profileSpaceWorkflows.customProperties` (object) Client custom properties on the asset, if any. - `profileWorkflow.profileSpaceWorkflows.queues` (array) Client queue details of the message, if any. - `profileWorkflow.profileSpaceWorkflows.queues.queueId` (integer) queue identifier to add the message to queue. - `profileWorkflow.profileSpaceWorkflows.queues.assignmentTime` (integer) assignment time of the queue to the message. - `profileWorkflow.profileSpaceWorkflows.profileLists` (array) Client profile lists on the profile, if any. - `profileWorkflow.profileSpaceWorkflows.tags` (array) Client tags on the profile, if any. - `createdTime` (integer) Created time of the profile in sprinklr. - `modifiedTime` (integer) Last modified time of the profile in sprinklr. - `organizations` (array) Organizations of the profile - `organizations.description` (string) Description of Organization - `organizations.endMonthYear` (string) End Month Year of Organization - `organizations.name` (string) Name of Organization - `organizations.position` (string) Position in Organization - `organizations.startMonthYear` (string) Start Month Year of Organization - `certificates` (array) Certificates of the profile - `certificates.authority` (string) Providing Authority of Certificate - `certificates.company` (object) Company that provided Certificate - `certificates.endMonthYear` (string) End Month Year of Certificate - `certificates.licenseNumber` (string) License Number of Certificate - `certificates.name` (string) Name of Certificate - `certificates.startMonthYear` (string) Start Month Year of Certificate - `certificates.url` (string) URL of Certificate - `recommendations` (array) Recommendations of the profile - `recommendations.subject` (string) Subject of Recommendation - `recommendations.recommendationText` (string) Text of Recommendation - `recommendations.recommendee` (string) Recommendee of Recommendation - `recommendations.recommender` (string) Recommender of Recommendation - `recommendations.recommenderName` (string) Recommender Name of Recommendation - `recommendations.status` (string) Status of Recommendation - `recommendations.recommendeeEntity` (string) Recommendee Entity of Recommendation - `recommendations.recommendeePosition` (string) Recommendee Position of Recommendation - `recommendations.relationship` (string) Relationship with recommender - `recommendations.relationshipDescription` (string) Relationship Description with recommender - `recommendations.createdTime` (integer) Created time of Recommendation - `recommendations.lastModifiedTime` (integer) Last Modified time of Recommendation - `recommendations.visibilityForRecommender` (string) Visibility For Recommender - `educations` (array) Educations of the profile - `educations.name` (string) Name of a Education Institution - `educations.type` (string) Type of a Education - `educations.year` (string) Passing year - `educations.startMonthYear` (string) Start time of Education - `educations.grade` (string) Grade Achieved - `educations.notes` (string) Some extra notes - `educations.activities` (string) Activities performed while Education - `educations.fieldsOfStudy` (string) Study fields of Education - `languages` (array) Languages of the profile - `languages.name` (string) Name of Language - `languages.proficiency` (string) Proficiency in Language - `skills` (array) Skills of the profile - `skills.label` (string) Label for Skill - `courses` (array) Courses of the profile - `courses.name` (string) Name of course - `courses.number` (string) Number in course - `honors` (array) Honors of the profile - `honors.description` (string) Description of Honors - `honors.issueDate` (string) Issue Date of Honors - `honors.issuer` (string) Issuer of Honors - `honors.title` (string) Title of Honors - `patents` (array) Patents of the profile - `patents.applicationNumber` (string) Application Number of Patent - `patents.description` (string) Description of Patent - `patents.filingDate` (string) Filing date of Patent - `patents.issueDate` (string) Issue date of Patent - `patents.issuer` (string) Issuer of Patent - `patents.title` (string) Title of Patent - `patents.url` (string) URL of Patent - `projects` (array) Projects of the profile - `projects.description` (string) Description of project - `projects.endMonthYear` (string) End Month Year of project - `projects.singleDate` (string) Description of project - `projects.startMonthYear` (string) Single date of project - `projects.title` (string) Start Month Year of project - `projects.url` (string) URL of project - `publications` (array) Publications of the profile - `publications.date` (string) Date of publication - `publications.description` (string) Description of publication - `publications.name` (string) Name of publication - `publications.publisher` (string) Publisher of publication - `publications.url` (string) URL of publication - `testScores` (array) Test scores of the profile - `testScores.date` (string) Date of Score - `testScores.description` (string) Description of Score - `testScores.name` (string) Name of Score - `testScores.score` (string) Score for Profile - `voluntaryExp` (array) Voluntary Experience of the profile - `voluntaryExp.cause` (string) Cause of Voluntary Experience - `voluntaryExp.companyName` (string) Company Name of Voluntary Experience - `voluntaryExp.description` (string) Cause of Voluntary Experience - `voluntaryExp.endMonthYear` (string) End Month Year of Voluntary Experience - `voluntaryExp.role` (string) Role of Voluntary Experience - `voluntaryExp.singleDate` (string) Single Date of Voluntary Experience - `voluntaryExp.startMonthYear` (string) Start Month Year of Voluntary Experience - `operatingHours` (object) Operating Hours of the profile - `operatingHours.regularHours` (array) Regular Hours of the Operating Hours - `operatingHours.regularHours.startDate` (integer) Start Date of the Time Period - `operatingHours.regularHours.endDate` (integer) End Date of the Time Period - `operatingHours.regularHours.openDay` (string) Open day of the Time Period - `operatingHours.regularHours.openTime` (string) Open time of the Time Period - `operatingHours.regularHours.closeDay` (string) Close day of the Time Period - `operatingHours.regularHours.closeTime` (string) Close time of the Time Period - `operatingHours.regularHours.closed` (boolean) is Closed for Time Period - `operatingHours.specialHours` (array) Special Hours of the Operating Hours - `customPropertiesMetadata` (array) Custom Property details - `customPropertiesMetadata.fieldName` (string) CustomField fieldName - `customPropertiesMetadata.type` (string) CustomField type - `customPropertiesMetadata.label` (string) CustomField label - `customPropertiesMetadata.clientCustomProperty` (boolean) Client CustomField - `customPropertiesMetadata.values` (array) Custom Field values - `restricted` (boolean) Profile Masked Flag ## Response 400: - `400` (unknown) Bad request ## Response 400 fields (application/json): - `data` (object) - `errors` (array) - `errors.id` (string, required) 24-character hex ObjectId - `errors.code` (integer, required) - `errors.message` (string, required) Dotted error key (e.g. account.not.found) - `metadata` (object) ## Response 401: - `401` (unknown) Missing or invalid authentication ## Response 401 fields (application/json): - `data` (object) - `errors` (array) - `errors.id` (string, required) 24-character hex ObjectId - `errors.code` (integer, required) - `errors.message` (string, required) Dotted error key (e.g. account.not.found) - `metadata` (object) ## Response 403: - `403` (unknown) Insufficient permissions ## Response 403 fields (application/json): - `data` (object) - `errors` (array) - `errors.id` (string, required) 24-character hex ObjectId - `errors.code` (integer, required) - `errors.message` (string, required) Dotted error key (e.g. account.not.found) - `metadata` (object) ## Response 404: - `404` (unknown) Resource not found ## Response 404 fields (application/json): - `data` (object) - `errors` (array) - `errors.id` (string, required) 24-character hex ObjectId - `errors.code` (integer, required) - `errors.message` (string, required) Dotted error key (e.g. account.not.found) - `metadata` (object)