API Reference

Create a listing

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

Creates a partner and its live listing (status active) on your default marketplace, and returns the listing. vendor_id is set on both; external_id is saved on the partner. The listing appears on the marketplace only once its launch date (available_on) is set and reached.

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

Create a listing

string
required

Listing name. Also used as the name of the new partner.

string
required

ID of the template that defines the listing page layout.

string

Your own identifier for the partner (for example, its ID in your CRM). Saved on the new partner, not on the listing.

string

ID of the partner account that owns the listing.

string

URL slug of the listing. Must be unique. Generated from the name when omitted.

string

Listing description. Accepts HTML.

string

Heading of the listing page. When empty, the listing name is shown instead.

string

Card tagline: short plain-text copy shown on the listing card.

string

Destination of the primary call-to-action button: a URL (https:// is added when the scheme is missing), or LEAD_BUTTON, PROTOTYPE_LEAD_BUTTON or CLAIM_LISTING to open the listing's lead form, the template's lead form or the claim-listing form.

string

Text of the primary call-to-action button.

string

Destination of the secondary call-to-action button. Accepts the same values as cta_destination.

string

Text of the secondary call-to-action button.

date-time

Launch date, in ISO 8601 format: when the listing becomes visible on the marketplace. A listing without a launch date is not published.

date-time

Unpublish date, in ISO 8601 format: when the listing stops being visible on the marketplace. Must be later than available_on.

string

Listing tagline shown on the listing page. Accepts HTML.

string

SEO description.

string

SEO keywords. Maximum 255 characters.

string

SEO title. Maximum 255 characters.

string

Text of the call-to-action button in the Integration Diagram section.

string

Destination of the Integration Diagram call-to-action button. Accepts the same values as cta_destination.

string

Text of the secondary call-to-action button in the Integration Diagram section.

string

Destination of the secondary Integration Diagram call-to-action button. Accepts the same values as cta_destination.

string

Pricing details. Accepts HTML.

string

Integration details: the text of the Integration Diagram section. Accepts HTML.

string

Public URL of the listing logo image (PNG, JPEG or WebP up to 5 MB; SVG is converted to PNG). The image is downloaded during the request; if it cannot be downloaded, the listing is saved without a logo.

string
enum

What happens when a visitor clicks the listing card: Default opens the listing page, External Link opens navigation_destination, Hidden keeps the card off the marketplace home page, and None makes the card not clickable. New listings use Default.

Allowed:
string

URL the listing card opens when navigation is External Link. https:// is added when the scheme is missing.

string

Public URL of the listing header image (PNG, JPEG or WebP up to 5 MB). Downloaded during the request, like logo_url.

Responses

Updated about 1 month 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 about 1 month ago

Did this page help you?