Matchai Docs

Unpublish your Matchai PageComing soon

Takes the page off the public web. Nothing on it is deleted.

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

Coming soon. Takes the page off the public web. Nothing on it is deleted.

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

Response Body

The page.

application/json
  1. response

The Matchai Page: one page at {username}.matchai.pro with your photo, socials, listings, files and links, made to paste into a bio. It is not the Matchai Site.

id*string

Page id.

Length1 <= length <= 64
username*|

The handle in the address.

url?|

Public address, when published.

Formaturi
published*boolean

On the public web.

can_publish*boolean

False when the handle cannot be used as a web address yet; change the username in Matchai first.

headline?|

Line under your name.

booking_enabled*boolean

Visitors can book time with you from the page.

social_links*

Public profile links. Every key is optional.

links*array<>

Your links, in order.

files*array<>

Files shown on the page, in order.

Example Request
curl -X POST 'https://api.matchai.co/v1/page/unpublish' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "username": "string",  "url": "http://example.com",  "published": true,  "can_publish": true,  "headline": "string",  "booking_enabled": true,  "social_links": {    "website": "http://example.com",    "linkedin": "http://example.com",    "instagram": "http://example.com",    "facebook": "http://example.com",    "x": "http://example.com",    "youtube": "http://example.com",    "tiktok": "http://example.com"  },  "links": [    {      "id": "string",      "title": "string",      "url": "http://example.com",      "thumbnail_url": "http://example.com",      "position": 0,      "visible": true,      "click_count": 0    }  ],  "files": [    {      "document_id": "string",      "name": "string",      "mime_type": "string",      "size_bytes": 0,      "position": 0    }  ]}