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:
- Germany (EBAY_DE)
- Canada (EBAY_CA)
- Australia (EBAY_AU)
- United States (EBAY_US)
- France (EBAY_FR)
For details on header values, see HTTP request headers.
Servers
- https://api.ebay.com{basePath}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
custom_policy_id |
String | Yes |
This path parameter is the unique custom policy identifier for the policy to be returned. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-EBAY-C-MARKETPLACE-ID |
String | Yes |
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.
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace. |
description |
String | No |
Details of the seller's specific policy and terms for this policy. |
label |
String | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.