PartnerPage API
  1. Others
PartnerPage API
  • Introduction
  • Authentication
  • Object Overview
  • Directory
    • Branding
      • Retrieve a directory's branding
      • Update a directory's branding
    • Forms
      • List all custom forms
      • Retrieve the default contact request form
      • Retrieve the currently active contact request form for the specified directory
      • Get all currency field options
      • Create and configure a new custom contact request form for the specified directory
      • Reset the current custom contact request form for the directory to the global default version
    • Callouts
      • Return the list of callouts details information belonging to a directory
      • Return the details of a callout
      • Create a new callout
      • Update a directory callout
      • Update a directory callout
    • Badges
      • Create a directory badge
      • Return the details of a badge
      • Update a directory badge
      • Delete a directory badge
      • Return the list of badge details information belonging to a directory
    • Certifications
      • Return the list of certifications belonging to a directory
      • Create a directory certification
      • Return a certificacion details
      • Update a directory certification
      • Delete a directory certification
    • Filters
      • Retrieve a list of filters within a directory
      • Create a filter within a directory
      • Retrieve a list of filters within a directory
      • Retrieve a list of filters for an external directory
      • Retrieve details of a single filter within a directory
      • Update a filter
      • Deletes a directory filter
      • Retrieve a list of filter options within a filter
      • Create a filter option within a custom filter
      • Deletes a directory filter option
      • Update a custom filter option
      • Retrieve details of a single filter option within a filter in a directory
    • Filter Maps
      • Delete a filter option mapping
      • Update a filter option mapping
      • Retrieve details of a single filter option mapping
      • Retrieve a list of filter option mappings within a directory
      • Create a new filter option mapping
      • Retrieve a list of filter option mappings within a directory
    • Matchmaking
      • Retrieve a list of matchmaking requests for a specific directory
    • Tiers
      • Return the list of tiers belonging to a directory
      • Create a directory tier
      • Return the details of a tier
      • Update a directory tier
      • Delete a directory tier
      • Return the list of entries assigned to an specific tier
      • Assign or Unassign entries to an specific tier
    • Verifications
      • Return the list of verification details information belonging to a directory
      • Create a directory verification
      • Return the details of a verification
      • Update a directory verification
      • Delete a directory verification
    • Return the list of directories
      GET
    • Return the list of directory details information belonging to the logged-in user organization
      GET
    • Return the detail information of a directory
      GET
    • Update generic directory details
      PATCH
    • Update the settings for a specific directory
      PATCH
    • Retrieve the settings for a specific directory
      GET
    • Return the detailed information of a directory you own
      GET
    • Retrieve detailed information about an external directory in which the user's organization has an entry
      GET
  • Entry
    • App Entry
      • Callouts
        • Return the list of app entry callouts
        • Create a new app entry callout
        • Return the details of an app entry callout
        • Update an app entry callout
        • Delete an app entry callout
      • Create new app entry
      • Returns details of an App entry from a directory
      • Update app entry
      • Delete a app entry
      • Update the recommended order of an app entry
    • Partner Entry
      • Badges
        • Return the list of partner entry badges
        • Create a new partner entry badge
        • Return the details of a partner entry badge
        • Update a partner entry badge
        • Delete a partner entry badge
      • Callouts
        • Return the list of partner entry callouts
        • Create a new partner entry callout
        • Return the details of a partner entry callout
        • Update a partner entry callout
        • Delete a partner entry callout
      • Certifications (General)
        • Return the partner entry certifications
        • Create a new partner entry certification
        • Return the details of a partner entry certification
        • Update a partner entry certification
        • Delete a partner entry certification
      • Certifications (Industry)
        • Return the partner entry industry certifications
        • Create a new partner entry industry certification
        • Return the details of a partner entry industry certification
        • Update a partner entry industry certification
        • Delete a partner entry industry certification
      • Certifications (Segment)
        • Return the partner entry segment certifications
        • Create a new partner entry segment certification
        • Return the details of a partner entry segment certification
        • Update a partner entry segment certification
        • Delete a partner entry segment certification
      • Entry Edits Approval Flow
        • Reject partner entry changes
        • Partner Entry Submit Review
        • Partner Entry Discard Review
        • Partner Entry Approve Review
      • Keywords
        • Return Keyword details
        • Create a new keyword
        • Return Keyword details
        • Update keyword details
        • Delete a keyword
      • Locations
        • Return Location details
        • Create a new location
        • Return Location details
        • Update location details
        • Delete a location
      • Media
        • Retrieve a profile media within an entry in a directory
        • Retrieve a list of profile media within an entry in a directory
        • Create new profile media
        • Update profile media
        • Delete profile media
      • Resources
        • Return Internal Resource details
        • Create a new internal resource
        • Return Internal resource details
        • Update internal resource details
        • Delete an internal resource
        • Return Resource details
        • Create a new resource
        • Return Resource details
        • Update resource details
        • Delete a resource
      • Special Offers
        • Return Special Offer details
        • Create a new special offer
        • Return Special Offer details
        • Update special offer details
        • Delete a special offer
      • Testimonials
        • Return a list with Internal Testimonial details
        • Return Internal Testimonial details
        • Create a new internal testimonial
        • Update internal testimonial details
        • Delete an internal testimonial
        • Return Testimonial details
        • Create a new testimonial
        • Return Testimonial details
        • Update testimonial details
        • Delete a testimonial
      • Use Cases
        • Return a list with internal use cases details
        • Create a new internal use case
        • Return internal use cases details
        • Update internal use case details
        • Delete an internal use case
        • Return a list with use cases details
        • Create a new use case
        • Return use cases details
        • Update use case details
        • Delete a use case
      • Verifications
        • Return the list of verifications assigned to partner entry
        • Create a new partner entry verification
        • Return the details of a partner entry verification
        • Update a partner entry verification
        • Delete a partner entry verification
      • Create new partner entry
      • Update partner entry details
      • Delete partner entry
      • Returns the details of a Partner entry from a directory
      • Returns the internal details of a Partner entry from a directory
      • Update the recommended order of a partner entry
    • Authenticated endpoint that return a paginated list of entries for an specific directory
  • Organization
    • Returns the paginated list of all Partner Entry Owner Organization invites
    • Returns a paginated list of all the entries of an organization from all the directories that its listed
    • Retrieve a list of contact requests for an entry owner organization
    • Get api directory private v1alpha organizations external analytics
    • Return the directory details of an Organization
  • Client
    • Return Client details
    • Create a new client
    • Return Client details
    • Update special client details
    • Delete a client
  • Others
    • Get listed with an authenticated user with an existing organization
      POST
    • Return partners assigned to matchmaking requests
      GET
    • Replace api directory private v1alpha directories matchmaking-requests partners
      PUT
    • Return the contact information of a specific directory entry
      GET
    • Get api directory private v1alpha entries partners invite matches
      GET
    • Get api directory private v1alpha entries partners invite organization
      GET
    • Create api directory private v1alpha entries partners invite organization
      POST
    • Get api directory private v1alpha entries partners invite users
      GET
    • Create api directory private v1alpha entries partners invite users
      POST
    • Retrieve details of a contact requests for an entry owner organization
      GET
    • Retrieve details of a contact requests for an entry owner organization
      PATCH
    • Entry owner accepts a specific contact request
      POST
    • Entry owner declines a specific contact request
      POST
    • Return the details of an App Entry owned by an Organization
      GET
    • Update an App Entry owned by an Organization
      PATCH
    • Returns the paginated list of all Partner Entry Owner Organization invites
      GET
    • Returns a partner entry owner organization invite details
      GET
    • Accepts an invite for an organization to own a partner entry
      POST
    • Rejects an invite for an organization to own a partner entry
      POST
    • Return the details of a partner entry owned by an Organization
      GET
    • Update a partner entry owned by an Organization
      PATCH
  • Contact Request
    • Retrieve details of a contact requests for a directory owner organization
    • Retrieve a list of contact requests for a directory owner organization
  • Matchmaking
    • Return a list of possible matchmaking request owners
    • Allows an authenticated user to assign an owner (by ID) to a matchmaking request
    • Return details of a matchmaking request for a directory owner
  1. Others

Update a partner entry owned by an Organization

PATCH
https://v1.api.partnerpage.io/api/directory/private/v1alpha/external/entries/partners/{entry_id}/
Update a partner entry owned by an Organization
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/external/entries/partners//' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "headline": "string",
    "type": "string",
    "slug": "string",
    "customSlug": "string",
    "status": "hidden",
    "website": "http://example.com",
    "description": "string",
    "integrationDescription": "string",
    "location": "string",
    "userAssignedFilterOptions": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "externalUrl": "http://example.com",
    "callToActionUrl": "http://example.com",
    "callToActionLabel": "string",
    "supportEmail": "string",
    "developerName": "string"
}'
Response Response Example
200 - Example 1
{
    "href": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "title": "string",
    "headline": "string",
    "type": "string",
    "slug": "string",
    "customSlug": "string",
    "status": "hidden",
    "icon": "string",
    "image": "string",
    "website": "http://example.com",
    "userAssignedFilterOptions": "string",
    "systemAssignedFilterOptions": "string",
    "mappedAssignedFilterOptions": "string",
    "description": "string",
    "integrationDescription": "string",
    "location": "string",
    "callToActionUrl": "http://example.com",
    "callToActionLabel": "string",
    "externalUrl": "http://example.com",
    "award": "http://example.com",
    "directory": "5277859d-f92c-478c-acab-7680a97fea68",
    "approvalFlow": "string",
    "supportEmail": "string",
    "developerName": "string"
}

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Path Params
entry_id
string <uuid>
required
ID of the partner entry
Body Params application/json
id
string <uuid>
Id
required
title
string 
Title
required
>= 1 characters<= 256 characters
headline
string  | null 
Headline
required
>= 1 characters<= 250 characters
type
string 
Type
required
>= 1 characters<= 100 characters
slug
string <slug>
Slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
customSlug
string <slug> | null 
Custom slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
status
enum<string> 
Status
required
Allowed values:
hiddeninactivepublicsearchable
website
string <uri> | null 
Website
required
>= 1 characters
description
string 
Description
required
>= 1 characters
integrationDescription
string  | null 
Integration description
optional
location
string  | null 
Location
required
>= 1 characters<= 255 characters
userAssignedFilterOptions
array[string <uuid>]
optional
externalUrl
string <uri> | null 
External url
required
>= 1 characters
callToActionUrl
string <uri> | null 
Call to action url
required
>= 1 characters
callToActionLabel
string  | null 
Call to action label
required
>= 1 characters<= 25 characters
supportEmail
string  | null 
Support email
required
>= 1 characters<= 250 characters
developerName
string  | null 
Developer name
required
>= 1 characters<= 250 characters
Examples

Responses

🟢200OK
application/json
Successful operation
Body
href
string 
Href
read-onlyoptional
id
string <uuid>
Id
required
title
string 
Title
required
>= 1 characters<= 256 characters
headline
string  | null 
Headline
required
>= 1 characters<= 250 characters
type
string 
Type
required
>= 1 characters<= 100 characters
slug
string <slug>
Slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
customSlug
string <slug> | null 
Custom slug
required
>= 1 characters<= 60 characters
Match pattern:
^[-a-zA-Z0-9_]+$
status
enum<string> 
Status
required
Allowed values:
hiddeninactivepublicsearchable
icon
string  | null 
Icon
required
>= 1 characters
image
string  | null 
Image
required
>= 1 characters
website
string <uri> | null 
Website
required
>= 1 characters
userAssignedFilterOptions
string 
User assigned filter options
read-onlyoptional
systemAssignedFilterOptions
string 
System assigned filter options
read-onlyoptional
mappedAssignedFilterOptions
string 
Mapped assigned filter options
read-onlyoptional
description
string  | null 
Description
required
>= 1 characters
integrationDescription
string  | null 
Integration description
optional
location
string  | null 
Location
required
>= 1 characters<= 255 characters
callToActionUrl
string <uri> | null 
Call to action url
required
>= 1 characters
callToActionLabel
string  | null 
Call to action label
required
>= 1 characters<= 25 characters
externalUrl
string <uri> | null 
External url
required
>= 1 characters
award
string <uri> | null 
Award
required
>= 1 characters
directory
string <uuid>
Directory
required
approvalFlow
string 
Approval flow
read-onlyoptional
supportEmail
string  | null 
Support email
required
>= 1 characters<= 250 characters
developerName
string  | null 
Developer name
required
>= 1 characters<= 250 characters
🟠404Record Not Found
Modified at 2025-07-10 12:24:27
Previous
Return the details of a partner entry owned by an Organization
Next
Retrieve details of a contact requests for a directory owner organization
Built with