Skip to content
API PlatformDevelopers
POST/v1/conversations/{conversation_id}/remindersbeta

Set a reminder

Needs
Manage conversations: notes, assign, close, tags, reminders (inbox:write)
Plan
Any plan with API access
Limits
60 a minute per key
Dry run
Yes — every check runs with ?dry_run=true, nothing changes
Undo
Reminders can be deleted in the inbox.

Schedules a reminder on a conversation for your team, e.g. "follow up on the quote" tomorrow at 10:00. At that time the inbox notifies your team. Nothing is sent to the customer.

remind_at is an ISO-8601 date-time with a timezone: 2026-10-02T10:00:00+04:00 or 2026-10-02T06:00:00Z. It must be in the future (at least 30 seconds from now). The answer gives the time in UTC.

Try it

Path

The conversation id.

Body

When to remind: ISO-8601 with a timezone offset or `Z`, in the future.

What the reminder is about (1–1000 characters, staff only).

Protects against doing it twice if you retry: a retry with the same key gets the first answer back instead of running again.

Test mode (dry run): nothing will change
Turns test mode off for this page only. It switches back when you leave the page.

Code and response

curl -X POST 'https://mcp.wa-api.cloud/v1/conversations/77410/reminders?dry_run=true' \
  -H "Authorization: Bearer $API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "remind_at": "2026-10-02T10:00:00+04:00",
  "note": "Follow up on the quote for 20 units."
}'

The code reads your key from $API_KEY.

Parameters

Parameters
FieldTypeWhat it is
conversation_idrequiredstring · pathThe conversation id.pattern ^\d{1,19}$Signed in? Pick one from your data with “My data”.

Body

Body fields
FieldTypeWhat it is
remind_atrequiredstringWhen to remind: ISO-8601 with a timezone offset or Z, in the future.date-time · pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
noterequiredstringWhat the reminder is about (1–1000 characters, staff only).1–1000 characters

Headers

Headers
FieldTypeWhat it is
AuthorizationrequiredheaderBearer $API_KEY — your API key.
Api-VersionheaderThe API version to use, e.g. 2026-10-01. Default: the version your key is pinned to.one of: 2026-10-01 · pattern ^\d{4}-\d{2}-\d{2}$
Idempotency-KeyrequiredheaderRequired here. Any unique string (8–128 characters), e.g. your order id plus the step. Kept 24 hours. Not needed with dry_run=true.pattern ^[A-Za-z0-9._:-]+$ · 8–128 characters

Response 201

The reminder was set.

Response fields
FieldTypeWhat it is
reminder_idrequiredstring
conversation_idrequiredstring
remind_atrequiredstring
dry_runbooleantrue when this was a dry run: every check ran and nothing changed.

Errors

Errors are application/problem+json. Branch on code.

StatusCodeWhen
400invalid_input

A field is missing or has the wrong format. errors[] points at each field. remind_at has no timezone, or is not in the future. Also returned when the Idempotency-Key header is missing, or was used before with a different body.

401unauthenticated

The Authorization header is missing, the key is unknown, expired or revoked.

403entitlement_required

The workspace's plan does not include API access (api_access).

403insufficient_scope

The key does not have the permission this operation needs.

404not_found

No conversation with this id.

409conflict

Also returned while a request with the same Idempotency-Key is still running.

429rate_limited

The key or workspace went over its rate limit. Wait for Retry-After seconds.

503upstream_unavailable

A service behind the API is briefly unavailable. Safe to retry with backoff.

504timeout

The change did not finish in time. Retry with the same Idempotency-Key: it never runs twice.

Examples

Follow up on a quote tomorrow morning

Request body

{
  "remind_at": "2026-10-02T10:00:00+04:00",
  "note": "Follow up on the quote for 20 units."
}

Response 201

{
  "reminder_id": "01J9ZK4QF7T3R8M2XW6N5B1C0D",
  "conversation_id": "77410",
  "remind_at": "2026-10-02T06:00:00.000Z"
}

Operation path

The same operation is also at POST /v1/ops/inbox_create_reminder, with every field in the JSON body.