1. Tasks API
Hatif
  • Rate Limiting
  • Account API
    • Service Login
  • Channels API
    • Get Channels
  • Support API
    • Upload Image, Video, or PDF
    • Upload Audio File
  • Whatsapp API
    • Send Text
    • Send Template
    • Send Image
    • Send Audio
    • Send Video
    • Send File
    • Send Interactive Buttons
    • List Templates (Service Account)
  • Contact
    • Set Property Value on Contact
    • Search Contacts
    • Delete Property Value on Contact
    • Create Contact
    • Update Contact
    • Get Contacts
    • Get Contact By Id
    • Create Bulk Contacts vCards
    • Contacts History
  • Contact Properties
    • List Contact Properties
    • Contact Properties Statistics
    • Create Contact Property
    • Update Contact Property
    • Delete Contact Property
  • Workspace API
    • Get Workspace Users
  • Conversations API
    • Get Conversation Timeline
    • List Conversations
    • Create Conversation
    • Assign Conversation
    • Get Conversation
    • Assign Conversation
  • Tags API
    • Tag a conversation
    • Create Tag
    • Delete Tag
    • Update Tag
    • List Tags
  • Outbound IVR
    • Create Outbound IVR
    • Get Outbound IVR Request
  • Outbound IVR Flows
    • Create Outbound IVR Flow
    • List Outbound IVR Flows
    • Get Outbound IVR Flow
    • Update Outbound IVR Flow
    • Delete Outbound IVR Flow
  • Tasks API
    • Create Task
      POST
    • List Tasks
      GET
    • Get Task
      GET
    • Update Task
      PUT
    • Delete Task
      DELETE
    • List Task Properties
      GET
    • Create Task Property
      POST
    • List Task Projects
      GET
    • Create Task Project
      POST
    • Get Task Project
      GET
    • Rename Task Project
      PUT
    • Delete Task Project
      DELETE
    • List Task Sections
      GET
    • Create Task Section
      POST
    • List Tasks By Conversation
      GET
    • Move Task
      POST
    • Schedule Task
      POST
    • Assign Task
      POST
    • Set Task Due Date
      POST
    • Complete Task
      POST
    • Reopen Task
      POST
    • Set Task Section
      PUT
    • Move Task Project
      POST
    • Rename Task Section
      PUT
    • Delete Task Section
      DELETE
    • Move Task Section
      POST
    • Update Task Property
      PUT
    • Delete Task Property
      DELETE
    • Set Task Property Value
      PUT
    • List Task Comments
      GET
    • Create Task Comment
      POST
    • Edit Task Comment
      PUT
    • Delete Task Comment
      DELETE
    • Set Task Reminder
      POST
  • Teams API
    • Create Team
    • Get Team
    • Update Team
    • Delete Team
    • Add Team Members
    • Update Team Member Conversation Access
    • Remove Team Member
    • List Teams
    • List Team Member Options
    • List Team Assignment Targets
    • Assign Conversation to Team
  • Partner API
    • 2. Register customer
      • 1) Create registration
      • Update registration details
      • Resend mobile code
      • 2) Verify mobile code
      • 3) Send email code
      • 4) Verify email code
      • 5) Complete registration → workspace + workspace key
      • Issue another workspace key
    • 3. Subscribe (plan & balance)
      • Add wallet balance (top-up) → payment link
      • Plans you can sell (find the Builder plan ID)
      • Get wallet balance
      • Create quote (plan) → payment link
      • Get quote status (poll for payment)
    • 4. Phone number
      • Assign number (after payment)
      • Available numbers
      • List the workspace's channels
    • 5. Contract
      • Replaced: use Get activation link
      • Replaced: number status is on the channel
      • Get activation link
    • 6. AI agent (SIP)
      • Connect the number to your AI agent
      • Disconnect your AI agent
    • 7. Calls & events
      • Not available yet: list calls
      • Not available yet: set events webhook
  • Call Webhook
  • WhatsApp Message Webhook
  • Schemas
    • Call Webhook
    • WhatsApp Message Webhook
    • ServiceAccountTemplateDto
    • OutboundIvrOption
    • ConversationDto
    • RegistrationDetails
    • CreateTagDto
    • AbpError
    • ServiceAccountTemplateParameterDto
    • OutboundIvrQuestionStepProps
    • ChannelConversationDto
    • UpdateTagDto
    • TaskPropertyValue
    • CreateRegistration
    • ServiceAccountCreateTaskDto
    • TemplateParameterDto
    • OutboundIvrStep
    • OtpCode
    • TagDto
    • PagedResultOfTagDto
    • TaskActivityPropertySnapshot
    • ConversationTimelineDto
    • ApiCredential
    • ParameterValueDto
    • CreateOutboundIvrRequest
    • TaskActivitySnapshot
    • SaveOutboundIvrFlow
    • ChannelNotFoundError
    • OutboundIvrFlow
    • Quote
    • AiSummaryDto
    • TaskActivityDto
    • ReplyInfoDto
    • OutboundIvrAnswer
    • TaskSummaryDto
    • InternalThreadDto
    • OutboundIvrStatus
    • TaskDto
    • LocationMessageDto
    • OutboundIvrResult
    • PagedResultOfTaskDto
    • AssignationInfoDto
    • TaskPropertyDefinitionDto
    • PagedResultOfConversationDto
    • OutboundIvrAudioType
    • OutboundIvrRequest
    • PagedResultOfConversationTimelineDto
    • TaskProjectDto
    • TaskSectionDto
    • OutboundIvrWebhookPayload
    • PagedResultOfTaskProjectDto
    • PagedResultOfTaskSectionDto
    • UpdateTaskDto
    • MoveTaskDto
    • SetTaskSectionDto
    • SetTaskScheduleDto
    • AssignTaskDto
    • SetTaskDueDateDto
    • NameDto
    • MoveBeforeDto
    • TaskPropertyOptionDto
    • CreateTaskPropertyDto
    • UpdateTaskPropertyDto
    • TaskCommentDto
    • WriteTaskCommentDto
    • PagedResultOfTaskCommentDto
    • SetTaskReminderDto
  1. Tasks API

Set Task Reminder

POST
/v1/tasks/service-account/{id}/reminder
Sets or clears the reminder for the task's assignee. The assignee gets the in-app reminder notification at dueAtUtc − reminderOffsetMinutes, exactly as if they had set it themselves.
The task needs an assignee and a due date, otherwise 400.
The reminder time must still be in the future.
Changing the assignee later clears the reminder; changing the due date moves it.
Clearing with null always works.
Permissions: a service account owns no task, so it acts with manage any task rights on every task in its workspace, shared or private. Its changes appear in task history as actorType: serviceAccount.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
The task, with reminderOffsetMinutes and reminderAtUtc filled in.
Bodyapplication/json

🟠400Validation Error
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.voxa.sa/v1/tasks/service-account//reminder' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reminderOffsetMinutes": 60
}'
Response Response Example
200 - Success Example
{
    "id": "3a1ebef0-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "title": "Call back about the renewal quote",
    "description": "Customer asked for the 12-month price.",
    "status": "open",
    "priority": "p2",
    "visibility": "shared",
    "assigneeUserId": "3a1d0c11-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "assigneeName": "Sara",
    "dueAtUtc": "2026-10-22T09:00:00Z",
    "isOverdue": false,
    "scheduledAtUtc": null,
    "durationMinutes": null,
    "reminderOffsetMinutes": null,
    "reminderAtUtc": null,
    "reminderNotifiedAtUtc": null,
    "projectId": null,
    "sectionId": null,
    "parentTaskId": null,
    "position": 1024,
    "childCount": 0,
    "conversationId": null,
    "conversationEventId": null,
    "contactId": "3a1c9f20-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "contactName": "Ahmed Ali",
    "attachments": [],
    "properties": [],
    "creatorId": null,
    "creatorName": null,
    "agentId": null,
    "creationTime": "2026-10-20T10:00:00Z",
    "completedAtUtc": null,
    "subtasks": {
        "totalCount": 0,
        "items": []
    },
    "activities": null
}
Modified at 2026-10-21 14:06:21
Previous
Delete Task Comment
Next
Create Team
Built with