Matchai Docs

Add a linkComing soon

Adds a link at the end of the page. It shows on the public page straight away when the page is published.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
POST
/page/links

Coming soon. Adds a link at the end of the page. It shows on the public page straight away when the page is published.

Scopes: page:write

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: page:write

Header Parameters

Idempotency-Key?string

A unique string (a UUID works). Retrying with the same key within 24 hours returns the first response instead of acting twice. Reusing a key with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 255

Request Body

application/json
  1. body
title*string

Text on the button.

Length1 <= length <= 100
url*string

Where it goes. https only.

Formaturi
visible?boolean

Shown on the page. Defaults to true.

Response Body

The new link.

application/json
  1. response
id*string

Link id.

Length1 <= length <= 64
title*string

Text on the button.

url*string

Where it goes.

Formaturi
thumbnail_url?|

Small image beside the title.

Formaturi
position*integer

Order on the page.

Range0 <= value
visible*boolean

Shown on the page.

click_count*integer

Clicks so far.

Range0 <= value
Example Request
curl -X POST 'https://api.matchai.co/v1/page/links' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "title": "string",  "url": "http://example.com"}'
Example Response
{  "id": "string",  "title": "string",  "url": "http://example.com",  "thumbnail_url": "http://example.com",  "position": 0,  "visible": true,  "click_count": 0}