Update scheduled pin
update_scheduleDestructiveIdempotent
Edit a pending schedule in place: time, board, text or media.
Use to fix a wrong run_at, board, title or link on a schedule that has
not started publishing, instead of cancel_schedule plus
create_schedule; the id and history are kept. Once the schedule has
run its pin is published and can no longer be edited; for a failed one
use retry_schedule. Pass at least one field.
Returns the updated schedule, still in status "scheduled". A new board
is preflighted like create_schedule. Fails with not_found for an
unknown id, schedule_not_editable (409) once publishing started, with a
remediation naming the right tool, validation_error for a past or
timezone-less run_at, and sandbox_board_fixed when changing the board
of a sandbox schedule.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | Pin title, at most 100 characters. | |
| run_at | No | New publish time, ISO 8601 with timezone, in the future. | |
| asset_id | No | Replace the media with this uploaded asset (drops any image_url). | |
| board_id | No | Pinterest board ID (numeric string), from list_boards. | |
| link_url | No | Destination URL opened when the pin is clicked. | |
| image_url | No | Replace the media with this public URL (drops any asset_id). | |
| description | No | Pin description, at most 800 characters. | |
| schedule_id | Yes | UUID of the schedule, from list_schedules or create_schedule. | |
| cover_image_url | No | Public cover image URL; video pins only. | |
| cover_image_asset_id | No | Uploaded image asset UUID used as the video cover. |