Skip to content

Adds new profile for the specified profile name​

POST
/profile

Authorizations​

Bearer

Please create a SessionId using the access-token endpoint and use it in an authorization header.

TypeHTTP (bearer)
Example'Authorization: BEARER <YOUR_TOKEN_HERE>'

Request Body​

application/json
object
object[]
object
One of
object[]
object[]
object[]
object[]
object[]
object[]
object
object
object
object
object

Responses​

application/json
JSON
{
"AggregateCount": 0,
"MetaData": null,
"HistorySaveOptions": 0,
"Description": "string",
"CreateType": "string",
"TokenId": "string",
"ProfileId": "string",
"NotifyList": [
{
"EmailAddress": null
}
],
"RecordType": null,
"RecordId": "string",
"JobId": "string",
"SegmentedSeId": "string",
"SendoutId": "string",
"KnockoutPlan": "string",
"SuccessPlan": "string",
"HTMLCustomTemplate": "string",
"HTMLCustomTemplateInternal": "string",
"HTMLCustomTemplatePrint": "string",
"AfterSubmitMessage": "string",
"ProfileDate": "string",
"Questions": [
{
"QuestionType": 0,
"QuestionText": "string",
"Required": "string",
"GUID": "string",
"Answer": "string",
"AnswerList": [
{
"AnswerValue": "string",
"AnswerDescription": "string",
"AnswerRollup": "string",
"AnswerDisplaySection": "string"
}
],
"Encrypt": true,
"Elliptic": true,
"KnockoutAnswer": "string",
"FormLetter": "string",
"LinkedField": "string",
"HTMLCustomTemplate": "string",
"Section": "string",
"Logic": "string",
"Placeholder": "string",
"MaxLength": 0,
"lastBankLookup": "string"
}
],
"Version": "string",
"NotFound": true,
"TemplateNotFound": true,
"FormLetterN": "string",
"FormLetterC": "string",
"FormLetterP": "string",
"FormLetterNR": "string",
"FormLetterPR": "string",
"CampaignRecipientId": "string",
"NotifyOnAdd": true,
"NotifyOnEdit": true,
"NotifyOnAddR": true,
"NotifyOnEditR": true,
"NotifyUser": true,
"RemoveAnnotations": true,
"History_Work_History": [
{
"AggregateCount": 0,
"MetaData": null,
"Work_Id": 0,
"Candidate_Id": 0,
"Company_Id": 0,
"Company_Name": "string",
"Job_Title": "string",
"Current_Employer": true,
"Duties": "string",
"Begin_Date": "string",
"End_Date": "string",
"Business_Type": "string",
"Address": "string",
"City": "string",
"State": "string",
"Postal_Code": "string",
"Country": "string",
"Company_Phone": "string",
"Supervisor_Name": "string",
"Supervisor_Title": "string",
"Supervisor_Phone": "string",
"Supervisor_Email": "string",
"Years_Exp": 0,
"Rate_Of_Pay_Start": {
"CurrencyCode": null,
"Value": 0
},
"Rate_Of_Pay_End": {
"CurrencyCode": null,
"Value": 0
},
"Pay_Freq": "string",
"Allow_Contact": "string",
"Hours_Per_Week": 0,
"Hours_Per_Day": 0,
"Reason_For_Leaving": "string",
"Notes": "string",
"Starting_Job_Title": "string",
"Supervisor_Phone_Intl": "string",
"Currency_Intl": "string"
}
],
"History_Military": [
{
"AggregateCount": 0,
"MetaData": null,
"Military_Id": 0,
"Candidate_Id": 0,
"Company_Id": 0,
"Branch": "string",
"Service_ID": "string",
"Location": "string",
"Start_Rank": "string",
"Discharge_Rank": "string",
"Current_Rank": "string",
"Begin_Date": "string",
"End_Date": "string",
"Address": "string",
"City": "string",
"State": "string",
"Postal_Code": "string",
"Country": "string",
"Honors": "string",
"Disciplinary_Action": "string",
"Expertise": "string",
"Comments": "string",
"Date_Entered": "string"
}
],
"History_Licensing": [
{
"AggregateCount": 0,
"MetaData": null,
"License_Id": 0,
"Candidate_Id": 0,
"Parent_Id": 0,
"License_Name": "string",
"License_Agency": "string",
"License_Number": "string",
"State_Issued": "string",
"Begin_Date": "string",
"Expiration_Date": "string",
"Comments": "string",
"Date_Entered": "string",
"Embedded_Images": "string"
}
],
"History_Education": [
{
"AggregateCount": 0,
"MetaData": null,
"Education_Id": 0,
"Candidate_Id": 0,
"Company_Id": 0,
"School": "string",
"School_Type": "string",
"Degree_Type": "string",
"Begin_Date": "string",
"End_Date": "string",
"Given_Name": "string",
"Family_Name": "string",
"Address": "string",
"City": "string",
"State": "string",
"Postal_Code": "string",
"Country": "string",
"Phone": "string",
"Fax": "string",
"Grades": "string",
"Credits": "string",
"GPA": "string",
"Major": "string",
"Minor": "string",
"Major_2": "string",
"Minor_2": "string",
"Comments": "string",
"Date_Entered": "string"
}
],
"History_References": [
{
"AggregateCount": 0,
"MetaData": null,
"Reference_Id": 0,
"Candidate_Id": 0,
"Record_Id": 0,
"First_Name": "string",
"Last_Name": "string",
"Phone": "string",
"Fax": "string",
"Email": "string",
"Title": "string",
"Company": "string",
"Relationship": "string",
"Address": "string",
"City": "string",
"State": "string",
"Postal_Code": "string",
"Country": "string",
"Years_Known": 0,
"Notes": "string",
"Date_Entered": "string"
}
],
"Work_History_Layout": {
"additionalProperties": {
}
},
"Military_Layout": {
"additionalProperties": {
}
},
"Licensing_Layout": {
"additionalProperties": {
}
},
"Education_Layout": {
"additionalProperties": {
}
},
"References_Layout": {
"additionalProperties": {
}
},
"EllipticPublicKey": "string"
}

Playground​

Authorization
Body

Samples​