1. Matchmaking
PartnerPage API
  • Introduction
  • Authentication
  • Object Overview
  • Verify and handle webhook deliveries
  • Directory webhook events and payloads
  • Partner lead webhook event
  • Directory
    • Forms
      • Get all custom forms
      • Get all currency field options
      • Get all contact request form
      • Get default contact request form
      • Create a cotact request custom form
      • Delete a contact request custom form
    • Callouts
      • Get all callouts
      • Get a callout
      • Create a new callout
      • Update a directory callout
      • Delete a directory callout
    • Badges
      • Get all badges
      • Get a badge
      • Create a badge
      • Update a badge
      • Delete a badge
    • Certifications
      • Get all certifications
      • Get a certification
      • Create a certification
      • Update a certification
      • Delete a certification
    • Filters
      • Filter Options
        • Get all filter options
        • Get a filter option
        • Create a filter option
        • Update a filter option
        • Deletes a filter option
      • Get all filters
      • Get a filter
      • Create a filter
      • Update a filter
      • Deletes a filter
      • Get all internal filters
      • Get all filters for external directory
    • Filter Maps
      • Get all filter option mappings
      • Get a filter option mapping
      • Create a new filter option mapping
      • Update a filter option mapping
      • Delete a filter option mapping
      • Get all filter option mappings for external directory
    • Matchmaking
      • Get all matchmaking requests
    • Tiers
      • Get all tiers
      • Get a tier
      • Create a tier
      • Update a tier
      • Delete a tier
      • Get all entries assigned to an specific tier
      • Assign or Unassign entries to an specific tier
    • Verifications
      • Get all verifications
      • Get a verification
      • Create a verification
      • Update a verification
      • Delete a verification
    • Settings
      • Retrieve the settings for a directory
      • Update the settings for a directory
    • List directories
      GET
    • Get a directory
      GET
    • Create a directory
      POST
    • Update a directory
      PATCH
  • Entry
    • App Entry
      • Callouts
        • Get all callouts
        • Get an entry callout
        • Create a new callout
        • Update a callout
        • Delete a callout
      • Get an app entry
      • Create new app entry
      • Update app entry
      • Delete a app entry
      • Update the recommended order of an app entry
    • Partner Entry
      • Badges
        • Get all badges
        • Get a badge
        • Create a badge
        • Update a badge
        • Delete a badge
      • Callouts
        • Get all callouts
        • Get a callout
        • Create a callout
        • Update a callout
        • Delete a callout
      • Certifications (General)
        • Get all certifications
        • Get a certification
        • Create a certification
        • Update a certification
        • Delete a certification
      • Certifications (Industry)
        • Get all industry certifications
        • Get an industry certification
        • Create an industry certification
        • Update an industry certification
        • Delete an industry certification
      • Certifications (Segment)
        • Get all segment certifications
        • Get a segment certification
        • Create a segment certification
        • Update a segment certification
        • Delete a segment certification
      • Client
        • Get all Clients
        • Get a client
        • Create a client
        • Update a client
        • Delete a client
      • Keywords
        • Get all keywords
        • Get a keyword
        • Create a keyword
        • Update keyword
        • Delete a keyword
      • Locations
        • Get all location
        • Get a location
        • Create a location
        • Update a location
        • Delete a location
      • Media
        • Get all media
        • Get a media
        • Create a media
        • Update a media
        • Delete a media
      • Resources
        • Internal
          • Get all Internal resources
          • Get an internal resource
          • Create an internal resource
          • Update an internal resource
          • Delete an internal resource
        • Get all resouces
        • Get a resource
        • Create a resource
        • Update a resource
        • Delete a resource
      • Special Offers
        • Get all special offer
        • Get a special offer
        • Create a special offer
        • Update a special offer
        • Delete a special offer
      • Testimonials
        • Internal
          • Get all internal testimonial
          • Get an internal testimonial
          • Create an internal testimonial
          • Update an internal testimonial
          • Delete an internal testimonial
        • Get all testimonials
        • Get a testimonial
        • Create a testimonial
        • Update a testimonial
        • Delete a testimonial
      • Use Cases
        • Internal
          • Get all internal use cases
          • Get an internal use cases
          • Create an internal use case
          • Update an internal use case
          • Delete an internal use case
        • Get all use cases
        • Get a use case details
        • Create a use case
        • Update a use case
        • Delete a use case
      • Verifications
        • Get all verifications
        • Get a verification
        • Create a verification
        • Update a verification
        • Delete a verification
      • Contact Information
        • Return entry contact information
      • Invite
        • Get organization matches for partner invite
        • Get partner entry owner organization invite
        • Get partner entry owner user invites
        • Invite organization to own partner entry
        • Invite users to partner entry ownership
      • Entry Edits Approval Flow
        • Partner Entry Submit Review
        • Partner Entry Approve Review
        • Partner Entry Reject Changes
        • Partner Entry Discard Review
      • Get all partner entry
      • Get a partner entry
      • Create a partner entry
      • Update a partner entry
      • Delete a partner entry
      • Bulk upsert partner entries
      • Update the recommended order of a partner entry
    • Get all entries
      GET
  • Contact Request
    • Attachment
      • List contact request attachments
      • Create contact request attachment
      • Delete contact request attachment
    • Get all contact requests
    • Get a contact request
    • Create a new partner contact request
  • Matchmaking
    • Get all matchmaking requests
      GET
    • Get a matchmaking request
      GET
    • Create a new directory matchmaking request
      POST
    • Get all partners assigned to matchmaking requests
      GET
    • Assign an owner to a matchmaking request
      PATCH
    • Set partners to a matchmaking request
      PUT
  • Review
    • directory-review-list
    • directory-review-detail
    • directory-review-create
    • Update a review
    • Delete a review
    • reviewsDirectoryExportRetrieve
  1. Matchmaking

Create a new directory matchmaking request

POST
https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories/{directoryId}/matchmaking/
Create a matchmaking request for a directory from your own server. Authenticate with your API token (Authorization: Token <your-api-token>). CAPTCHA is not required: the token is the trust signal. The matchmaking form on the public directory website is a separate flow for anonymous visitors; it requires a valid captcha and an API token does not replace it there.
Before submitting, read the directory's matchmaking request form (GET /api/directory/public/v1alpha/directories/{directoryId}/forms/matchmaking-request/) for the field IDs, internal labels, types and which fields are required. Send one answer per field in form.answers, identified by fieldId or internalLabel. First name, last name, email and company name are always required; the directory's form can require more. Property names are accepted in camelCase (as in the examples) or snake_case (as in the schema). utmQueryParams stores attribution data with the request.
The directory must have matchmaking requests enabled. Limited to 50 requests per hour per user.

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Body Params
application/json
Required

Examples

Responses

🟢201
application/json
Directory matchmaking request created successfully.
Bodyapplication/json

🟠400
🟠401
🟠403
🟠429
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://v1.api.partnerpage.io/api/directory/private/v1alpha/directories//matchmaking/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "form": {
        "answers": [
            {
                "fieldId": "0165c5e6-e562-4ad9-adce-efc9844a95fc",
                "answer": "John"
            },
            {
                "internalLabel": "partnerpage-last_name",
                "answer": "Doe"
            },
            {
                "internalLabel": "partnerpage-email",
                "answer": "john.doe@mycompany.io"
            },
            {
                "internalLabel": "partnerpage-company_name",
                "answer": "MyCompany"
            }
        ]
    },
    "utmQueryParams": {
        "utmSource": "api",
        "utmMedium": "server-to-server"
    }
}'
Response Response Example
{
    "id": "219a7d94-b934-4ccf-880f-d24b55e7e03e",
    "created": "2024-08-23T13:40:00+00:00",
    "answers": [],
    "utmQueryParams": {},
    "owner": null
}
Modified at 2026-10-20 14:27:55
Previous
Get a matchmaking request
Next
Get all partners assigned to matchmaking requests
Built with