Create a Reminder

Reminders can only be scheduled up to 30 days in advance. If you attempt to create a reminder with a timestamp beyond this limit, the request will be rejected with a validation error. Please ensure all reminders are set within the allowed scheduling window.

Create a reminder

post

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

agentIdstringRequired

Body

application/json

purposestringRequired

contextstringOptional

timestampnumberRequired

metadataobjectOptional

customerIdstringOptional

opportunityIdstringOptional

Responses

200

Reminder created successfully

application/json

This an object representing a reminder.

idstringRequired

purposestringRequired

contextstringOptional

timestampnumberRequired

When the reminder is due

statusstring · enumRequiredPossible values:

metadataobjectOptional

taskIdstringRequired

customerIdstring · nullableOptional

opportunityIdstring · nullableOptional

createdAtstring · date-timeRequired

When the reminder was created

updatedAtstring · date-timeRequired

When the reminder was last updated

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/v1/agents/{agentId}/reminders

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/reminders HTTP/1.1
Host: api.voxity.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "purpose": "text",
  "context": "text",
  "timestamp": 1,
  "metadata": {},
  "customerId": "text",
  "opportunityId": "text"
}

{
  "id": "text",
  "purpose": "text",
  "context": "text",
  "timestamp": 1,
  "status": "pending",
  "metadata": {},
  "taskId": "text",
  "customerId": "text",
  "opportunityId": "text",
  "createdAt": "2026-04-02T08:31:06.990Z",
  "updatedAt": "2026-04-02T08:31:06.990Z"
}

Note: Both customerId and opportunityId are optional parameters. However, when provided:

• If customerId is provided, it must belong to an existing customer

• If opportunityId is provided, it must belong to an existing opportunity

• If both are provided, the opportunity must belong to the specified customer