Skip to main content
PUT
/
api
/
crm
/
reminders
Update Reminder
curl --request PUT \
  --url https://spaces.nexudus.com/api/crm/reminders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "BusinessId": 123,
  "Name": "<string>",
  "ReminderType": 123,
  "ReminderAction": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt

Use this file to discover all available pages before exploring further.

Updates an existing Reminder record. You must include the Id of the record to update along with all required fields.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Reminder-Edit role.

​
Request Body

​
Required Fields

​
Id
integer
required
The Id of the Reminder record to update.
​
BusinessId
integer
required
Business Id.
​
Name
string
required
Name.
​
ReminderType
integer
required
Reminder Type.
​
ReminderAction
integer
required
Reminder Action.

​
Optional Fields

​
ForAllContacts
boolean
For All Contacts.
​
ForAllMembers
boolean
For All Members.
​
ForAllChildLocations
boolean
For All Child Locations.
​
CoworkerId
integer
Coworker Id.
​
Tariffs
integer[]
Tariffs.
​
AddedTariffs
integer[]
Added Tariffs.
​
RemovedTariffs
integer[]
Removed Tariffs.
​
ReminderDate
string
Reminder Date.
​
DaysAfterSignup
integer
Days After Signup.
​
ProductId
integer
Product Id.
​
SurveyId
integer
Survey Id.
​
DaysAfterRenewal
integer
Days After Renewal.
​
DaysBeforeRenewal
integer
Days Before Renewal.
​
Email
string
Email.
​
CannedResponseId
integer
Canned Response Id.
​
NextProcessTime
string
Next Process Time.
​
Resources
integer[]
Resources.
​
AddedResources
integer[]
Added Resources.
​
RemovedResources
integer[]
Removed Resources.
​
OnlySendToTeamPayingMembers
boolean
Only Send To Team Paying Members.
​
OnlySendToActiveCoworkers
boolean
Only Send To Active Coworkers.
​
BlockingPeriodMinutes
integer
Blocking Period Minutes.

​
Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/crm/reminders" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "ReminderType": 0,
    "ReminderAction": 0,
    "Id": 87654321
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the update.
​
Value
object
Contains the Id of the updated record.
​
WasSuccessful
boolean
true if the reminder was updated successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Reminder was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}