Skip to navigation

Create a new directory matchmaking request

View as Markdown

Create a matchmaking request in one of your own directories from your own server. Authenticate with your API token (Authorization: Token <your-api-token>); the token’s organization must own the directory. 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.

A company website without a scheme (acme.com) is stored with https://. One that is not an http(s) web address (for example an email address) is dropped, with its answer cleared, and the request is still created without it instead of answering 400.

The directory must have matchmaking requests enabled. Limited to 50 requests per hour per user.

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"
ID of the directory to create a matchmaking request for

Request

This endpoint expects an object.
formobjectRequired
utmQueryParamsmap from strings to anyOptional

UTM attribution to store with the request, for example {"utmSource": "api", "utmMedium": "server-to-server"}.

Response

Directory matchmaking request created successfully.
idstringformat: "uuid"
answerslist of objects
createdstring or nullRead-only
ownerstring or null
utmQueryParamsany or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error