API Reference
Actions Reference
- POSTCreate Record Companies
- POSTCreate Record Contacts
- POSTCreate Record Deals
- POSTCreate Record Engagements
- POSTCreate Record Any
- POSTUpdate Record Companies
- POSTUpdate Record Contacts
- POSTUpdate Record Deals
- POSTUpdate Record Engagements
- POSTUpdate Record Any
- POSTGet Records Companies
- POSTGet Records Contacts
- POSTGet Records Deals
- POSTGet Records Engagements
- POSTGet Records Any
- POSTGet Record By ID Companies
- POSTGet Record By ID Contacts
- POSTGet Record By ID Deals
- POSTGet Record By ID Engagements
- POSTGet Record By ID Any
- POSTSearch Records Companies
- POSTSearch Records Contacts
- POSTSearch Records Deals
- POSTSearch Records Engagements
- POSTSearch Records Any
- POSTDelete Record Companies
- POSTDelete Record Contacts
- POSTDelete Record Deals
- POSTDelete Record Engagements
- POSTDelete Record Any
- POSTGet Contacts By List ID
- POSTDescribe Action Schema
- POST
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_ENGAGEMENTS' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "HUBSPOT_CREATE_RECORD_ENGAGEMENTS",
"parameters": {
"engagementType": "NOTE",
"noteBody": "<string>",
"fromEmail": "<string>",
"fromFirstName": "<string>",
"fromLastName": "<string>",
"toEmail": "<string>",
"ccEmail": "<string>",
"bccEmail": "<string>",
"emailSubject": "<string>",
"emailText": "<string>",
"emailHtml": "<string>",
"toNumber": "<string>",
"fromNumber": "<string>",
"callNotes": "<string>",
"recordingUrl": "<string>",
"meetingTitle": "<string>",
"meetingNotes": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"taskSubject": "<string>",
"taskNotes": "<string>",
"taskStatus": "NOT_STARTED",
"contactId": "<string>",
"companyId": "<string>",
"ownerId": "<string>"
}
}
'Create Record Engagements
curl --request POST \
--url 'https://actionkit.useparagon.com/projects/{project_id}/actions/#HUBSPOT_CREATE_RECORD_ENGAGEMENTS' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "HUBSPOT_CREATE_RECORD_ENGAGEMENTS",
"parameters": {
"engagementType": "NOTE",
"noteBody": "<string>",
"fromEmail": "<string>",
"fromFirstName": "<string>",
"fromLastName": "<string>",
"toEmail": "<string>",
"ccEmail": "<string>",
"bccEmail": "<string>",
"emailSubject": "<string>",
"emailText": "<string>",
"emailHtml": "<string>",
"toNumber": "<string>",
"fromNumber": "<string>",
"callNotes": "<string>",
"recordingUrl": "<string>",
"meetingTitle": "<string>",
"meetingNotes": "<string>",
"startTime": "<string>",
"endTime": "<string>",
"taskSubject": "<string>",
"taskNotes": "<string>",
"taskStatus": "NOT_STARTED",
"contactId": "<string>",
"companyId": "<string>",
"ownerId": "<string>"
}
}
'Authorizations
Your Paragon User Token (JWT), which you can generate using your project's signing keys.
Path Parameters
Your Paragon Project ID. You can copy your Project ID from your dashboard URL or by clicking Copy Project ID under the Environment switcher.
Body
Show child attributes
Show child attributes
Type
NOTE, EMAIL, CALL, MEETING, TASK Note : The body of the note. This field appears only when 'engagementType' = 'NOTE')
From email : Email address of the sender. This field appears only when 'engagementType' = 'EMAIL')
From first name : First name of the sender. This field appears only when 'engagementType' = 'EMAIL')
From last name : Last name of the sender. This field appears only when 'engagementType' = 'EMAIL')
To email : Email address of the recipient. This field appears only when 'engagementType' = 'EMAIL')
CC emails : Array of email addresses for anyone cc’d on the email. This field appears only when 'engagementType' = 'EMAIL')
BCC emails : Array of email addresses for anyone bcc’d on the email. This field appears only when 'engagementType' = 'EMAIL')
Subject : Subject of the email. This field appears only when 'engagementType' = 'EMAIL')
Text : Body of the text-only email. This field appears only when 'engagementType' = 'EMAIL')
HTML : Body of the HTML email. This field appears only when 'engagementType' = 'EMAIL')
To number : The phone number that was called. This field appears only when 'engagementType' = 'CALL')
From number : The phone number that was used as the from number. This field appears only when 'engagementType' = 'CALL')
Body : Details or notes of the call. This field appears only when 'engagementType' = 'CALL')
Recording URL : The URL of the call recording. This field appears only when 'engagementType' = 'CALL')
Title : Title or subject of the meeting. This field appears only when 'engagementType' = 'MEETING')
Body : Details or notes of the meeting. This field appears only when 'engagementType' = 'MEETING')
Start time : Start time of the meeting (ISO or Unix timestamp). (example: "2014-04-25T16:15:47-04:00") This field appears only when 'engagementType' = 'MEETING')
End time : End time of the meeting (ISO or Unix timestamp). (example: "2014-04-25T16:15:47-04:00") This field appears only when 'engagementType' = 'MEETING')
Subject : Title or subject of the task. This field appears only when 'engagementType' = 'TASK')
Body : Details or notes of the task. This field appears only when 'engagementType' = 'TASK')
Status This field appears only when 'engagementType' = 'TASK')
NOT_STARTED, COMPLETED, IN_PROGRESS, WAITING, DEFERRED Contact ID : ID of the Contact the Engagement is related to.
Company ID : ID of the Company the Engagement is related to.
Owner ID : ID of the owner of the Engagement.
Response
Success
Was this page helpful?