Update a listing

put

https://your-marketplace.partnerfleet.app/admin_api/v2/listings/{id}

Changes only the fields you send; the listing's status never changes. Content sections cannot be sent here (422): change them with the section item endpoints. website and external_id can only be set when the listing is created (422). draft and rejected listings are updated in place. Updating an active listing does not change what the marketplace shows: the changes are saved to the partner's draft version (created if needed), which the response returns with revision_id and revision_of. A pending listing, or an active listing whose draft is pending, returns 422 until you unsubmit the pending version; old and disabled listings cannot be updated (422). Requires the listings_update permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Listing ID.

Body Params

Update a listing

name

string

Listing name.

template_id

int32

ID of the template to switch the listing to. Categories and filter options are checked against it.

slug

string

URL slug of the listing page.

store_id

int32

ID of your marketplace. Optional; any other value returns 422.

page_title

string

Heading shown instead of the name at the top of the listing page, in the page layouts that support it.

tagline

string

Short tagline shown under the listing name.

rte_tagline

string

Tagline formatted as HTML. When set, the listing page shows it instead of tagline.

description

string

Listing description, as HTML.

meta_description

string

SEO description of the listing page.

meta_keywords

string

SEO keywords of the listing page.

meta_title

string

SEO title of the listing page.

cta_text

string

Text of the primary call-to-action button.

cta_destination

string

URL the primary call-to-action button opens (http or https), or LEAD_BUTTON to open the marketplace's lead form. An invalid URL is ignored and a warning is returned.

secondary_cta_text

string

Text of the secondary call-to-action button.

secondary_cta_destination

string

URL the secondary call-to-action button opens (http or https), or LEAD_BUTTON to open the marketplace's lead form. An invalid URL is ignored and a warning is returned.

pricing_details

string

Pricing details, as HTML.

integration_details

string

Integration details, as HTML.

logo_url

string

Public URL of a new logo image for the listing. PartnerFleet downloads the image; if it cannot, a warning is returned.

taxons

array of strings

Names of the listing's categories. Replaces the current categories. They must be categories the template offers; any other name returns 422.

taxons

option_values

array of strings

Names of the listing's filter options. Replaces the current filter options. They must be filter options the template offers; any other name returns 422.

option_values

translations

object

Translations keyed by locale code, for example { "fr": { "tagline": "..." } }. Each locale accepts tagline, description, page_title, meta_title, meta_description, meta_keywords, cta_text, secondary_cta_text, pricing_details and integration_details.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated listing.

400Invalid parameter

401Missing, invalid or revoked API key

403The API key lacks the listings_update permission

404Listing not found, or the listings endpoints are not enabled for your marketplace

422The listing cannot be updated in its current status, or the request contains fields, categories or filter options that are not accepted

429Rate limit exceeded