PUT/custom_policy/{custom_policy_id}
This method updates an existing custom policy specified by the custom_policy_id path parameter for the selected marketplace. This method overwrites the policy's Name, Label, and Description fields. Therefore, the complete, current text of all three policy fields must be included in the request payload even when one or two of these fields will not actually be updated.
For example, the value for the Label field is to be updated, but the Name and Description values will remain unchanged. The existing Name and Description values, as they are defined in the current policy, must also be passed in.
A successful policy update call returns an HTTP status code of 204 No Content.
Note: The following eBay marketplaces support Custom Policies:
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) later in 2023. When this change occurs, a seller will be able to apply any custom policy to listings on any eBay marketplace where they sell, and the X-EBAY-C-MARKETPLACE-ID request header will no longer be relevant.
For details on header values, see HTTP request headers.
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 |
|---|---|---|
| custom_policy_id | string | This path parameter is the unique custom policy identifier for the policy to be returned. Note: This value is automatically assigned by the system when the policy is created. 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. It's value should be set to application/json. For more information, refer to HTTP request headers. Occurrence: Required |
| X-EBAY-C-MARKETPLACE-ID | string | This header parameter specifies the eBay marketplace for the custom policy that is being created. Supported values for this header can be found in the MarketplaceIdEnum type definition. Note: The following eBay marketplaces support Custom Policies:
Important!As a part of Digital Services Act (DSA) requirements, all custom policies will become global (and no longer marketplace-specific) later in 2023. A seller will be able to apply any custom policy to listings on any eBay marketplace where they sell. 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.account
eBayUser
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| description | string | Details of the seller's specific policy and terms for this policy. Occurrence: Required |
| label | string | Customer-facing label shown on View Item pages for items to which the policy applies. This seller-defined string is displayed as a system-generated hyperlink pointing to detailed policy information. Occurrence: Required |
| name | string | The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace. 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 |
| 404 | Not Found |
| 409 | Policy Name already used/ Maximum no of policies per site reached |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 20412 | API_ACCOUNT | REQUEST | Invalid/Missing label |
| 20413 | API_ACCOUNT | REQUEST | Invalid/Missing name |
| 20414 | API_ACCOUNT | REQUEST | Invalid/Missing description |
| 20415 | API_ACCOUNT | REQUEST | Invalid/Missing marketplaceId |
| 20416 | API_ACCOUNT | REQUEST | Invalid/Missing customPolicyId |
| 20418 | API_ACCOUNT | REQUEST | This policy name is already used |
| 20500 | API_ACCOUNT | APPLICATION | System error. |
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 Custom Policy
This sample demonstrates how to update a take-back custom policy.
Input
With an update method, the existing policy to update is specified with the custom_policy_id path parameter. All fields of the request payload (description, label, and name) must be passed in, even if one or two of them are not changing.
For this particular sample, only the name field is being updated, but the current values of description and label for the existing policy still must be passed in.
This method also requires you to specify the eBay marketplace ID using the X-EBAY-C-MARKETPLACE-ID HTTP header.
PUThttps://api.ebay.com/sell/account/v1/custom_policy/2********4
Output
A successful call returns an HTTP status code of 204 No Content. There is no response payload.