API Reference

Create a listing

post
https://your-marketplace.partnerfleet.app/admin_api/v2/listings

Creates a partner and its listing, including any content sections you send, and returns the listing's draft version (status: draft). The partner also gets an unpublished active version; nothing is visible on the marketplace until you submit the draft for approval and an admin approves it. Call GET /listings/template_schema first: sections, categories and filter options the template does not offer are rejected with 422. Problems that do not stop the create, such as an image that could not be downloaded, are listed in warnings. Requires the listings_create permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a listing

string
required

Name of the listing and of its partner. It must not be the name of a partner that already has a listing (409); to change that listing, update it instead.

int32

ID of the listing's template. The template decides which content sections, categories and filters the listing can have; get them from GET /listings/template_schema first.

string

URL slug of the listing page. If it is already taken, a unique variant is used and a warning is returned.

int32

ID of your marketplace. Optional: the listing is always created in the marketplace you call. Any other value returns 422.

string

Partner website URL. It can only be set when the listing is created.

string

Your identifier for the partner. It can only be set when the listing is created.

string

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

string

Short tagline shown under the listing name.

string

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

string

Listing description, as HTML.

string

SEO description of the listing page.

string

SEO keywords of the listing page.

string

SEO title of the listing page.

string

Text of the primary call-to-action button.

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.

string

Text of the secondary call-to-action button.

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.

string

Pricing details, as HTML.

string

Integration details, as HTML.

string

Public URL of the partner's logo image. PartnerFleet downloads the image; if it cannot, a warning is returned.

taxons
array of strings

Names of the listing's categories. They must be categories the template offers (see categories in GET /listings/template_schema); any other name returns 422.

taxons
option_values
array of strings

Names of the listing's filter options. They must be filter options the template offers (see filters in GET /listings/template_schema); any other name returns 422.

option_values
benefits
array of strings

Items of the Benefits section: { title }. Rejected with 422 if the template does not enable this section.

benefits
features
array of strings

Items of the Features section: { title, details, image_url }. Rejected with 422 if the template does not enable this section.

features
faqs
array of strings

Items of the FAQs section: { question, answer }. Rejected with 422 if the template does not enable this section.

faqs
next_steps
array of strings

Items of the Next steps section: { title, details, image_url }. Rejected with 422 if the template does not enable this section.

next_steps
resources
array of strings

Items of the Resources section: { title, image_url, details, link, link_text }. Items without a valid image_url are skipped with a warning. Rejected with 422 if the template does not enable this section.

resources
services
array of strings

Items of the Services section: { title, details, image_url }. Rejected with 422 if the template does not enable this section.

services
screenshots
array of strings

Images and videos: { image_url, alt, image_type, video_url }, where image_type is Image or Video. Items without a valid image_url are skipped. Rejected with 422 if the template does not enable this section.

screenshots
team_members
array of strings

Items of the Team section: { name, title, headshot_url }. Items without a valid headshot_url are skipped with a warning; to set bio, link or link_name, use the section item endpoints. Rejected with 422 if the template does not enable this section.

team_members
testimonials
array of strings

Items of the Testimonials section: { name, title, quote, image_url }. Items without a valid image_url are skipped with a warning. Rejected with 422 if the template does not enable this section.

testimonials
description_sections
array of strings

Content for the marketplace's description sections: { title, content }, where title names the section and content is HTML. Rejected with 422 if the template does not enable description sections.

description_sections
details
array of strings

Rows of the template's additional-details sections: { name, link, section_name }, where section_name is one of the template's detail_sections. Rows without a name and a link are skipped. Rejected with 422 if the template has no additional-details sections.

details
pricing_editions
array of strings

Pricing plans: { title, description, price, price_modifier, features, free_trial, price_cta_text, price_cta_destination }, where features is an array of strings. Rejected with 422 if the template does not enable the pricing section.

pricing_editions
properties
array of strings

Facts for the Properties panel: { property_name, value, property_type }, where property_type is Whitepaper, External URL or Detail. Not the same as details. Rejected with 422 if the template does not enable the Properties panel.

properties
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, plus description_sections ([{ title, content }], matched by title) and details ([{ key, name }], where key is the row's name).

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?