Matchai Docs

Update a linkComing soon

Changes a link’s title or address, or hides it.

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

Coming soon. Changes a link’s title or address, or hides it.

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

Path Parameters

Request Body

application/json
  1. body
Properties1 <= properties
title?string

Text on the button.

Length1 <= length <= 100
url?string

Where it goes.

Formaturi
visible?boolean

Shown on the page.

Response Body

The 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 PATCH 'https://api.matchai.co/v1/page/links/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "title": "string",  "url": "http://example.com",  "thumbnail_url": "http://example.com",  "position": 0,  "visible": true,  "click_count": 0}