API · Emails

Update Email

Reschedule an email that has not been released for delivery (requires full access). Returns the email ID, or a 422 error if delivery has already started.

PATCH/emails/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.
`scheduled_at` body · required	`string`	Future send time in ISO 8601 or natural language, within 30 days, using UTC when no timezone is provided.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X PATCH "$OPENSEND_BASE_URL/emails/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"scheduled_at":"in 1 hour"}'

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "email",
  "id": "YOUR_ID"
}

Behavior and errors

Only scheduled messages can be changed. Once the message enters the send queue, this returns 422.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.