The reminder object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this reminder |
BusinessId: Id required |
CannedResponseId: Id optional |
CoworkerId: Id optional |
DaysAfterRenewal: int? optional |
DaysAfterSignup: int? optional |
DaysBeforeRenewal: int? optional |
Email: string optional |
ForAllContacts: bool optional |
ForAllMembers: bool optional |
Name: string required |
ProductId: Id optional |
ReminderAction: Nexudus.Coworking.Core.Enums.eReminderAction optional |
ReminderDate: DateTime? optional |
ReminderType: Nexudus.Coworking.Core.Enums.eReminderType optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this reminder |
SystemId: string optional api-only
User defined data about this reminder. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"CannedResponseId": 12345678,
"CoworkerId": 12345678,
"DaysAfterRenewal": ,
"DaysAfterSignup": ,
"DaysBeforeRenewal": ,
"Email": "joe@nexudus.com",
"ForAllContacts": false,
"ForAllMembers": false,
"Name": "Joe",
"ProductId": 12345678,
"ReminderAction": 1,
"ReminderDate": ,
"ReminderType": 1,
"UniqueId": "88a5ff33-d291-4a14-b5a7-905531b86eb4",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Reminder
This endpoint allows you to GET a list of reminders based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/crm/reminders?...
π Requires role "Reminder-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 reminder records based on their different properties. |
Id number
?Id=12345678 |
Reminder_Business Business
?Reminder_Business=... |
Reminder_CannedResponse CannedResponse
?Reminder_CannedResponse=... |
Reminder_Coworker Coworker
?Reminder_Coworker=... |
Reminder_DaysAfterRenewal int?
?Reminder_DaysAfterRenewal=... |
Reminder_DaysAfterSignup int?
?Reminder_DaysAfterSignup=... |
Reminder_DaysBeforeRenewal int?
?Reminder_DaysBeforeRenewal=... |
Reminder_Email string
?Reminder_Email=... |
Reminder_ForAllContacts bool
?Reminder_ForAllContacts=... |
Reminder_ForAllMembers bool
?Reminder_ForAllMembers=... |
Reminder_Name string
?Reminder_Name=... |
Reminder_Product Product
?Reminder_Product=... |
Reminder_ReminderAction Nexudus.Coworking.Core.Enums.eReminderAction
?Reminder_ReminderAction=... |
Reminder_ReminderDate DateTime?
?Reminder_ReminderDate=... |
Reminder_ReminderType Nexudus.Coworking.Core.Enums.eReminderType
?Reminder_ReminderType=... |
Reminder_Business_Name string
?Reminder_Business_Name=... |
Reminder_Product_Name string
?Reminder_Product_Name=... |
Reminder_Tariffs List of Tariff
?Reminder_Tariffs=... |
Range search querystring parameters
Lets you search reminder records based on a range of date or numeric values. |
To_Reminder_CreatedOn date
?To_Reminder_CreatedOn=2010-01-01T20:32 |
From_Reminder_CreatedOn date
?From_Reminder_CreatedOn=2010-01-01T20:32 |
To_Reminder_UpdatedOn date
?To_Reminder_UpdatedOn=2010-01-01T20:32 |
From_Reminder_UpdatedOn date
?From_Reminder_UpdatedOn=2010-01-01T20:32 |
To_Reminder_ReminderDate date
?To_Reminder_ReminderDate=2010-01-01T20:32 |
From_Reminder_ReminderDate date
?From_Reminder_ReminderDate=2010-01-01T20:32 |
To_Reminder_DaysAfterSignup number
?To_Reminder_DaysAfterSignup=0 |
From_Reminder_DaysAfterSignup number
?From_Reminder_DaysAfterSignup=10 |
To_Reminder_DaysAfterRenewal number
?To_Reminder_DaysAfterRenewal=0 |
From_Reminder_DaysAfterRenewal number
?From_Reminder_DaysAfterRenewal=10 |
To_Reminder_DaysBeforeRenewal number
?To_Reminder_DaysBeforeRenewal=0 |
From_Reminder_DaysBeforeRenewal number
?From_Reminder_DaysBeforeRenewal=10 |
Example request
GET https://spaces.nexudus.com/api/crm/reminders?Reminder_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"ForAllContacts": false,
"ForAllMembers": false,
"Coworker": ,
"ReminderType": 1,
"ReminderDate": ,
"DaysAfterSignup": ,
"Product": ,
"DaysAfterRenewal": ,
"DaysBeforeRenewal": ,
"ReminderAction": 1,
"Email": "joe@nexudus.com",
"CannedResponse": ,
"ReminderBusinessName": "...",
"ReminderProductName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "6bf29ba4-b6cd-4bf2-9651-d2c56fc0b68d",
"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 Reminders by IDs
Gets one or more reminder records based on their Id.GET https://spaces.nexudus.com/api/crm/reminders?Reminder_Id=[:id1,:id2,...]
π Requires role "Reminder-List"
Querystring parameters |
Reminder_Id: array requried
?Reminder_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/crm/reminders?Reminder_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"ForAllContacts": false,
"ForAllMembers": false,
"Coworker": ,
"ReminderType": 1,
"ReminderDate": ,
"DaysAfterSignup": ,
"Product": ,
"DaysAfterRenewal": ,
"DaysBeforeRenewal": ,
"ReminderAction": 1,
"Email": "joe@nexudus.com",
"CannedResponse": ,
"ReminderBusinessName": "...",
"ReminderProductName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "20570e9e-09b0-4ab0-a5ed-334bc914f689",
"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 Reminder by Id
Gets one reminder record by its Id.GET https://spaces.nexudus.com/api/crm/reminders/:Id
π Requires role "Reminder-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/crm/reminders/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"CannedResponseId": 12345678,
"CoworkerId": 12345678,
"DaysAfterRenewal": ,
"DaysAfterSignup": ,
"DaysBeforeRenewal": ,
"Email": "joe@nexudus.com",
"ForAllContacts": false,
"ForAllMembers": false,
"Name": "Joe",
"ProductId": 12345678,
"ReminderAction": 1,
"ReminderDate": ,
"ReminderType": 1,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "15a3d302-0311-436c-8a83-3d3248a6955e",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Reminder
Creates a new reminder.POST https://spaces.nexudus.com/api/crm/reminders
π Requires role "Reminder-Create"
Body parameters |
BusinessId: number required |
Name: string required |
ForAllContacts: bool optional |
ForAllMembers: bool optional |
CoworkerId: number optional |
ReminderType: Nexudus.Coworking.Core.Enums.eReminderType optional |
ReminderDate: DateTime? optional |
DaysAfterSignup: int? optional |
ProductId: number optional |
DaysAfterRenewal: int? optional |
DaysBeforeRenewal: int? optional |
ReminderAction: Nexudus.Coworking.Core.Enums.eReminderAction optional |
Email: string optional |
CannedResponseId: number optional |
Example request
POST https://spaces.nexudus.com/api/crm/reminders Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "Joe",
"ForAllContacts": false,
"ForAllMembers": false,
"CoworkerId": 12345678,
"Tariffs": [12345678, 87654321],
"ReminderType": 1, //(check Enumerated values section below)
"ReminderDate": ,
"DaysAfterSignup": ,
"ProductId": 12345678,
"DaysAfterRenewal": ,
"DaysBeforeRenewal": ,
"ReminderAction": 1, //(check Enumerated values section below)
"Email": "joe@nexudus.com",
"CannedResponseId": 12345678,
}
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 Reminder
Updates an existing reminder.PUT https://spaces.nexudus.com/api/crm/reminders
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "Reminder-Edit"
Body parameters |
Id: number required
The unique Id of the reminder to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
ForAllContacts: bool cleared if missing |
ForAllMembers: bool cleared if missing |
CoworkerId: number cleared if missing |
ReminderType: Nexudus.Coworking.Core.Enums.eReminderType cleared if missing |
ReminderDate: DateTime? cleared if missing |
DaysAfterSignup: int? cleared if missing |
ProductId: number cleared if missing |
DaysAfterRenewal: int? cleared if missing |
DaysBeforeRenewal: int? cleared if missing |
ReminderAction: Nexudus.Coworking.Core.Enums.eReminderAction cleared if missing |
Email: string cleared if missing |
CannedResponseId: number cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/crm/reminders Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "Joe",
"ForAllContacts": false,
"ForAllMembers": false,
"CoworkerId": 12345678,
"Tariffs": [12345678, 87654321],
"ReminderType": 1, //(check Enumerated values section below)
"ReminderDate": ,
"DaysAfterSignup": ,
"ProductId": 12345678,
"DaysAfterRenewal": ,
"DaysBeforeRenewal": ,
"ReminderAction": 1, //(check Enumerated values section below)
"Email": "joe@nexudus.com",
"CannedResponseId": 12345678,
}
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 Reminder
Deletes an existing reminder by its Id.DELETE https://spaces.nexudus.com/api/crm/reminders/:Id
π Requires role "Reminder-Delete"
URL parameters |
Id: number required
The unique Id of the reminder to update. |
Example request
DELETE https://spaces.nexudus.com/api/crm/reminders/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 reminder 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 reminder records.GET https://spaces.nexudus.com/api/crm/reminders/commands
Example request
GET https://spaces.nexudus.com/api/crm/reminders/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 reminder record IDs.POST https://spaces.nexudus.com/api/crm/reminders/runacommandπ Requires role "Reminder-Edit"
Example request
POST https://spaces.nexudus.com/api/crm/reminders/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
}
Enumerated values
ReminderType
GET /api/utils/enums?name=eReminderType
ReminderAction
GET /api/utils/enums?name=eReminderAction
Comments
Please sign in to leave a comment.