The cannedresponse object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this cannedresponse |
BusinessId: Id required |
MessageText: string optional |
Name: string required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this cannedresponse |
SystemId: string optional api-only
User defined data about this cannedresponse. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"MessageText": "Abc123456",
"Name": "Joe",
"UniqueId": "69c9b81a-9006-4dca-b91f-ed4c2e7e06d8",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a CannedResponse
This endpoint allows you to GET a list of cannedresponses based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/crm/cannedresponses?...
π Requires role "CannedResponse-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search cannedresponse records based on their different properties. |
Id number
?Id=12345678 |
CannedResponse_Business Business
?CannedResponse_Business=... |
CannedResponse_MessageText string
?CannedResponse_MessageText=... |
CannedResponse_Name string
?CannedResponse_Name=... |
Range search querystring parameters
Lets you search cannedresponse records based on a range of date or numeric values. |
To_CannedResponse_CreatedOn date
?To_CannedResponse_CreatedOn=2010-01-01T20:32 |
From_CannedResponse_CreatedOn date
?From_CannedResponse_CreatedOn=2010-01-01T20:32 |
To_CannedResponse_UpdatedOn date
?To_CannedResponse_UpdatedOn=2010-01-01T20:32 |
From_CannedResponse_UpdatedOn date
?From_CannedResponse_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/crm/cannedresponses?CannedResponse_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"MessageText": "Abc123456",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "394be87e-2a9d-40a1-b33b-40afe29fc132",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find CannedResponses by IDs
Gets one or more cannedresponse records based on their Id.GET https://spaces.nexudus.com/api/crm/cannedresponses?CannedResponse_Id=[:id1,:id2,...]
π Requires role "CannedResponse-List"
Querystring parameters |
CannedResponse_Id: array requried
?CannedResponse_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/crm/cannedresponses?CannedResponse_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"MessageText": "Abc123456",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "4bb93499-1504-4ce5-aa95-22a7a07ac03c",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single CannedResponse by Id
Gets one cannedresponse record by its Id.GET https://spaces.nexudus.com/api/crm/cannedresponses/:Id
π Requires role "CannedResponse-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/crm/cannedresponses/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"MessageText": "Abc123456",
"Name": "Joe",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "88889a4c-de0d-440e-8912-46c99459ffac",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new CannedResponse
Creates a new cannedresponse.POST https://spaces.nexudus.com/api/crm/cannedresponses
π Requires role "CannedResponse-Create"
Body parameters |
BusinessId: number required |
Name: string required |
MessageText: string optional |
Example request
POST https://spaces.nexudus.com/api/crm/cannedresponses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "Joe",
"MessageText": "Abc123456",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update CannedResponse
Updates an existing cannedresponse.PUT https://spaces.nexudus.com/api/crm/cannedresponses
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "CannedResponse-Edit"
Body parameters |
Id: number required
The unique Id of the cannedresponse to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
MessageText: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/crm/cannedresponses Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "Joe",
"MessageText": "Abc123456",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete CannedResponse
Deletes an existing cannedresponse by its Id.DELETE https://spaces.nexudus.com/api/crm/cannedresponses/:Id
π Requires role "CannedResponse-Delete"
URL parameters |
Id: number required
The unique Id of the cannedresponse to update. |
Example request
DELETE https://spaces.nexudus.com/api/crm/cannedresponses/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more cannedresponse records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for cannedresponse records.GET https://spaces.nexudus.com/api/crm/cannedresponses/commands
Example request
GET https://spaces.nexudus.com/api/crm/cannedresponses/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more cannedresponse record IDs.POST https://spaces.nexudus.com/api/crm/cannedresponses/runacommandπ Requires role "CannedResponse-Edit"
Example request
POST https://spaces.nexudus.com/api/crm/cannedresponses/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Comments
Please sign in to leave a comment.