Sync an engagement
curl --request PUT \
--url https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"engagementTypeId": "<string>",
"engagementType": {
"name": "<string>",
"externalId": "<string>"
},
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"opportunity": {
"externalId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"remoteCreatedAt": "<string>",
"lastActivityAt": "<string>",
"copyEngagementRelationships": true
},
"lead": {
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"contact": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
}
}
'import requests
url = "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements"
payload = {
"externalId": "<string>",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"engagementTypeId": "<string>",
"engagementType": {
"name": "<string>",
"externalId": "<string>"
},
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"opportunity": {
"externalId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"remoteCreatedAt": "<string>",
"lastActivityAt": "<string>",
"copyEngagementRelationships": True
},
"lead": {
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"contact": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
content: '<string>',
subject: '<string>',
startTime: '<string>',
startTimeLocalized: '<string>',
endTime: '<string>',
remoteCreatedAt: '<string>',
remoteUpdatedAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
engagementTypeId: '<string>',
engagementType: {name: '<string>', externalId: '<string>'},
account: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
engagementUsers: [
{
externalId: '<string>',
email: '<string>',
shareOfSale: 123,
name: '<string>',
deletedAt: '2023-11-07T05:31:56Z'
}
],
opportunity: {
externalId: '<string>',
name: '<string>',
amount: 123,
closedAt: '<string>',
remoteCreatedAt: '<string>',
lastActivityAt: '<string>',
copyEngagementRelationships: true
},
lead: {
externalId: '<string>',
firstName: '<string>',
lastName: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
contact: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
account: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
}
})
};
fetch('https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'content' => '<string>',
'subject' => '<string>',
'startTime' => '<string>',
'startTimeLocalized' => '<string>',
'endTime' => '<string>',
'remoteCreatedAt' => '<string>',
'remoteUpdatedAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'engagementTypeId' => '<string>',
'engagementType' => [
'name' => '<string>',
'externalId' => '<string>'
],
'account' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'engagementUsers' => [
[
'externalId' => '<string>',
'email' => '<string>',
'shareOfSale' => 123,
'name' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z'
]
],
'opportunity' => [
'externalId' => '<string>',
'name' => '<string>',
'amount' => 123,
'closedAt' => '<string>',
'remoteCreatedAt' => '<string>',
'lastActivityAt' => '<string>',
'copyEngagementRelationships' => true
],
'lead' => [
'externalId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'contact' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'account' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"externalId": "<string>",
"engagementType": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"direction": "<string>",
"subject": "<string>",
"content": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"recordingId": "<string>",
"opportunityId": "<string>",
"accountId": "<string>",
"account": null,
"engagementUsers": [
null
]
}
}Engagements
Sync an engagement
Sync an engagement
PUT
/
v1
/
integrations
/
sync
/
engagements
Sync an engagement
curl --request PUT \
--url https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"engagementTypeId": "<string>",
"engagementType": {
"name": "<string>",
"externalId": "<string>"
},
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"opportunity": {
"externalId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"remoteCreatedAt": "<string>",
"lastActivityAt": "<string>",
"copyEngagementRelationships": true
},
"lead": {
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"contact": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
},
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": [
"<string>"
],
"emailAddresses": [
"<string>"
],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": {
"externalId": "<string>"
},
"mergedToExternalId": "<string>",
"mergedFromExternalIds": [
"<string>"
]
}
}
'import requests
url = "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements"
payload = {
"externalId": "<string>",
"content": "<string>",
"subject": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"remoteCreatedAt": "<string>",
"remoteUpdatedAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"engagementTypeId": "<string>",
"engagementType": {
"name": "<string>",
"externalId": "<string>"
},
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"engagementUsers": [
{
"externalId": "<string>",
"email": "<string>",
"shareOfSale": 123,
"name": "<string>",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"opportunity": {
"externalId": "<string>",
"name": "<string>",
"amount": 123,
"closedAt": "<string>",
"remoteCreatedAt": "<string>",
"lastActivityAt": "<string>",
"copyEngagementRelationships": True
},
"lead": {
"externalId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"contact": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"account": {
"externalId": "<string>",
"name": "<string>",
"latitude": 123,
"longitude": 123,
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
},
"addresses": [
{
"country": "<string>",
"street": "<string>",
"city": "<string>",
"state": "<string>",
"zip": "<string>"
}
],
"phoneNumbers": ["<string>"],
"emailAddresses": ["<string>"],
"lastActivityAt": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"owner": { "externalId": "<string>" },
"mergedToExternalId": "<string>",
"mergedFromExternalIds": ["<string>"]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
content: '<string>',
subject: '<string>',
startTime: '<string>',
startTimeLocalized: '<string>',
endTime: '<string>',
remoteCreatedAt: '<string>',
remoteUpdatedAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
engagementTypeId: '<string>',
engagementType: {name: '<string>', externalId: '<string>'},
account: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
engagementUsers: [
{
externalId: '<string>',
email: '<string>',
shareOfSale: 123,
name: '<string>',
deletedAt: '2023-11-07T05:31:56Z'
}
],
opportunity: {
externalId: '<string>',
name: '<string>',
amount: 123,
closedAt: '<string>',
remoteCreatedAt: '<string>',
lastActivityAt: '<string>',
copyEngagementRelationships: true
},
lead: {
externalId: '<string>',
firstName: '<string>',
lastName: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
contact: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
account: {
externalId: '<string>',
name: '<string>',
latitude: 123,
longitude: 123,
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
},
addresses: [
{
country: '<string>',
street: '<string>',
city: '<string>',
state: '<string>',
zip: '<string>'
}
],
phoneNumbers: ['<string>'],
emailAddresses: ['<string>'],
lastActivityAt: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
owner: {externalId: '<string>'},
mergedToExternalId: '<string>',
mergedFromExternalIds: ['<string>']
}
})
};
fetch('https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'content' => '<string>',
'subject' => '<string>',
'startTime' => '<string>',
'startTimeLocalized' => '<string>',
'endTime' => '<string>',
'remoteCreatedAt' => '<string>',
'remoteUpdatedAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'engagementTypeId' => '<string>',
'engagementType' => [
'name' => '<string>',
'externalId' => '<string>'
],
'account' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'engagementUsers' => [
[
'externalId' => '<string>',
'email' => '<string>',
'shareOfSale' => 123,
'name' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z'
]
],
'opportunity' => [
'externalId' => '<string>',
'name' => '<string>',
'amount' => 123,
'closedAt' => '<string>',
'remoteCreatedAt' => '<string>',
'lastActivityAt' => '<string>',
'copyEngagementRelationships' => true
],
'lead' => [
'externalId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'contact' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'account' => [
'externalId' => '<string>',
'name' => '<string>',
'latitude' => 123,
'longitude' => 123,
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
],
'addresses' => [
[
'country' => '<string>',
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'zip' => '<string>'
]
],
'phoneNumbers' => [
'<string>'
],
'emailAddresses' => [
'<string>'
],
'lastActivityAt' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'owner' => [
'externalId' => '<string>'
],
'mergedToExternalId' => '<string>',
'mergedFromExternalIds' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://functions.siro.ai/api-externalApi/v1/integrations/sync/engagements")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"content\": \"<string>\",\n \"subject\": \"<string>\",\n \"startTime\": \"<string>\",\n \"startTimeLocalized\": \"<string>\",\n \"endTime\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"remoteUpdatedAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"engagementTypeId\": \"<string>\",\n \"engagementType\": {\n \"name\": \"<string>\",\n \"externalId\": \"<string>\"\n },\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"engagementUsers\": [\n {\n \"externalId\": \"<string>\",\n \"email\": \"<string>\",\n \"shareOfSale\": 123,\n \"name\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"opportunity\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"amount\": 123,\n \"closedAt\": \"<string>\",\n \"remoteCreatedAt\": \"<string>\",\n \"lastActivityAt\": \"<string>\",\n \"copyEngagementRelationships\": true\n },\n \"lead\": {\n \"externalId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"contact\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"account\": {\n \"externalId\": \"<string>\",\n \"name\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n },\n \"addresses\": [\n {\n \"country\": \"<string>\",\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"zip\": \"<string>\"\n }\n ],\n \"phoneNumbers\": [\n \"<string>\"\n ],\n \"emailAddresses\": [\n \"<string>\"\n ],\n \"lastActivityAt\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"owner\": {\n \"externalId\": \"<string>\"\n },\n \"mergedToExternalId\": \"<string>\",\n \"mergedFromExternalIds\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"externalId": "<string>",
"engagementType": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"organizationId": "<string>",
"direction": "<string>",
"subject": "<string>",
"content": "<string>",
"startTime": "<string>",
"startTimeLocalized": "<string>",
"endTime": "<string>",
"recordingId": "<string>",
"opportunityId": "<string>",
"accountId": "<string>",
"account": null,
"engagementUsers": [
null
]
}
}Authorizations
Organization integration token from Siro admin (Person icon → API Tokens). Send Authorization: Bearer . This is not the OAuth access token used with api.siro.ai user-scoped endpoints.
Body
application/json
The ID of the engagement in the external system
The direction of the engagement (INBOUND/OUTBOUND)
Available options:
INBOUND, OUTBOUND The content of the engagement
The subject of the engagement
start dateTime of the engagement in UTC.
Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes.
end dateTime of the engagement
external engagement creation datetime
external engagement update datetime
The datetime when this record was deleted in the external system
Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.
The type of this engagement
Show child attributes
Show child attributes
The associated account for this engagement. Note: supplying just an externalId will resolve to an already-synced account
Show child attributes
Show child attributes
The users associated with this engagement
Show child attributes
Show child attributes
The associated opportunity for this engagement. Note: supplying just an externalId will resolve to an already-synced opportunity
Show child attributes
Show child attributes
The associated lead for this engagement
Show child attributes
Show child attributes
The associated contact for this engagement. Note: supplying just an externalId will resolve to an already-synced contact
Show child attributes
Show child attributes
Response
200 - application/json
Sync an engagement
Show child attributes
Show child attributes
⌘I