Create Reminder

Create a new Reminder record.

POST /api/crm/reminders

Create Reminder

cURL

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/reminders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "ReminderType": 123,
  "ReminderAction": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/reminders"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "ReminderType": 123,
    "ReminderAction": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', ReminderType: 123, ReminderAction: 123})
};

fetch('https://spaces.nexudus.com/api/crm/reminders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A Reminder defines an automated message triggered by a specific event or schedule. Reminders can send emails, canned messages, or surveys based on triggers such as sign-up anniversaries, booking activity, invoice due dates, or contract milestones.

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-Create role.

Enums

eReminderType — ReminderType values

Value	Name
1	FixedDate
2	DaysAfterSignUp
3	DaysAfterRenewal
4	DaysBeforeRenewal
5	Birthday
6	DaysBeforeCancellation
7	AfterABooking
8	LastActivity
9	ProductPurchase
10	DueInvoice
11	OnFirstCheckIn
12	OnSignUpFormSubmitted
13	DaysBeforeTerm
14	RegularBookerStoppedBooking
15	RegularBooking
16	StoppedBooking
17	SingleBooking
18	InvoiceFirstPaid
19	DaysBeforeContractStarts
20	DaysAfterDeliveryNotCollected
21	DaysAfterFirstContractStartDate
22	ProductAddedToBooking

eReminderAction — ReminderAction values

Value	Name
1	SendEmail
2	SendCannedMessage
3	SendSurvey

Request Body

Required Fields

BusinessId · integer · required

ID of the business linked to this record.

Name · string · required

The name value for this reminder.

ReminderType · integer · required

The reminder type value for this reminder.

ReminderAction · integer · required

The reminder action value for this reminder.

Optional Fields

ForAllContacts · boolean

Whether for all contacts is enabled.

ForAllMembers · boolean

Whether for all members is enabled.

ForAllChildLocations · boolean

Whether for all child locations is enabled.

CoworkerId · integer

ID of the coworker linked to this record.

Tariffs · integer[]

List of tariffs linked to this record.

ReminderDate · string

Date/time value for reminder date.

DaysAfterSignup · integer

The days after signup value for this reminder.

ProductId · integer

ID of the product linked to this record.

SurveyId · integer

ID of the survey linked to this record.

DaysAfterRenewal · integer

The days after renewal value for this reminder.

DaysBeforeRenewal · integer

The days before renewal value for this reminder.

Email · string

The email value for this reminder.

CannedResponseId · integer

ID of the canned response linked to this record.

NextProcessTime · string

Date/time value for next process time.

Resources · integer[]

List of resources linked to this record.

OnlySendToTeamPayingMembers · boolean

Whether only send to team paying members is enabled.

OnlySendToActiveCoworkers · boolean

Whether only send to active coworkers is enabled.

BlockingPeriodMinutes · integer

The blocking period minutes value for this reminder.

Code Examples

cURL

curl -X POST \
  "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
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/reminders',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      ReminderType: 0,
      ReminderAction: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/crm/reminders',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'ReminderType': 0,
        'ReminderAction': 0
    }
)

data = response.json()

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the reminder was created successfully.

Errors · array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Reminder was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[e-mail]",
  "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.

Show child attributes

AttemptedValue · any

The value that was submitted for the field, or null if missing.

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

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
}