PATCH /api/v2/message/schedule/{id}
Updates an existing scheduled message.
All fields are optional - only provided fields will be updated.
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. |
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. |
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.