updateCustomPolicy

v1.0.0

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 .

Input

{
  "type": "object",
  "properties": {
    "X-EBAY-C-MARKETPLACE-ID": {
      "type": "string"
    },
    "custom_policy_id": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "Details of the seller's specific policy and terms for this policy.<br/><br/><b>Max length:</b> 15,000"
    },
    "label": {
      "type": "string",
      "description": "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.<br/><br/><b>Max length:</b> 65"
    },
    "name": {
      "type": "string",
      "description": "The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace.<br /><span class=\"tablenote\"><strong>Note:</strong> This field is visible only to the seller. </span><br/><br/><b>Max length:</b> 65"
    }
  },
  "required": [
    "X-EBAY-C-MARKETPLACE-ID",
    "custom_policy_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}