Skip to main content

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.

Input

Resource URI (production)

PUT https://api.ebay.com/sell/account/v1/custom_policy/{custom_policy_id}

URI parameters

ParameterTypeDescription
custom_policy_idstringThis 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.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header parameter specifies the eBay markeplace 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:
  • Germany (EBAY_DE)
  • Canada (EBAY_CA)
  • Australia (EBAY_AU)
  • United States (EBAY_US)
  • France (EBAY_FR)

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 clipboard

Request fields

Input container/fieldTypeDescription
descriptionstring

Details of the seller's specific policy and terms for this policy.

Max length: 15,000

Occurrence: Required

labelstring

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.

Max length: 65

Occurrence: Required

namestring

The seller-defined name for the custom policy. Names must be unique for policies assigned to the same seller, policy type, and eBay marketplace.
Note: This field is visible only to the seller.

Max length: 65

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.

StatusMeaning
204No Content
400Bad Request
404Not Found
409Policy Name already used/ Maximum no of policies per site reached
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
20412API_ACCOUNTREQUESTInvalid/Missing label
20413API_ACCOUNTREQUESTInvalid/Missing name
20414API_ACCOUNTREQUESTInvalid/Missing description
20415API_ACCOUNTREQUESTInvalid/Missing marketplaceId
20416API_ACCOUNTREQUESTInvalid/Missing customPolicyId
20418API_ACCOUNTREQUESTThis policy name is already used
20500API_ACCOUNTAPPLICATIONSystem 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.