SalesDesk RestApi (0.1)

Download OpenAPI specification:

E-mail: support@salesdesk.app Terms of Service

The Rest API for accessing SalesDesk services

Returns the authenticated user's list of tenants to log in to

Responses

Response samples

200
default

Content type

application/json

[{"tenant": "string",
"accountName": "string",
"accountLogoUrl": "string",
"isInternalUser": true,
"unreadNotificationCount": 0
}
]

Returns the Claims for the authenticated User

Responses

Response samples

200
default

Content type

application/json

[{"type": "http://salesdesk.app/claims/tenant",
"value": "string"
}
]

Returns the Credentials to connect to Chime

Responses

Response samples

200
default

Content type

application/json

{"appInstanceUserArn": "string",
"userId": "string",
"credentials": {"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string",
"expiration": 9007199254740991
},
"displayName": "string"
}

Returns readonly Credentials to connect to Chime channel

path Parameters

channelId

string (String) [ 1 .. 10000 ] characters

Responses

Response samples

200
default

Content type

application/json

{"appInstanceUserArn": "string",
"userId": "string",
"credentials": {"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string",
"expiration": 9007199254740991
},
"displayName": "string"
}

Create Role

Request Body schema: application/json
required

name required	string (String) [ 1 .. 100 ] characters
required	Array of objects (Claim)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
]
}

Response samples

201
400
409
default

Content type

application/json

{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
],
"id": 0,
"editable": true,
"deleted": true,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Roles

Responses

Response samples

200
400
default

Content type

application/json

[{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
],
"id": 0,
"editable": true,
"deleted": true,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Get Role

path Parameters

roleId

string (Role Id) ^[0-9]*$

Unique system identifier for Roles

Responses

Response samples

200
400
404
409
default

Content type

application/json

{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
],
"id": 0,
"editable": true,
"deleted": true,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Patch Role

path Parameters

roleId

string (Role Id) ^[0-9]*$

Unique system identifier for Roles

Request Body schema: application/json
required

non-empty

name	string (String) [ 1 .. 100 ] characters
	Array of objects (Claim)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
]
}

Response samples

200
400
409
default

Content type

application/json

{"name": "string",
"claims": [{"type": "http://salesdesk.app/claims/role",
"value": "string"
}
],
"id": 0,
"editable": true,
"deleted": true,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Role

path Parameters

roleId

string (Role Id) ^[0-9]*$

Unique system identifier for Roles

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Resend Invitation

path Parameters

username

string (Username) [ 1 .. 10000 ] characters

Unique system identifier for Users

Request Body schema: application/json
required

welcomeMessage

string

Responses

Request samples

Payload

Content type

application/json

{"welcomeMessage": "string"
}

Response samples

200
default

Content type

application/json

{ }

Get timestamp when user was last active

path Parameters

username

string (Username) [ 1 .. 10000 ] characters

Unique system identifier for Users

Responses

Response samples

200
default

Content type

application/json

{"lastActive": 0
}

Post Object Association

Request Body schema: application/json
required

name required	string
required	object
required	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"object1": {"id": 0,
"label": "string",
"multiplicity": "MANY",
"child": true
},
"object2": {"id": 0,
"label": "string",
"multiplicity": "MANY",
"child": true
}
}

Response samples

201
default

Content type

application/json

{ }

Patch Object Association

path Parameters

objectAssociationId

string (Association Definition ID) ^[0-9]*$

ID of association definition to delete

Request Body schema: application/json
required

name	string
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"object1": {"label": "string"
},
"object2": {"label": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Delete Association Definition

path Parameters

objectAssociationId

string (Association Definition ID) ^[0-9]*$

ID of association definition to delete

Responses

Response samples

204
default

Content type

application/json

{ }

Get Comments

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Post Comment

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Request Body schema: application/json
required

message required	string (Tiptap JSON String) [ 1 .. 10000 ] characters Tiptap formatted JSON string
rootCommentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"rootCommentId": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Comments for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Post Comment for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Request Body schema: application/json
required

message required	string (Tiptap JSON String) [ 1 .. 10000 ] characters Tiptap formatted JSON string
rootCommentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"rootCommentId": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Comment

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Comment

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put Comment

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Request Body schema: application/json
required

message

required

string (Tiptap JSON String) [ 1 .. 10000 ] characters

Tiptap formatted JSON string

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
default

Content type

application/json

{ }

Resolve Comment

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Get Comment in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"rootCommentId": "string",
"message": "string",
"resolvedAt": 0,
"resolvedBy": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"workspaceId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Comment in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put Comment in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Resolve Comment in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
commentId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put my reaction to a comment

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Delete my reaction to a comment

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Put my reaction to a comment for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Delete my reaction to a comment for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
commentId	string (Comment Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get Notes

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Post Note

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Request Body schema: application/json
required

message

required

string (Tiptap JSON String) [ 1 .. 10000 ] characters

Tiptap formatted JSON string

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Notes for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Post Note for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Request Body schema: application/json
required

message

required

string (Tiptap JSON String) [ 1 .. 10000 ] characters

Tiptap formatted JSON string

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Note

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Note

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put Note

path Parameters

recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Get Note in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"message": "string",
"workspaceId": 0,
"reactions": [{"emoji": "string",
"createdAt": 0,
"userRecordIds": [0
]
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Note in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put Note in workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
noteId	string (Ulid) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier

Responses

Response samples

200
default

Content type

application/json

{ }

Put my reaction to a note

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Delete my reaction to a note

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Put my reaction to a note for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Delete my reaction to a note for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
noteId	string (Note Id) ^[0-9a-zA-Z]{26}$ Universally Unique Lexicographically Sortable Identifier
emoji	string <= 20 characters \p{Extended_Pictographic} A single emoji

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get Charts data by IDs

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time

Responses

Response samples

200
default

Content type

application/json

[{"visualization": "metric",
"value": 0,
"aggregation": "sum"
}
]

Get preview of the chart's data

Request Body schema: application/json
required

objectId required	integer (Object Id) >= 0 The object that this record has been created for. Not editable
name required	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
required	Array of objects (SDRecord Field Value)
isTemplate	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
}

Response samples

201
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Create Record Association

Responses

Response samples

204
400
default

Content type

application/json

{ }

Delete Record Association

Responses

Response samples

204
default

Content type

application/json

{ }

Create Record Association for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

204
400
default

Content type

application/json

{ }

Delete Record Association for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

204
default

Content type

application/json

{ }

Create Record Associations

Request Body schema: application/json
required

Array ([ 1 .. 30 ] items)

record1Id required	integer (Record 1 ID) >= 0 First record to be associated
record2Id required	integer (Record 2 ID) >= 0 Second record to be associated
objectAssociationId required	integer (Association definition ID) >= 0 Type of association

Responses

Request samples

Payload

Content type

application/json

[{"record1Id": 0,
"record2Id": 0,
"objectAssociationId": 0
}
]

Response samples

201
400
default

Content type

application/json

{ }

Create Record Associations for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array ([ 1 .. 30 ] items)

record1Id required	integer (Record 1 ID) >= 0 First record to be associated
record2Id required	integer (Record 2 ID) >= 0 Second record to be associated
objectAssociationId required	integer (Association definition ID) >= 0 Type of association

Responses

Request samples

Payload

Content type

application/json

[{"record1Id": 0,
"record2Id": 0,
"objectAssociationId": 0
}
]

Response samples

201
400
default

Content type

application/json

{ }

Convert lead

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

One of

required	object (Contact) Contact to which lead will be converted
linkContactIds	Array of integers (Link Contact IDs) [ items >= 0 ] IDs of contacts which will be linked to created opportunity
required	object (Opportunity) Opportunity to create during lead conversion
required	object (Account) Optional account to create and link created opportunity to
existingAccountId	integer (Existing Account ID) >= 0 Optional ID of account to which created opportunity will be linked

Responses

Request samples

Payload

Content type

application/json

{"contact": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
},
"linkContactIds": [0
],
"opportunity": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
},
"account": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
},
"existingAccountId": 0
}

Response samples

200
400
404
409
default

Content type

application/json

{"contactId": 0,
"opportunityId": 0,
"accountId": 0
}

Create Pdf Asset from Doc

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

nameValue	string (String) [ 1 .. 10000 ] characters Override for the PDF Asset name Field
mediaTypeValue	any (SDRecord Field Value Value) Override for the PDF Asset mediaType Field
tagValue	string (String) [ 1 .. 10000 ] characters Override for the PDF Asset tag Field

Responses

Request samples

Payload

Content type

application/json

{"nameValue": "string",
"mediaTypeValue": null,
"tagValue": "string"
}

Response samples

201
404
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Create Pdf Asset from Doc for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Request Body schema: application/json
required

nameValue	string (String) [ 1 .. 10000 ] characters Override for the PDF Asset name Field
mediaTypeValue	any (SDRecord Field Value Value) Override for the PDF Asset mediaType Field
tagValue	string (String) [ 1 .. 10000 ] characters Override for the PDF Asset tag Field

Responses

Request samples

Payload

Content type

application/json

{"nameValue": "string",
"mediaTypeValue": null,
"tagValue": "string"
}

Response samples

201
404
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get live participants in a meeting

path Parameters

meetingRecordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

["string"
]

Get User records for the given participant identities

query Parameters

identities

string (Comma-delimited Participant Identities) ^([^ ,]+(,[^ ,]+)*)*$

Comma-delimited Participant Identities

Responses

Response samples

200
default

Content type

application/json

[{"identity": "string",
"userRecord": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
}
]

Get roomId and access token for conference

path Parameters

meetingRecordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

{"roomId": "string",
"token": "string"
}

Update recording status

path Parameters

meetingRecordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

{ }

Get chat messages

path Parameters

meetingRecordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

[{"message": "string",
"createdAt": 0,
"createdBy": 0
}
]

Post Chat Message

path Parameters

meetingRecordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

message

required

string (Chat Message)

Content of message

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

201
default

Content type

application/json

{ }

Return Pdf Signed URL for provided HTML

Request Body schema: application/json
required

htmlContent required	string (Html Content for PDF) Html Content for PDF
pdfFileName required	string (Pdf File Name) Pdf File Name

Responses

Request samples

Payload

Content type

application/json

{"htmlContent": "string",
"pdfFileName": "string"
}

Response samples

200
default

Content type

application/json

{"signedUrl": "string"
}

Get information about file

path Parameters

fileId

string (Id Path Parameter) ^[0-9]*$

Unique system identifier

Responses

Response samples

200
default

Content type

application/json

{"name": "string",
"type": "UserAsset",
"public": true,
"fileId": 0,
"recordId": 0,
"fieldName": "string",
"createdAt": 0,
"createdBy": 0,
"sizeInBytes": 0,
"mimeType": "string",
"signedUrl": "string",
"posterSignedUrl": "string",
"transcriptSignedUrl": "string",
"sentimentAnalysisSignedUrl": "string",
"summary": "string",
"coachingAdvice": {"activeListening": {"rating": "string",
"explanation": "string"
},
"questioningTechniques": {"rating": "string",
"explanation": "string"
},
"handlingObjections": {"rating": "string",
"explanation": "string"
},
"valuePropositionCommunication": {"rating": "string",
"explanation": "string"
},
"closingTechniques": {"rating": "string",
"explanation": "string"
}
},
"topTopics": ["string"
],
"minutesRecordId": 0,
"videoStatus": "GENERATING_FILE"
}

Create a file and receive a signed URL for uploading content

Request Body schema: application/json
required

name required	string (File Name) Name of file
type required	string (File Type) Enum: "UserAsset" "Import" The type of file
public	boolean (Public) Whether anybody can access this file

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"type": "UserAsset",
"public": true
}

Response samples

200
default

Content type

application/json

{"signedUrl": "string",
"fileId": 0
}

Configure MFA

Request Body schema: application/json
required

phoneNumber

required

string (Phone Number)

Phone number used for MFA

Responses

Request samples

Payload

Content type

application/json

{"phoneNumber": "string"
}

Response samples

200
default

Content type

application/json

{ }

Get My App State

Responses

Response samples

200

Content type

application/json

{ }

Update My App State

Request Body schema: application/json
required

object (User App State Patch Request)

Patches for a user's app state

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201
default

Content type

application/json

{ }

Get My Preferences

Responses

Response samples

200
default

Content type

application/json

{"notification_channel_enabled_email": true,
"notification_channel_enabled_browser": true,
"pinned_charts": [{"chartId": -9007199254740991,
"reportId": -9007199254740991
}
]
}

Update My Preferences

Request Body schema: application/json
required

notification_channel_enabled_email	boolean (Boolean)
notification_channel_enabled_browser	boolean (Boolean)
	Array of objects (Pinned Chart)

Responses

Request samples

Payload

Content type

application/json

{"notification_channel_enabled_email": true,
"notification_channel_enabled_browser": true,
"pinned_charts": [{"chartId": -9007199254740991,
"reportId": -9007199254740991
}
]
}

Response samples

201
default

Content type

application/json

{ }

Delete My Preferences

Responses

Response samples

201
default

Content type

application/json

{ }

Get My Bookmarks

Responses

Response samples

200
default

Content type

application/json

[{"id": 0,
"name": "string",
"value": "string",
"objectId": 0,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Create Bookmark

Request Body schema: application/json
required

name required	string (Bookmark Name) [ 1 .. 10000 ] characters Name of bookmark
objectId required	integer (Bookmark object ID) >= 0 Object ID of bookmark
value required	string (Bookmark value) [ 1 .. 10000 ] characters Value of bookmark

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"objectId": 0,
"value": "string"
}

Response samples

201
default

Content type

application/json

{"id": 0,
"name": "string",
"value": "string",
"objectId": 0,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get My Bookmark

path Parameters

bookmarkId

string (Bookmark ID) [ 1 .. 10000 ] characters

Unique ID for bookmark

Responses

Response samples

200
default

Content type

application/json

{"id": 0,
"name": "string",
"value": "string",
"objectId": 0,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Put Bookmark

path Parameters

bookmarkId

string (Bookmark ID) [ 1 .. 10000 ] characters

Unique ID for bookmark

Request Body schema: application/json
required

name required	string (Bookmark Name) [ 1 .. 10000 ] characters Name of bookmark
objectId required	integer (Bookmark object ID) >= 0 Object ID of bookmark
value required	string (Bookmark value) [ 1 .. 10000 ] characters Value of bookmark

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"objectId": 0,
"value": "string"
}

Response samples

200
default

Content type

application/json

{ }

Delete Bookmark

path Parameters

bookmarkId

string (Bookmark ID) [ 1 .. 10000 ] characters

Unique ID for bookmark

Responses

Response samples

204
default

Content type

application/json

{ }

Get Favorites

Responses

Response samples

200
default

Content type

application/json

[0
]

Delete Favorites

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Put Favorite

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

204
default

Content type

application/json

{ }

Delete Favorite

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

204
409
default

Content type

application/json

{ }

Put Favorite for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Responses

Response samples

204
default

Content type

application/json

{ }

Delete Favorite for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Responses

Response samples

204
409
default

Content type

application/json

{ }

Put Favorites

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array ([ 0 .. 40 ] items)

integer (Record Id) >= 0

Unique identifier for the record

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

204
default

Content type

application/json

{ }

Put Favorites for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array ([ 0 .. 40 ] items)

integer (Record Id) >= 0

Unique identifier for the record

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

204
default

Content type

application/json

{ }

Get Objects

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time
deleted	string (SDObject Deleted) Enum: "true" "false" Indicates if the SDObject has been deleted. Defaults to false.

Responses

Response samples

200
400
404
default

Content type

application/json

[{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
],
"name": "string",
"id": 0,
"baseObjectId": 0,
"creationType": "System",
"version": 0,
"deleted": true,
"editable": true,
"supportsUserCreation": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Create Object

Request Body schema: application/json
required

singularLabel required	string (SDObject Singular Label) [ 1 .. 10000 ] characters The name displayed for the Object. Editable for Custom objects and editable System objects
pluralLabel required	string (SDObject Plural Label) [ 1 .. 10000 ] characters The plural name for the Object
required	object (SDObject Description) Tiptap JSON formatted rich text. Editable for Custom objects and editable System objects
color required	string (SDObject Color) ^#([a-fA-F0-9]{6}\|[a-fA-F0-9]{3})$ RGB Color as Hexadecimal. Used for highlighting. Editable for Custom objects and editable System objects
icon required	string (SDObject Icon) ^fa-[a-zA-Z0-9-]+\|ph-[a-zA-Z-]+$ Fontawesome/Phosphor Icon with format '[fa\|ph]-*'. Editable for Custom objects and editable System objects
defaultView required	string (SDObject default view) Enum: "TABLE" "CARD" "LIST" "KANBAN" "CALENDAR" An default view value for displaying records of this type
isTemplatable	boolean (Boolean)
required	Array of objects (SDObject Field Create Request)
name required	string (SDObject Name) [ 1 .. 10000 ] characters The name of the SDObject. Not editable

Responses

Request samples

Payload

Content type

application/json

{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
],
"name": "string"
}

Response samples

201
400
409
default

Content type

application/json

{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
],
"name": "string",
"id": 0,
"baseObjectId": 0,
"creationType": "System",
"version": 0,
"deleted": true,
"editable": true,
"supportsUserCreation": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Object

path Parameters

objectId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

200
400
404
409
default

Content type

application/json

{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
],
"name": "string",
"id": 0,
"baseObjectId": 0,
"creationType": "System",
"version": 0,
"deleted": true,
"editable": true,
"supportsUserCreation": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Object

path Parameters

objectId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Updated Object

path Parameters

objectId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects
version	string (SDObject Version) ^[1-9][0-9]*$ Used to identify dirty writes

Request Body schema: application/json
required

singularLabel required	string (SDObject Singular Label) [ 1 .. 10000 ] characters The name displayed for the Object. Editable for Custom objects and editable System objects
pluralLabel required	string (SDObject Plural Label) [ 1 .. 10000 ] characters The plural name for the Object
required	object (SDObject Description) Tiptap JSON formatted rich text. Editable for Custom objects and editable System objects
color required	string (SDObject Color) ^#([a-fA-F0-9]{6}\|[a-fA-F0-9]{3})$ RGB Color as Hexadecimal. Used for highlighting. Editable for Custom objects and editable System objects
icon required	string (SDObject Icon) ^fa-[a-zA-Z0-9-]+\|ph-[a-zA-Z-]+$ Fontawesome/Phosphor Icon with format '[fa\|ph]-*'. Editable for Custom objects and editable System objects
defaultView required	string (SDObject default view) Enum: "TABLE" "CARD" "LIST" "KANBAN" "CALENDAR" An default view value for displaying records of this type
isTemplatable	boolean (Boolean)
required	Array of SDObject Field Create Request (object) or SDObject Field (object)

Responses

Request samples

Payload

Content type

application/json

{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
]
}

Response samples

200
400
409
default

Content type

application/json

{"singularLabel": "string",
"pluralLabel": "string",
"description": { },
"color": "string",
"icon": "string",
"defaultView": "TABLE",
"isTemplatable": true,
"fields": [{"type": "string",
"componentType": "checkbox",
"creationType": "System",
"name": "string",
"singularLabel": "string",
"pluralLabel": "string",
"description": "string",
"icon": "string",
"toolTip": "string",
"multiplicity": 0,
"formatDescription": "string",
"editable": true,
"hidden": true,
"required": true,
"unique": "None",
"defaultValue": null,
"maxLength": 9007199254740991,
"templateType": "Required",
"objectId": 0,
"supportsPast": true,
"dateOnly": true,
"currency": "USD",
"options": [{"value": "string",
"label": "string",
"color": "string",
"icon": "string",
"hidden": true,
"creationType": "System"
}
]
}
],
"name": "string",
"id": 0,
"baseObjectId": 0,
"creationType": "System",
"version": 0,
"deleted": true,
"editable": true,
"supportsUserCreation": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get Object Associations

path Parameters

objectId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

[{"name": "string",
"object1": {"id": 0,
"label": "string",
"multiplicity": "MANY",
"child": true
},
"object2": {"id": 0,
"label": "string",
"multiplicity": "MANY",
"child": true
},
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0,
"id": 0,
"type": "SYSTEM",
"originObject": "OBJECT_ONE"
}
]

Create Record for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

objectId required	integer (Object Id) >= 0 The object that this record has been created for. Not editable
name required	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
required	Array of objects (SDRecord Field Value)
isTemplate	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
}

Response samples

201
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Records for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,19}$ Only 20 ids can be requested at a time

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get Records

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time

Responses

Response samples

200
400
404
409
default

Content type

application/json

[{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Create Record

Request Body schema: application/json
required

objectId required	integer (Object Id) >= 0 The object that this record has been created for. Not editable
name required	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
required	Array of objects (SDRecord Field Value)
isTemplate	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
}

Response samples

201
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Records

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,19}$ Only 20 ids can be requested at a time

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get Record

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
400
404
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Patch Record

Request Body schema: application/json
required

non-empty

name	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
ownedBy	integer or null (SDRecord Owner) >= 0 The owner of this SDRecord. Not editable
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"ownedBy": 0,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}

Response samples

200
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Record

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Patch Record for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

non-empty

name	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
ownedBy	integer or null (SDRecord Owner) >= 0 The owner of this SDRecord. Not editable
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"ownedBy": 0,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}

Response samples

200
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete Record for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Duplicate a record

Request Body schema: application/json
required

asTemplate required	boolean
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

{"asTemplate": true,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}

Response samples

201
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Duplicate a record for workspace

Request Body schema: application/json
required

asTemplate required	boolean
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

{"asTemplate": true,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}

Response samples

201
400
409
default

Content type

application/json

{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Create Records

Request Body schema: application/json
required

Array ([ 1 .. 20 ] items)

objectId required	integer (Object Id) >= 0 The object that this record has been created for. Not editable
name required	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
required	Array of objects (SDRecord Field Value)
isTemplate	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

[{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
}
]

Response samples

201
400
409
default

Content type

application/json

[{"status": "Succeeded",
"record": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
}
]

Patch Records

Request Body schema: application/json
required

Array ([ 1 .. 20 ] items)

id required	integer (Record Id) >= 0 Unique identifier for the record
name	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
ownedBy	integer or null (SDRecord Owner) >= 0 The owner of this SDRecord. Not editable
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"name": "string",
"ownedBy": 0,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}
]

Response samples

200
400
default

Content type

application/json

[{"status": "Succeeded",
"record": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
}
]

Create Records for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array ([ 1 .. 20 ] items)

objectId required	integer (Object Id) >= 0 The object that this record has been created for. Not editable
name required	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
required	Array of objects (SDRecord Field Value)
isTemplate	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

[{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true
}
]

Response samples

201
400
409
default

Content type

application/json

[{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Patch Records for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array ([ 1 .. 20 ] items)

id required	integer (Record Id) >= 0 Unique identifier for the record
name	string (SDRecord Name) [ 1 .. 10000 ] characters The name of the SDRecord. Not editable
ownedBy	integer or null (SDRecord Owner) >= 0 The owner of this SDRecord. Not editable
	Array of objects (SDRecord Field Value)

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"name": "string",
"ownedBy": 0,
"fieldValues": [{"fieldName": "string",
"value": null
}
]
}
]

Response samples

200
400
default

Content type

application/json

[{"status": "Succeeded",
"record": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
}
]

Get the list of User SDRecords that are authorized to view the SDRecord

path Parameters

recordId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

[{"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Search Records

Responses

Response samples

200
400
default

Content type

application/json

{"hitCount": 0,
"innerHits": {"notes": [{"id": "string",
"createdBy": 0,
"message": "string"
}
]
},
"hits": [{"source": {"objectId": 0,
"name": "string",
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
},
"highlight": [{"matchType": "TRANSCRIPT",
"fragments": ["string"
]
}
]
}
],
"searchAfter": ["string"
],
"aggregations": [{"name": "string",
"value": 0
}
]
}

Search associations

Request Body schema: application/json
required

recordIds

required

Array of integers (Record IDs) [ items >= 0 ]

Responses

Request samples

Payload

Content type

application/json

{"recordIds": [0
]
}

Response samples

200
400
default

Content type

application/json

{"hitCount": 0,
"innerHits": {"notes": [{"id": "string",
"createdBy": 0,
"message": "string"
}
]
},
"hits": [{"source": {"objectId": 0,
"name": "string",
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
},
"highlight": [{"matchType": "TRANSCRIPT",
"fragments": ["string"
]
}
]
}
],
"searchAfter": ["string"
],
"aggregations": [{"name": "string",
"value": 0
}
]
}

Search associations for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

recordIds

required

Array of integers (Record IDs) [ items >= 0 ]

Responses

Request samples

Payload

Content type

application/json

{"recordIds": [0
]
}

Response samples

200
400
default

Content type

application/json

{"hitCount": 0,
"innerHits": {"notes": [{"id": "string",
"createdBy": 0,
"message": "string"
}
]
},
"hits": [{"source": {"objectId": 0,
"name": "string",
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
},
"highlight": [{"matchType": "TRANSCRIPT",
"fragments": ["string"
]
}
]
}
],
"searchAfter": ["string"
],
"aggregations": [{"name": "string",
"value": 0
}
]
}

Share a workspace record

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Responses

Response samples

204
default

Content type

application/json

{ }

Stop sharing a workspace record

path Parameters

recordId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords

Responses

Response samples

204
default

Content type

application/json

{ }

Share workspace records

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

Array (non-empty)

integer (Record Id) >= 0

Unique identifier for the record

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

204
default

Content type

application/json

{ }

Get Watches

Responses

Response samples

200
default

Content type

application/json

[0
]

Delete Watches

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Delete Watches for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

query Parameters

ids	string (List of ids) ^[0-9](,[0-9]){0,39}$ Only 40 ids can be requested at a time

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get Watch

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

default

Content type

application/json

{"errorCode": "Forbidden",
"description": "string"
}

Add Watch

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

{ }

Delete Watch

path Parameters

recordId

string (SDObject Id) ^[0-9]*$

Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

{ }

Add Watch for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

{ }

Delete Watch for workspace

path Parameters

workspaceId	string (SDRecord Id) ^[0-9]*$ Unique system identifier for SDRecords
recordId	string (SDObject Id) ^[0-9]*$ Unique system identifier for SDObjects

Responses

Response samples

200
default

Content type

application/json

{ }

Put Watches

Request Body schema: application/json
required

Array ([ 0 .. 40 ] items)

integer (Record Id) >= 0

Unique identifier for the record

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

204
default

Content type

application/json

{ }

Put Watches For Workspace

Request Body schema: application/json
required

Array ([ 0 .. 40 ] items)

integer (Record Id) >= 0

Unique identifier for the record

Responses

Request samples

Payload

Content type

application/json

[0
]

Response samples

204
default

Content type

application/json

{ }

Get my notifications rules

Responses

Response samples

200
default

Content type

application/json

[{"eventType": "RECORD_CREATED",
"ruleType": "record",
"objectId": 0,
"workspaceId": 0,
"recordId": 0,
"fieldName": "string",
"userIds": [0
],
"channels": [{"channelType": "email"
}
],
"enabled": true,
"id": 0,
"ownedBy": 0,
"externallyConfiguredChannels": [{"channelType": "zapier"
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Create Notification Rule

Request Body schema: application/json
required

required	Event Type (string) or null
ruleType required	string (NotificationRuleType) Enum: "record" "user" The different categories of notification
objectId	integer or null (Object Id) >= 0 Only send notifications for this object
workspaceId	integer or null (Record Id) >= 0 Only send notifications for this workspace
recordId	integer or null (Record Id) >= 0 Only send notifications for this record
fieldName	string or null (SDObject Field Name) [ 1 .. 10000 ] characters ^[^\|, #.]+$ Only send notifications RECORD_UPDATED events when this field has been updated. objectId or recordId is required if this property is populated
userIds	Array of integers (UserIds) [ 0 .. 50 ] items [ items >= 0 ] Only send notifications if the event was created by any of these user Ids
required	Array of objects (Channels) [ 0 .. 3 ] items The channels the notification should be sent on. InApp notifications are sent by default.
enabled required	boolean (Enabled) Only send the notification if this property is true

Responses

Request samples

Payload

Content type

application/json

{"eventType": "RECORD_CREATED",
"ruleType": "record",
"objectId": 0,
"workspaceId": 0,
"recordId": 0,
"fieldName": "string",
"userIds": [0
],
"channels": [{"channelType": "email"
}
],
"enabled": true
}

Response samples

201
400
409
default

Content type

application/json

{"eventType": "RECORD_CREATED",
"ruleType": "record",
"objectId": 0,
"workspaceId": 0,
"recordId": 0,
"fieldName": "string",
"userIds": [0
],
"channels": [{"channelType": "email"
}
],
"enabled": true,
"id": 0,
"ownedBy": 0,
"externallyConfiguredChannels": [{"channelType": "zapier"
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Put my Notification Rule

path Parameters

ruleId

string (Notification Rule Id) ^[0-9]*$

Unique system identifier for Notification Rules

Request Body schema: application/json
required

required	Event Type (string) or null
ruleType required	string (NotificationRuleType) Enum: "record" "user" The different categories of notification
objectId	integer or null (Object Id) >= 0 Only send notifications for this object
workspaceId	integer or null (Record Id) >= 0 Only send notifications for this workspace
recordId	integer or null (Record Id) >= 0 Only send notifications for this record
fieldName	string or null (SDObject Field Name) [ 1 .. 10000 ] characters ^[^\|, #.]+$ Only send notifications RECORD_UPDATED events when this field has been updated. objectId or recordId is required if this property is populated
userIds	Array of integers (UserIds) [ 0 .. 50 ] items [ items >= 0 ] Only send notifications if the event was created by any of these user Ids
required	Array of objects (Channels) [ 0 .. 3 ] items The channels the notification should be sent on. InApp notifications are sent by default.
enabled required	boolean (Enabled) Only send the notification if this property is true

Responses

Request samples

Payload

Content type

application/json

{"eventType": "RECORD_CREATED",
"ruleType": "record",
"objectId": 0,
"workspaceId": 0,
"recordId": 0,
"fieldName": "string",
"userIds": [0
],
"channels": [{"channelType": "email"
}
],
"enabled": true
}

Response samples

200
400
409
default

Content type

application/json

{"eventType": "RECORD_CREATED",
"ruleType": "record",
"objectId": 0,
"workspaceId": 0,
"recordId": 0,
"fieldName": "string",
"userIds": [0
],
"channels": [{"channelType": "email"
}
],
"enabled": true,
"id": 0,
"ownedBy": 0,
"externallyConfiguredChannels": [{"channelType": "zapier"
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Delete My Notification Rule

path Parameters

ruleId

string (Notification Rule Id) ^[0-9]*$

Unique system identifier for Notification Rules

Responses

Response samples

204
400
409
default

Content type

application/json

{ }

Get my notifications

Responses

Response samples

200
default

Content type

application/json

{"notifications": [{"messageId": "string",
"createdAt": 0,
"read": true,
"event": {"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { },
"id": "string",
"baseObjectId": 0,
"workspaceId": 0,
"createdBy": 0,
"createdAt": 0,
"createdByName": "string"
}
}
],
"searchAfter": "string"
}

Mark my notifications as read

Responses

Response samples

200
default

Content type

application/json

{ }

Get my unread notifications

Responses

Response samples

200
default

Content type

application/json

{"notifications": [{"messageId": "string",
"createdAt": 0,
"read": true,
"event": {"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { },
"id": "string",
"baseObjectId": 0,
"workspaceId": 0,
"createdBy": 0,
"createdAt": 0,
"createdByName": "string"
}
}
],
"searchAfter": "string"
}

Mark my notifications as unread

Responses

Response samples

200
default

Content type

application/json

{ }

Get my new notifications count

Responses

Response samples

200
default

Content type

application/json

{"count": 0
}

Reset my new notifications count

Responses

Response samples

204
default

Content type

application/json

{ }

Get History

Responses

Response samples

200
default

Content type

application/json

{"hitCount": 0,
"hits": [{"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { },
"id": "string",
"baseObjectId": 0,
"workspaceId": 0,
"createdBy": 0,
"createdAt": 0,
"createdByName": "string"
}
]
}

Post Events

Request Body schema: application/json
required

externalId required	number (External Event ID) External generated ID for event
eventType required	string (Event Type) Enum: "RECORD_CREATED" "RECORD_UPDATED" "RECORD_DELETED" "RECORD_OWNER_UPDATED" "RECORD_NOTE_ADDED" "RECORD_NOTE_DELETED" "RECORD_NOTE_UPDATED" "RECORD_COMMENT_ADDED" "RECORD_COMMENT_RESPONDED" "RECORD_COMMENT_RESOLVED" "RECORD_COMMENT_DELETED" "RECORD_COMMENT_UPDATED" "RECORD_LOADED" "RECORD_STARTED_WATCHING" "RECORD_STOPPED_WATCHING" "RECORD_SET_STARRED" "RECORD_SET_UNSTARRED" "RECORD_SHARED_IN_WORKSPACE" "RECORD_UNSHARED_IN_WORKSPACE" "USER_ADDED_TO_WORKSPACE" "USER_REMOVED_FROM_WORKSPACE" "WORKSPACE_ENTERED" "WORKSPACE_RECORD_SHARED" "WORKSPACE_RECORD_UNSHARED" "WORKSPACE_USER_ADDED" "WORKSPACE_USER_REMOVED" "LEAD_CONVERTED_TO_CONTACT" "LEAD_CONVERTED_TO_OPPORTUNITY" "LEAD_CONVERTED_TO_ACCOUNT" "RECORD_ASSOCIATION_CREATED" "RECORD_ASSOCIATION_DELETED" "COPIED_TO_CLIPBOARD" "PAGE_LOAD" "USER_CREATED" "CUSTOMER_USER_CREATED" "USER_REVOKED" "USER_LOGGED_IN" "USER_LOGGED_OUT" "NOTE_REACTION_ADDED" "NOTE_REACTION_REMOVED" "NOTE_MENTION" "COMMENT_REACTION_ADDED" "COMMENT_REACTION_REMOVED" "COMMENT_MENTION" "TASK_COMPLETED" "TASK_REOPENED" "TASK_ASSIGNED" "TASK_REASSIGNED" "ISSUE_CLOSED" "ISSUE_REOPENED" "ISSUE_ASSIGNED" "ISSUE_REASSIGNED" "OPPORTUNITY_WON" "OPPORTUNITY_LOST" "MEETING_ORGANISED" "MEETING_UPDATED" "MEETING_STARTED" "MEETING_ENDED" "MEETING_ENTERED" "MEETING_EXITED" "CHAT_MESSAGE_SENT" "RECORDING_STARTED" "RECORDING_STOPPED" "RECORDING_ANALYSIS_COMPLETE" "CAMERA_ENABLED" "CAMERA_DISABLED" "MICROPHONE_ENABLED" "MICROPHONE_DISABLED" "FILE_PRESENTATION_STARTED" "FILE_PRESENTATION_STOPPED" "FILE_PRESENTATION_PAGE_CHANGED" "SCREEN_SHARE_STARTED" "SCREEN_SHARE_ENDED" "FILE_UPLOADED" "FILE_DELETED" "FILE_DOWNLOADED" "FILE_VIEWED" "PAGE_CHANGED" "FILE_PLAYED" "FILE_PAUSED" "FILE_SEEKED" "FILE_ENDED" "FILE_PROCESSING_STARTED" "FILE_PROCESSING_ENDED" "FILE_PROCESSING_FAILED" "FILE_TRANSCODE_STARTED" "FILE_TRANSCODE_ENDED" "FILE_TRANSCRIPTION_STARTED" "FILE_TRANSCRIPTION_ENDED" "FILE_TRANSCRIPTION_ANALYSIS_STARTED" "FILE_TRANSCRIPTION_ANALYSIS_ENDED" "FILE_TRANSCRIPTION_ANALYSIS_MINUTES_EXTRACTED" "FILE_COMPOSITING_STARTED" "FILE_COMPOSITING_ENDED" "MESSAGE_SENT" "MESSAGE_UPDATED" "MESSAGE_DELETED" "MESSAGE_RECORD_SHARED" "MESSAGE_HUDDLE_STARTED" "MESSAGE_MENTION" "MESSAGE_CHANNEL_CREATED" "MESSAGE_CHANNEL_DELETED" "MESSAGE_CHANNEL_MEMBER_CREATED" "MESSAGE_CHANNEL_MEMBER_DELETED" "IMPORT_JOB_STARTED" "IMPORT_JOB_COMPLETED" "IMPORT_JOB_FAILED" Type of the event
recordId	integer (Record Id) >= 0 Id of the record that's the subject of the event
objectId	integer (ObjectId Id) >= 0 Object Id of the object that's the subject of the event
params	object (Event Parameters) Special parameters for the event

Responses

Request samples

Payload

Content type

application/json

{"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { }
}

Response samples

200
default

Content type

application/json

{ }

Get History for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

{"hitCount": 0,
"hits": [{"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { },
"id": "string",
"baseObjectId": 0,
"workspaceId": 0,
"createdBy": 0,
"createdAt": 0,
"createdByName": "string"
}
]
}

Post Events for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

externalId required	number (External Event ID) External generated ID for event
eventType required	string (Event Type) Enum: "RECORD_CREATED" "RECORD_UPDATED" "RECORD_DELETED" "RECORD_OWNER_UPDATED" "RECORD_NOTE_ADDED" "RECORD_NOTE_DELETED" "RECORD_NOTE_UPDATED" "RECORD_COMMENT_ADDED" "RECORD_COMMENT_RESPONDED" "RECORD_COMMENT_RESOLVED" "RECORD_COMMENT_DELETED" "RECORD_COMMENT_UPDATED" "RECORD_LOADED" "RECORD_STARTED_WATCHING" "RECORD_STOPPED_WATCHING" "RECORD_SET_STARRED" "RECORD_SET_UNSTARRED" "RECORD_SHARED_IN_WORKSPACE" "RECORD_UNSHARED_IN_WORKSPACE" "USER_ADDED_TO_WORKSPACE" "USER_REMOVED_FROM_WORKSPACE" "WORKSPACE_ENTERED" "WORKSPACE_RECORD_SHARED" "WORKSPACE_RECORD_UNSHARED" "WORKSPACE_USER_ADDED" "WORKSPACE_USER_REMOVED" "LEAD_CONVERTED_TO_CONTACT" "LEAD_CONVERTED_TO_OPPORTUNITY" "LEAD_CONVERTED_TO_ACCOUNT" "RECORD_ASSOCIATION_CREATED" "RECORD_ASSOCIATION_DELETED" "COPIED_TO_CLIPBOARD" "PAGE_LOAD" "USER_CREATED" "CUSTOMER_USER_CREATED" "USER_REVOKED" "USER_LOGGED_IN" "USER_LOGGED_OUT" "NOTE_REACTION_ADDED" "NOTE_REACTION_REMOVED" "NOTE_MENTION" "COMMENT_REACTION_ADDED" "COMMENT_REACTION_REMOVED" "COMMENT_MENTION" "TASK_COMPLETED" "TASK_REOPENED" "TASK_ASSIGNED" "TASK_REASSIGNED" "ISSUE_CLOSED" "ISSUE_REOPENED" "ISSUE_ASSIGNED" "ISSUE_REASSIGNED" "OPPORTUNITY_WON" "OPPORTUNITY_LOST" "MEETING_ORGANISED" "MEETING_UPDATED" "MEETING_STARTED" "MEETING_ENDED" "MEETING_ENTERED" "MEETING_EXITED" "CHAT_MESSAGE_SENT" "RECORDING_STARTED" "RECORDING_STOPPED" "RECORDING_ANALYSIS_COMPLETE" "CAMERA_ENABLED" "CAMERA_DISABLED" "MICROPHONE_ENABLED" "MICROPHONE_DISABLED" "FILE_PRESENTATION_STARTED" "FILE_PRESENTATION_STOPPED" "FILE_PRESENTATION_PAGE_CHANGED" "SCREEN_SHARE_STARTED" "SCREEN_SHARE_ENDED" "FILE_UPLOADED" "FILE_DELETED" "FILE_DOWNLOADED" "FILE_VIEWED" "PAGE_CHANGED" "FILE_PLAYED" "FILE_PAUSED" "FILE_SEEKED" "FILE_ENDED" "FILE_PROCESSING_STARTED" "FILE_PROCESSING_ENDED" "FILE_PROCESSING_FAILED" "FILE_TRANSCODE_STARTED" "FILE_TRANSCODE_ENDED" "FILE_TRANSCRIPTION_STARTED" "FILE_TRANSCRIPTION_ENDED" "FILE_TRANSCRIPTION_ANALYSIS_STARTED" "FILE_TRANSCRIPTION_ANALYSIS_ENDED" "FILE_TRANSCRIPTION_ANALYSIS_MINUTES_EXTRACTED" "FILE_COMPOSITING_STARTED" "FILE_COMPOSITING_ENDED" "MESSAGE_SENT" "MESSAGE_UPDATED" "MESSAGE_DELETED" "MESSAGE_RECORD_SHARED" "MESSAGE_HUDDLE_STARTED" "MESSAGE_MENTION" "MESSAGE_CHANNEL_CREATED" "MESSAGE_CHANNEL_DELETED" "MESSAGE_CHANNEL_MEMBER_CREATED" "MESSAGE_CHANNEL_MEMBER_DELETED" "IMPORT_JOB_STARTED" "IMPORT_JOB_COMPLETED" "IMPORT_JOB_FAILED" Type of the event
recordId	integer (Record Id) >= 0 Id of the record that's the subject of the event
objectId	integer (ObjectId Id) >= 0 Object Id of the object that's the subject of the event
params	object (Event Parameters) Special parameters for the event

Responses

Request samples

Payload

Content type

application/json

{"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { }
}

Response samples

200
default

Content type

application/json

{ }

Get Events Summary

Responses

Response samples

200
default

Content type

application/json

{"buckets": [{"key": "string",
"from": 0,
"to": 0,
"doc_count": 0
}
]
}

Get Events Summary for workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Responses

Response samples

200
default

Content type

application/json

{"buckets": [{"key": "string",
"from": 0,
"to": 0,
"doc_count": 0
}
]
}

Grant access

Request Body schema: application/json
required

userId required	integer (Record Id) >= 0 Unique identifier for the record
welcomeMessage	string

Responses

Request samples

Payload

Content type

application/json

{"userId": 0,
"welcomeMessage": "string"
}

Response samples

200
default

Content type

application/json

{ }

Get Tenant Settings

Responses

Response samples

200
default

Content type

application/json

{"accountName": "string",
"chips": "string",
"accountLogo": 0,
"workspaceListWelcomeText": "string",
"crmTheme": "Grey",
"defaultWorkspaceTheme": "Grey"
}

Update Tenant Settings

Request Body schema: application/json
required

accountName	string (Account Name) The name of the account
chips	string
accountLogo	number or null (Account Logo) Account logo file ID
workspaceListWelcomeText	string or null (Workspace List Welcome Text) Welcome text for the workspace list page
	CRM Theme (string) or CRM Theme (null) (CRM Theme) CRM theme ID
	Default Workspace Theme (string) or Default Workspace Theme (null) (Default Workspace Theme) Default theme for new workspaces

Responses

Request samples

Payload

Content type

application/json

{"accountName": "string",
"chips": "string",
"accountLogo": 0,
"workspaceListWelcomeText": "string",
"crmTheme": "Grey",
"defaultWorkspaceTheme": "Grey"
}

Response samples

201
default

Content type

application/json

{ }

Post Import

Request Body schema: application/json
required

objectId required	integer (Object Id) >= 0 Unique identifier for the object
fileId required	integer (File ID) >= 0 ID of file

Responses

Request samples

Payload

Content type

application/json

{"objectId": 0,
"fileId": 0
}

Response samples

201
default

Content type

application/json

{"id": "string",
"fileName": "string",
"fileKey": "string",
"rowCount": 9007199254740991,
"columnCount": 9007199254740991,
"objectId": 0,
"fileId": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get mappings for an Import

path Parameters

importId

string (Import Id) ^[0-9a-zA-Z]{26}$

Unique system identifier for Imports

Responses

Response samples

200
default

Content type

application/json

[{"columnName": "string",
"fieldName": "string",
"columnIndex": 9007199254740991,
"examples": ["string"
],
"fieldDisplayName": "string"
}
]

Starts an import job

path Parameters

importId

string (Import Id) ^[0-9a-zA-Z]{26}$

Unique system identifier for Imports

Request Body schema: application/json
required

dryRun required	boolean (Boolean) If true then does not create or update any records. Used to check validity of the ImportJob request
required	Array of objects (ImportMappingEntryCreateRequestSchema)

Responses

Request samples

Payload

Content type

application/json

{"dryRun": true,
"mappingEntries": [{"columnName": "string",
"fieldName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"id": "string",
"importId": "string",
"objectId": 0,
"dryRun": true,
"mappingEntries": [{"columnName": "string",
"fieldName": "string"
}
],
"status": "Created",
"rowCount": 9007199254740991,
"createdCount": 9007199254740991,
"patchedCount": 9007199254740991,
"errorCount": 9007199254740991,
"errorFileSignedUrl": "string",
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get an Import Job

path Parameters

importId	string (Import Id) ^[0-9a-zA-Z]{26}$ Unique system identifier for Imports
jobId	string (Import Job Id) ^[0-9a-zA-Z]{26}$ Unique system identifier for Import Jobs

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"importId": "string",
"objectId": 0,
"dryRun": true,
"mappingEntries": [{"columnName": "string",
"fieldName": "string"
}
],
"status": "Created",
"rowCount": 9007199254740991,
"createdCount": 9007199254740991,
"patchedCount": 9007199254740991,
"errorCount": 9007199254740991,
"errorFileSignedUrl": "string",
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Get My Import Jobs

path Parameters

objectId	string (Id Path Parameter) ^[0-9]*$ Unique system identifier
status	string (ImportJobStatus) Enum: "Created" "Running" "Failed" "Completed" Indicates the state that the import job is in
size	string (Search Size) ^([1-9]\|[1-9][0-9]\|100)$ The number of import jobs to return in the search
searchAfter	string (Search After) ^([\|\-\w\d]*)$ Add the searchAfter result from a previous query to an identical query to get the next set of results

Responses

Response samples

200
default

Content type

application/json

{"importJobs": [{"id": "string",
"importId": "string",
"objectId": 0,
"dryRun": true,
"mappingEntries": [{"columnName": "string",
"fieldName": "string"
}
],
"status": "Created",
"rowCount": 9007199254740991,
"createdCount": 9007199254740991,
"patchedCount": 9007199254740991,
"errorCount": 9007199254740991,
"errorFileSignedUrl": "string",
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
],
"searchAfter": "string"
}

Get My Import Jobs

path Parameters

objectId	string (Id Path Parameter) ^[0-9]*$ Unique system identifier
size	string (Search Size) ^([1-9]\|[1-9][0-9]\|100)$ The number of import jobs to return in the search
searchAfter	string (Search After) ^([\|\-\w\d]*)$ Add the searchAfter result from a previous query to an identical query to get the next set of results

Responses

Response samples

200
default

Content type

application/json

{"importJobs": [{"id": "string",
"importId": "string",
"objectId": 0,
"dryRun": true,
"mappingEntries": [{"columnName": "string",
"fieldName": "string"
}
],
"status": "Created",
"rowCount": 9007199254740991,
"createdCount": 9007199254740991,
"patchedCount": 9007199254740991,
"errorCount": 9007199254740991,
"errorFileSignedUrl": "string",
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
],
"searchAfter": "string"
}

Get example records that would be create/updated for the import

path Parameters

importId

string (Import Id) ^[0-9a-zA-Z]{26}$

Unique system identifier for Imports

Request Body schema: application/json
required

Array

columnName required	string (String) [ 1 .. 10000 ] characters
fieldName required	string (SDObject Field Name) [ 1 .. 10000 ] characters ^[^\|, #.]+$ The name of the Field. Not editable

Responses

Request samples

Payload

Content type

application/json

[{"columnName": "string",
"fieldName": "string"
}
]

Response samples

200
default

Content type

application/json

[{"type": "Create",
"record": {"objectId": 0,
"name": "string",
"fieldValues": [{"fieldName": "string",
"value": null
}
],
"isTemplate": true,
"id": 0,
"creationType": "System",
"version": 0,
"objectVersion": 0,
"deleted": true,
"sharedWorkspaceIds": [0
],
"ownedBy": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
}
]

Returns the authenticated user's list of API keys

Responses

Response samples

200
default

Content type

application/json

[[ ]
]

Create a SalesDesk API key

Request Body schema: application/json
required

non-empty

name

required

string (API Key Name) [ 1 .. 100 ] characters

Human-readable name of API Key

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200
default

Content type

application/json

{"apiKeyId": "string",
"name": "string",
"createdAt": 0,
"apiSecret": "string"
}

Patch API Key

path Parameters

apiKeyId

string (Role Id) ^[0-9]*$

Unique system identifier for Roles

Request Body schema: application/json
required

non-empty

name

required

string (API Key Name) [ 1 .. 100 ] characters

Human-readable new name of API Key

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

204
default

Content type

application/json

{ }

Delete API Key

path Parameters

apiKeyId

string (API Key ID)

API Key ID

Responses

Response samples

204
default

Content type

application/json

{ }

Get access token for Google integration

Log out of Google

Responses

Response samples

204
default

Content type

application/json

{ }

Returns example events for Zapier

Responses

Response samples

200
default

Content type

application/json

[{"externalId": 0,
"eventType": "RECORD_CREATED",
"recordId": 0,
"objectId": 0,
"params": { },
"id": "string",
"baseObjectId": 0,
"workspaceId": 0,
"createdBy": 0,
"createdAt": 0,
"createdByName": "string"
}
]

Returns example events for Zapier

Responses

Response samples

200
default

Content type

application/json

[{"id": 0,
"ruleName": "string"
}
]

When Zapier subscribes to a notification rule

When Zapier unsubscribes from a notification rule

Get Subscription Plans

Responses

Response samples

200
400
default

Content type

application/json

[{"id": "string",
"uscPricePerUserPerMonth": 9007199254740991,
"annualBillingDiscountPercent": 100,
"expiryDurationDays": 9007199254740991,
"active": true,
"quotas": [{"planId": "string",
"quotaId": "Users",
"quota": 9007199254740991,
"includedUtilization": 9007199254740991,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
],
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}
]

Gets the tenant subscription

Responses

Response samples

200
400
default

Content type

application/json

{"planId": "string",
"uscPricePerUserPerMonth": 1.7976931348623157e+308,
"billingFrequency": "none",
"active": true,
"expiry": 0,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Gets the quota utilization for a specific quota

Responses

Response samples

200
400
default

Content type

application/json

{"quotaId": "Users",
"quota": 9007199254740991,
"periodId": "string",
"utilization": 9007199254740991,
"createdAt": 0,
"createdBy": 0,
"updatedAt": 0,
"updatedBy": 0
}

Gets whether an email address corresponds to an existing customer

Add customer to workspace

path Parameters

workspaceId

string (SDRecord Id) ^[0-9]*$

Unique system identifier for SDRecords

Request Body schema: application/json
required

emailAddress required	string (Email Address) The email address of the customer to invite to the workspace
title	string (Job Title) The job title of the customer to invite to the workspace
firstName	string (First Name) [ 1 .. 10000 ] characters
surname	string (Last Name) [ 1 .. 10000 ] characters
welcomeMessage	string (Welcome Message) [ 1 .. 10000 ] characters

Responses

Request samples

Payload

Content type

application/json

{"emailAddress": "string",
"title": "string",
"firstName": "string",
"surname": "string",
"welcomeMessage": "string"
}

Response samples

200
default

Content type

application/json

{ }

Remove customer from workspace

Responses

Response samples

204
default

Content type

application/json

{ }

Get AI Agent Settings

Responses

Response samples

200
default

Content type

application/json

{"video_call_recording_enrichment": true,
"video_call_recording_minutes_record": true,
"video_call_recording_task_records": true,
"video_call_recording_coaching_advice": true,
"video_call_recording_sentiment": true,
"video_call_recording_summary_email": true,
"uploaded_video_transcription": true,
"uploaded_video_summary": true,
"uploaded_video_sentiment": true
}

Update AI Agent Settings

Request Body schema: application/json
required

video_call_recording_enrichment	boolean (Boolean)
video_call_recording_minutes_record	boolean (Boolean)
video_call_recording_task_records	boolean (Boolean)
video_call_recording_coaching_advice	boolean (Boolean)
video_call_recording_sentiment	boolean (Boolean)
video_call_recording_summary_email	boolean (Boolean)
uploaded_video_transcription	boolean (Boolean)
uploaded_video_summary	boolean (Boolean)
uploaded_video_sentiment	boolean (Boolean)

Responses

Request samples

Payload

Content type

application/json

{"video_call_recording_enrichment": true,
"video_call_recording_minutes_record": true,
"video_call_recording_task_records": true,
"video_call_recording_coaching_advice": true,
"video_call_recording_sentiment": true,
"video_call_recording_summary_email": true,
"uploaded_video_transcription": true,
"uploaded_video_summary": true,
"uploaded_video_sentiment": true
}

Response samples

200
default

Content type

application/json

{"video_call_recording_enrichment": true,
"video_call_recording_minutes_record": true,
"video_call_recording_task_records": true,
"video_call_recording_coaching_advice": true,
"video_call_recording_sentiment": true,
"video_call_recording_summary_email": true,
"uploaded_video_transcription": true,
"uploaded_video_summary": true,
"uploaded_video_sentiment": true
}

SalesDesk RestApi (0.1)

Returns the authenticated user's list of tenants to log in to

Responses

Response samples

Returns the Claims for the authenticated User

Responses

Response samples

Returns the Credentials to connect to Chime

Responses

Response samples

Returns readonly Credentials to connect to Chime channel

path Parameters

Responses

Response samples

Create Role

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Roles

Responses

Response samples

Get Role

path Parameters

Responses

Response samples

Patch Role

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Role

path Parameters

Responses

Response samples

Resend Invitation

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get timestamp when user was last active

path Parameters

Responses

Response samples

Post Object Association

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Object Association

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete Association Definition

path Parameters

Responses

Response samples

Get Comments

path Parameters

Responses

Response samples

Post Comment

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Comments for workspace

path Parameters

Responses

Response samples

Post Comment for workspace

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required