> ## 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.

# Create Reminder

> Create a new Reminder record.

## Authentication

<Note>
  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.
</Note>

## Request Body

### Required Fields

<ParamField body="BusinessId" type="integer" required>
  Business Id.
</ParamField>

<ParamField body="Name" type="string" required>
  Name.
</ParamField>

<ParamField body="ReminderType" type="integer" required>
  Reminder Type.
</ParamField>

<ParamField body="ReminderAction" type="integer" required>
  Reminder Action.
</ParamField>

### Optional Fields

<ParamField body="ForAllContacts" type="boolean">
  For All Contacts.
</ParamField>

<ParamField body="ForAllMembers" type="boolean">
  For All Members.
</ParamField>

<ParamField body="ForAllChildLocations" type="boolean">
  For All Child Locations.
</ParamField>

<ParamField body="CoworkerId" type="integer">
  Coworker Id.
</ParamField>

<ParamField body="Tariffs" type="integer[]">
  Tariffs.
</ParamField>

<ParamField body="ReminderDate" type="string">
  Reminder Date.
</ParamField>

<ParamField body="DaysAfterSignup" type="integer">
  Days After Signup.
</ParamField>

<ParamField body="ProductId" type="integer">
  Product Id.
</ParamField>

<ParamField body="SurveyId" type="integer">
  Survey Id.
</ParamField>

<ParamField body="DaysAfterRenewal" type="integer">
  Days After Renewal.
</ParamField>

<ParamField body="DaysBeforeRenewal" type="integer">
  Days Before Renewal.
</ParamField>

<ParamField body="Email" type="string">
  Email.
</ParamField>

<ParamField body="CannedResponseId" type="integer">
  Canned Response Id.
</ParamField>

<ParamField body="NextProcessTime" type="string">
  Next Process Time.
</ParamField>

<ParamField body="Resources" type="integer[]">
  Resources.
</ParamField>

<ParamField body="OnlySendToTeamPayingMembers" type="boolean">
  Only Send To Team Paying Members.
</ParamField>

<ParamField body="OnlySendToActiveCoworkers" type="boolean">
  Only Send To Active Coworkers.
</ParamField>

<ParamField body="BlockingPeriodMinutes" type="integer">
  Blocking Period Minutes.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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
  }'
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the creation.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the newly created record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the reminder was created successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "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": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 400

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}
```