PATCH /api/v2/message/schedule/{id}
Updates an existing scheduled message. Supports partial updates.
Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics.
Added on Dec 5, 2025 for API v2.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The schedule's ID (key string). |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
timezone |
Null | No |
Timezone name (e.g., 'America/Los_Angeles'). |
start_date |
Integer | No |
Unix timestamp for when to send the message. |
text |
Null | No |
The message text content. |
media |
Null | No |
Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
channel_hashtag |
Null | No |
[single-line only] The hashtag of the channel which the message is scheduled for. |
from_number |
Null | No |
The personal phone number to use as the sender (must belong to the user). |
to_numbers[] |
Array | No |
List of phone numbers to schedule to send messages to. |
user_id |
Integer | No |
The ID of the user who should be the sender. If not provided, defaults to the authenticated user. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.