PUT/schedule/{schedule_id}
This method updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template.
Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleTemplates method), to find out which fields are required or optional. If you do not know the scheduleTemplateId, call the getSchedule method to find out.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| schedule_id | string | This path parameter is the unique identifier of the schedule being updated. Use the getSchedules method to retrieve schedule IDs. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This header indicates the format of the request body provided by the client. Its value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
OAuth scope
This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope/sell.inventory
https://api.ebay.com/oauth/api_scope/sell.fulfillment
https://api.ebay.com/oauth/api_scope/sell.marketing
https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly
https://api.ebay.com/oauth/api_scope/sell.analytics.readonly
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| preferredTriggerDayOfMonth | integer | The preferred day of the month to trigger the schedule. This field can be used with preferredTriggerHour for monthly schedules. The last day of the month is used for numbers larger than the actual number of days in the month. Occurrence: Conditional |
| preferredTriggerDayOfWeek | DayOfWeekEnum | The preferred day of the week to trigger the schedule. This field can be used with preferredTriggerHour for weekly schedules. Occurrence: Conditional |
| preferredTriggerHour | string | The preferred two-digit hour of the day to trigger the schedule. Occurrence: Conditional |
| scheduleEndDate | string | The timestamp on which the schedule (report generation) ends. After this date, the schedule status becomes Occurrence: Conditional |
| scheduleName | string | The schedule name assigned by the user for the created schedule. Occurrence: Optional |
| scheduleStartDate | string | The timestamp to start generating the report. After this timestamp, the schedule status becomes active until either the scheduleEndDate occurs or the scheduleTemplateId becomes inactive. Occurrence: Conditional |
| schemaVersion | string | The schema version of a schedule. Occurrence: Required |
Output
HTTP response headers
This call has no response headers.
Response payload
This call has no payload.
Response fields
This call has no field definitions.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 204 | No Content |
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 160001 | API_FEED | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 160002 | API_FEED | REQUEST | The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. |
| 160034 | API_FEED | REQUEST | The '{fieldName}' is invalid, missing, or not allowed. |
| 160036 | API_FEED | REQUEST | The '{fieldName}' is in past. |
| 160037 | API_FEED | REQUEST | The 'scheduleEndDate' is before 'scheduleStartDate'. |
| 160038 | API_FEED | REQUEST | The schedule id {schedule_id} does not exist. |
| 160040 | API_FEED | BUSINESS | The 'scheduleTemplateId' is inactive. You cannot create or modify a schedule with an inactive 'scheduleTemplateId'. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Update a Schedule
This call updates the subscription (schedule) to the specified schedule template.
Input
The input is the schedule_id path parameter and the payload containing the following updates to the schedule:
- Name of the schedule for user reference:
My schedule - Preferred trigger hour of 11:00 AM UTC:
11Z - Preferred trigger day of the 2nd day of the month:
2 - Schema version:
941 - Schedule start date of October 1, 2020 at 12:00 PM UTC:
2020-10-01T12Z
PUThttps://api.ebay.com/sell/feed/v1/schedule/10-1***7-1******0
Output
The output is an HTTP status. If the call is successful, the schedule ID is returned in the Location response header. This method has no response payload.