# WhatsApp Business Account - Schedules API | Developer Documentation

<div id="bkmrk-whatsapp-business-ac"><div><div>## WhatsApp Business Account - Schedules API

<div><div><div><span>Copy for LLM</span></div></div><div>[<span>View as Markdown</span>](/books/meta-whatsapp/page/whatsapp-business-account-schedules-api-developer-documentation)</div></div></div><div><div>Version</div></div><div><div><div><div><div><div><span><span>API for managing WhatsApp Business Account schedules and scheduling configurations.</span></span></div></div><div><div><span><span>This endpoint allows businesses to manage scheduling functionality for their WhatsApp Business Account,</span></span></div></div><div><div><span><span>including retrieving existing schedules and creating new scheduling configurations for automated messaging,</span></span></div></div><div><div><span><span>business hours, and other time-based operations.</span></span></div></div></div></div></div></div></div><div><div>---

<div><div><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwaba"><div id="bkmrk-get-%2F%7Bversion%7D%2F%7Bwaba-1"><div>### GET /{Version}/{WABA-ID}/schedules

</div></div></div><div><div><div><div><div><div><span><span>Retrieve all schedules associated with a WhatsApp Business Account, including their</span></span></div></div><div><div><span><span>configuration, status, and execution details.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>List all schedules in a WhatsApp Business Account</span></span></div><div><span><span>Monitor schedule status and performance</span></span></div><div><span><span>Check schedule configuration and timing details</span></span></div><div><span><span>Retrieve schedule execution history and metrics</span></span></div><div><div><span><span>Filtering:</span></span></div></div><div><div><span><span>You can filter results using the </span></span>`<span><span>filtering</span></span>`<span><span> parameter with JSON-encoded filter conditions.</span></span></div></div><div><div><span><span>Supported filters include status, schedule\_type, and is\_active.</span></span></div></div><div><div><span><span>Sorting:</span></span></div></div><div><div><span><span>Results can be sorted by created\_time or updated\_time in ascending or descending order.</span></span></div></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Schedule data can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><span>Try it</span></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div><div><span>Header Parameters</span>---

<div><div><span>User-Agent</span><span>string</span></div><div><div><div><div><div><div><span><span>The user agent string identifying the client software making the request.</span></span></div></div></div></div></div></div></div><div><div><span>Authorization</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.</span></span></div></div></div></div></div></div></div></div><div><span>Path Parameters</span>---

<div><div><span>Version</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Graph API version to use for this request. Determines the API behavior and available features.</span></span></div></div></div></div></div></div></div><div><div><span>WABA-ID</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account ID. This ID can be found in your WhatsApp Manager</span></span></div></div><div><div><span><span>or through the business management APIs.</span></span></div></div></div></div></div></div></div></div><div><span>Query Parameters</span>---

<div><div><span>fields</span><span>string</span></div><div><div><div><div><div><div><span><span>Comma-separated list of fields to include in the response. If not specified,</span></span></div></div><div><div><span><span>default fields will be returned. Available fields include: id, name, status,</span></span></div></div><div><div><span><span>schedule\_type, description, start\_time, end\_time, timezone, days\_of\_week,</span></span></div></div><div><div><span><span>created\_time, updated\_time, is\_active, recurrence\_pattern</span></span></div></div></div></div></div></div></div><div><div><span>filtering</span><span>string</span></div><div><div><div><div><div><div><span><span>JSON-encoded array of filter conditions. Each filter should specify field, operator, and value.</span></span></div></div><div><div><span><span>Supported fields: status, schedule\_type, is\_active</span></span></div></div></div></div></div></div></div><div><div><span>sort</span><span>One of "created\_time.asc", "created\_time.desc", "updated\_time.asc", "updated\_time.desc"</span></div><div><div><div><div><div><div><span><span>Sort field and direction. Format: field\_name.asc or field\_name.desc</span></span></div></div><div><div><span><span>Supported fields: created\_time, updated\_time</span></span></div></div></div></div></div></div></div><div><div><span>limit</span><span>integer \[min: 1, max: 100\]</span></div><div><div><div><div><div><div><span><span>Maximum number of schedules to return per page</span></span></div></div></div></div></div></div></div><div><div><span>after</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor for pagination - retrieve records after this cursor</span></span></div></div></div></div></div></div></div><div><div><span>before</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor for pagination - retrieve records before this cursor</span></span></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Retrieve all schedules associated with a WhatsApp Business Account, including their</span></span></div></div><div><div><span><span>configuration, status, and execution details.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>List all schedules in a WhatsApp Business Account</span></span></div><div><span><span>Monitor schedule status and performance</span></span></div><div><span><span>Check schedule configuration and timing details</span></span></div><div><span><span>Retrieve schedule execution history and metrics</span></span></div><div><div><span><span>Filtering:</span></span></div></div><div><div><span><span>You can filter results using the </span></span>`<span><span>filtering</span></span>`<span><span> parameter with JSON-encoded filter conditions.</span></span></div></div><div><div><span><span>Supported filters include status, schedule\_type, and is\_active.</span></span></div></div><div><div><span><span>Sorting:</span></span></div></div><div><div><span><span>Results can be sorted by created\_time or updated\_time in ascending or descending order.</span></span></div></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Standard Graph API rate limits apply. Use appropriate retry logic with exponential backoff.</span></span></div></div><div><div><span><span>Caching:</span></span></div></div><div><div><span><span>Schedule data can be cached for short periods, but status information may change</span></span></div></div><div><div><span><span>frequently. Implement appropriate cache invalidation strategies.</span></span></div></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Successfully retrieved WhatsApp Business Account schedules</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>WhatsAppBusinessAccountSchedulesConnection</span></div><div><div><div id="bkmrk-show-child-attribute"><div><span>Show child attributes</span></div></div><div id="bkmrk-whatsappbusinessacco"><div>---

<div><span>WhatsAppBusinessAccountSchedulesConnection</span></div><div>---

<div><div><span>data</span><span>array of WhatsAppBusinessAccountSchedule</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Array of schedule records</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-1"><div><span>Show child attributes</span></div></div><div id="bkmrk-data%5B%5Dwhatsappbusine"><div><div>---

<div><div><span>data\[\]</span><span>WhatsAppBusinessAccountSchedule</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account schedule configuration and details</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-2"><div><span>Show child attributes</span></div></div><div id="bkmrk-idstring%C2%B7requireduni"><div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable name for the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>status</span><span>WhatsAppScheduleStatus</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Current status of the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>schedule\_type</span><span>WhatsAppScheduleType</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Type of schedule configuration</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>description</span><span>string</span></div><div><div><div><div><div><div><span><span>Optional description of the schedule purpose</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>start\_time</span><span>string (time)</span></div><div><div><div><div><div><div><span><span>Schedule start time in HH:MM format</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>end\_time</span><span>string (time)</span></div><div><div><div><div><div><div><span><span>Schedule end time in HH:MM format</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timezone</span><span>string</span></div><div><div><div><div><div><div><span><span>Timezone identifier for the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>days\_of\_week</span><span>array of DayOfWeek</span></div><div><div><div><div><div><div><span><span>Days of the week when the schedule is active</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-3"><div><span>Show child attributes</span></div></div><div id="bkmrk-days_of_week%5B%5Ddayofw"><div><div>---

<div><div><span>days\_of\_week\[\]</span><span>DayOfWeek</span></div><div><div><div><div><div><div><span><span>Day of the week</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>created\_time</span><span>string (date-time)</span></div><div><div><div><div><div><div><span><span>ISO 8601 timestamp when the schedule was created</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>updated\_time</span><span>string (date-time)</span></div><div><div><div><div><div><div><span><span>ISO 8601 timestamp when the schedule was last updated</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_active</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Whether the schedule is currently active</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>recurrence\_pattern</span><span>RecurrencePattern</span></div><div><div><div><div><div><div><span><span>Pattern for recurring schedules</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-4"><div><span>Show child attributes</span></div></div><div id="bkmrk-frequencyone-of-%22dai"><div><div>---

<div><div><span>frequency</span><span>One of "DAILY", "WEEKLY", "MONTHLY", "YEARLY"</span></div></div></div><div>---

<div><div><span>interval</span><span>integer \[min: 1\]</span></div><div><div><div><div><div><div><span><span>Interval between recurrences</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>end\_date</span><span>string (date)</span></div><div><div><div><div><div><div><span><span>End date for the recurrence pattern</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>paging</span><span>CursorPaging</span></div><div><div><div><div><div><div><span><span>Cursor-based pagination information</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-5"><div><span>Show child attributes</span></div></div><div id="bkmrk-cursorsobjectshow-ch"><div><div>---

<div><div><span>cursors</span><span>object</span></div></div><div><div><div id="bkmrk-show-child-attribute-6"><div><span>Show child attributes</span></div></div><div id="bkmrk-beforestringcursor-p"><div><div>---

<div><div><span>before</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor pointing to the start of the page</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>after</span><span>string</span></div><div><div><div><div><div><div><span><span>Cursor pointing to the end of the page</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>previous</span><span>string</span></div><div><div><div><div><div><div><span><span>URL for the previous page of results</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>next</span><span>string</span></div><div><div><div><div><div><div><span><span>URL for the next page of results</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>400</span><div><div><div><div><div><div><span><span>Bad Request - Invalid parameters or malformed request</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-7"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-8"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>401</span><div><div><div><div><div><div><span><span>Unauthorized - Invalid or missing access token</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-9"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-1"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-10"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-1"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>403</span><div><div><div><div><div><div><span><span>Forbidden - Insufficient permissions or access denied</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-11"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-2"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-12"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-2"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>404</span><div><div><div><div><div><div><span><span>Not Found - WhatsApp Business Account ID does not exist or is not accessible</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-13"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-3"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-14"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-3"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>422</span><div><div><div><div><div><div><span><span>Unprocessable Entity - Request parameters are valid but cannot be processed</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-15"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-4"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-16"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-4"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>429</span><div><div><div><div><div><div><span><span>Too Many Requests - Rate limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-17"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-5"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-18"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-5"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>500</span><div><div><div><div><div><div><span><span>Internal Server Error - Unexpected server error</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-19"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-6"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-20"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-6"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div></div></div><div>---

<div><div><div id="bkmrk-post-%2F%7Bversion%7D%2F%7Bwab"><div id="bkmrk-post-%2F%7Bversion%7D%2F%7Bwab-1"><div>### POST /{Version}/{WABA-ID}/schedules

</div></div></div><div><div><div><div><div><div><span><span>Create a new schedule configuration within a WhatsApp Business Account. This endpoint</span></span></div></div><div><div><span><span>allows businesses to set up automated scheduling for various operations such as business hours,</span></span></div></div><div><div><span><span>automated responses, and maintenance windows.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Create business hours schedules for automated responses</span></span></div><div><span><span>Set up maintenance windows for system operations</span></span></div><div><span><span>Configure automated message campaigns with timing</span></span></div><div><span><span>Establish recurring schedule patterns for business operations</span></span></div><div><div><span><span>Prerequisites:</span></span></div></div><div><span><span>WhatsApp Business Account must have scheduling feature enabled</span></span></div><div><span><span>Appropriate permissions for schedule management</span></span></div><div><span><span>Valid timezone and time format specifications</span></span></div><div><span><span>Business must meet WhatsApp Business API requirements</span></span></div><div><div><span><span>Process Flow:</span></span></div></div><div><span><span>Submit schedule configuration with timing and recurrence details</span></span></div><div><span><span>System validates schedule parameters and conflicts</span></span></div><div><span><span>Schedule is created and activated based on is\_active flag</span></span></div><div><span><span>Monitor schedule status through GET endpoint</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Schedule creation is subject to rate limits to prevent abuse.</span></span></div></div><div><div><span><span>Standard Graph API rate limits also apply.</span></span></div></div><div><div><span><span>Validation:</span></span></div></div><div><span><span>Start time must be before end time</span></span></div><div><span><span>Timezone must be valid IANA timezone identifier</span></span></div><div><span><span>Days of week must be valid if specified</span></span></div><div><span><span>Recurrence pattern must be consistent with schedule type</span></span></div></div></div></div></div>#### Request Syntax

<div><div><div><div><div><div><span>Try it</span></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div><div><span>Header Parameters</span>---

<div><div><span>User-Agent</span><span>string</span></div><div><div><div><div><div><div><span><span>The user agent string identifying the client software making the request.</span></span></div></div></div></div></div></div></div><div><div><span>Authorization</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.</span></span></div></div></div></div></div></div></div></div><div><span>Path Parameters</span>---

<div><div><span>Version</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Graph API version to use for this request. Determines the API behavior and available features.</span></span></div></div></div></div></div></div></div><div><div><span>WABA-ID</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>WhatsApp Business Account ID where the schedule will be created.</span></span></div></div><div><div><span><span>This ID can be found in your WhatsApp Manager or through business management APIs.</span></span></div></div></div></div></div></div></div></div><div><span>Required</span>---

<div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>ScheduleCreateRequest</span></div><div><div><div id="bkmrk-show-child-attribute-21"><div><span>Show child attributes</span></div></div><div id="bkmrk-schedulecreatereques"><div>---

<div><span>ScheduleCreateRequest</span></div><div>---

<div><div><span>name</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable name for the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>schedule\_type</span><span>WhatsAppScheduleType</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Type of schedule configuration</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>description</span><span>string</span></div><div><div><div><div><div><div><span><span>Optional description of the schedule purpose</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>start\_time</span><span>string (time)</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Schedule start time in HH:MM format</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>end\_time</span><span>string (time)</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Schedule end time in HH:MM format</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>timezone</span><span>string</span></div><div><div><div><div><div><div><span><span>Timezone identifier for the schedule</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>days\_of\_week</span><span>array of DayOfWeek</span></div><div><div><div><div><div><div><span><span>Days of the week when the schedule is active</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-22"><div><span>Show child attributes</span></div></div><div id="bkmrk-days_of_week%5B%5Ddayofw-1"><div><div>---

<div><div><span>days\_of\_week\[\]</span><span>DayOfWeek</span></div><div><div><div><div><div><div><span><span>Day of the week</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_active</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Whether the schedule should be active upon creation</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>recurrence\_pattern</span><span>RecurrencePattern</span></div><div><div><div><div><div><div><span><span>Pattern for recurring schedules</span></span></div></div></div></div></div></div></div><div><div><div id="bkmrk-show-child-attribute-23"><div><span>Show child attributes</span></div></div><div id="bkmrk-frequencyone-of-%22dai-1"><div><div>---

<div><div><span>frequency</span><span>One of "DAILY", "WEEKLY", "MONTHLY", "YEARLY"</span></div></div></div><div>---

<div><div><span>interval</span><span>integer \[min: 1\]</span></div><div><div><div><div><div><div><span><span>Interval between recurrences</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>end\_date</span><span>string (date)</span></div><div><div><div><div><div><div><span><span>End date for the recurrence pattern</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>Responses</span>---

<div><div><div><div><div><div><span><span>Create a new schedule configuration within a WhatsApp Business Account. This endpoint</span></span></div></div><div><div><span><span>allows businesses to set up automated scheduling for various operations such as business hours,</span></span></div></div><div><div><span><span>automated responses, and maintenance windows.</span></span></div></div><div><div><span><span>Use Cases:</span></span></div></div><div><span><span>Create business hours schedules for automated responses</span></span></div><div><span><span>Set up maintenance windows for system operations</span></span></div><div><span><span>Configure automated message campaigns with timing</span></span></div><div><span><span>Establish recurring schedule patterns for business operations</span></span></div><div><div><span><span>Prerequisites:</span></span></div></div><div><span><span>WhatsApp Business Account must have scheduling feature enabled</span></span></div><div><span><span>Appropriate permissions for schedule management</span></span></div><div><span><span>Valid timezone and time format specifications</span></span></div><div><span><span>Business must meet WhatsApp Business API requirements</span></span></div><div><div><span><span>Process Flow:</span></span></div></div><div><span><span>Submit schedule configuration with timing and recurrence details</span></span></div><div><span><span>System validates schedule parameters and conflicts</span></span></div><div><span><span>Schedule is created and activated based on is\_active flag</span></span></div><div><span><span>Monitor schedule status through GET endpoint</span></span></div><div><div><span><span>Rate Limiting:</span></span></div></div><div><div><span><span>Schedule creation is subject to rate limits to prevent abuse.</span></span></div></div><div><div><span><span>Standard Graph API rate limits also apply.</span></span></div></div><div><div><span><span>Validation:</span></span></div></div><div><span><span>Start time must be before end time</span></span></div><div><span><span>Timezone must be valid IANA timezone identifier</span></span></div><div><span><span>Days of week must be valid if specified</span></span></div><div><span><span>Recurrence pattern must be consistent with schedule type</span></span></div></div></div></div></div><div><span>200</span><div><div><div><div><div><div><span><span>Successfully created schedule</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>ScheduleCreateResponse</span></div><div><div><div id="bkmrk-show-child-attribute-24"><div><span>Show child attributes</span></div></div><div id="bkmrk-schedulecreaterespon"><div>---

<div><span>ScheduleCreateResponse</span></div><div>---

<div><div><span>id</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Unique identifier for the created schedule</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>400</span><div><div><div><div><div><div><span><span>Bad Request - Invalid parameters or malformed request</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-25"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-7"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-26"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-7"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>401</span><div><div><div><div><div><div><span><span>Unauthorized - Invalid or missing access token</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-27"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-8"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-28"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-8"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>403</span><div><div><div><div><div><div><span><span>Forbidden - Insufficient permissions or schedule limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-29"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-9"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-30"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-9"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>404</span><div><div><div><div><div><div><span><span>Not Found - WhatsApp Business Account ID does not exist or is not accessible</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-31"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-10"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-32"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-10"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>409</span><div><div><div><div><div><div><span><span>Conflict - Schedule name already exists or time conflict</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-33"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-11"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-34"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-11"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>422</span><div><div><div><div><div><div><span><span>Unprocessable Entity - Request parameters are valid but cannot be processed</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-35"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-12"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-36"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-12"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>429</span><div><div><div><div><div><div><span><span>Too Many Requests - Rate limit exceeded</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-37"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-13"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-38"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-13"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><span>500</span><div><div><div><div><div><div><span><span>Internal Server Error - Unexpected server error</span></span></div></div></div></div></div></div><div><div><span>Content Type: </span><span>application/json</span></div><div><div><span>Schema: </span><span>GraphAPIError</span></div><div><div><div id="bkmrk-show-child-attribute-39"><div><span>Show child attributes</span></div></div><div id="bkmrk-graphapierrorerrorob-14"><div>---

<div><span>GraphAPIError</span></div><div>---

<div><div><span>error</span><span>object</span><span>·</span><span>required</span></div></div><div><div><div id="bkmrk-show-child-attribute-40"><div><span>Show child attributes</span></div></div><div id="bkmrk-messagestring%C2%B7requir-14"><div><div>---

<div><div><span>message</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Human-readable error message</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>type</span><span>string</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Error category type</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>code</span><span>integer</span><span>·</span><span>required</span></div><div><div><div><div><div><div><span><span>Numeric error code</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_subcode</span><span>integer</span></div><div><div><div><div><div><div><span><span>More specific error subcode when available</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>fbtrace\_id</span><span>string</span></div><div><div><div><div><div><div><span><span>Unique identifier for debugging and support requests with Meta</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>is\_transient</span><span>boolean</span></div><div><div><div><div><div><div><span><span>Indicates whether this error is temporary and the request should be retried</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_title</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error title for display purposes</span></span></div></div></div></div></div></div></div></div><div>---

<div><div><span>error\_user\_msg</span><span>string</span></div><div><div><div><div><div><div><span><span>User-friendly error message for display purposes</span></span></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div>Select language</div></div></div></div>---

</div><div><div><div><div><div><div>Select status code</div></div></div></div>---

</div></div></div></div></div></div></div><div><div id="bkmrk-authentication"><div id="bkmrk-authentication-1"><div>### Authentication

</div></div></div><div><table><tbody><tr><td><div>**Scheme**</div></td><td><div>**Type**</div></td><td><div>**Location**</div></td></tr><tr><td><div><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>HTTP Bearer</span></span></div></div></div></div></div></div></div></td><td><div><div><div><div><div><div><div><span><span>Header: </span></span>`<span><span>Authorization</span></span>`</div></div></div></div></div></div></div></td></tr></tbody></table>

</div><div>#### Usage Examples

<div><span>bearerAuth:</span><div><div><div><div><div><div><span><span>Include </span></span>`<span><span>Authorization: Bearer your-token-here</span></span>`<span><span> in request headers</span></span></div></div></div></div></div></div></div></div><div>#### Global Authentication Requirements

<div><span>All endpoints require:</span><div><div><div><div><div><div><span><span>bearerAuth</span></span></div></div></div></div></div></div></div></div></div></div>