Matchai Docs

Unpublish a siteComing soon

Takes the site off the public web. Your listings stay published on their own pages.

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

Coming soon. Takes the site off the public web. Your listings stay published on their own pages.

Scopes: sites: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: sites:write

Path Parameters

site_id*string

Site id.

Length1 <= length <= 64

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 site.

application/json
  1. response

A Matchai Site: a portfolio website made of listing pages.

id*string

Site id.

Length1 <= length <= 64
subdomain*string

The site lives at {subdomain}.matchai.co.

url*string

The site’s primary address: the custom domain when one is active.

Formaturi
custom_domain?|null
name?|

Site name.

tagline?|

Short line under the name.

description?|

About the site.

hero_image_url?|

Top image.

Formaturi
contact_email?|

Contact email shown on the site.

Formatemail
contact_phone?|

Contact phone shown on the site, E.164.

social_links*

Public profile links. Every key is optional.

published*boolean

Whether the site is on the public web.

owner*

Who owns a listing or a site: one professional, or a team.

listing_count*integer

Listings on the site.

Range0 <= value
created_at*string

Created.

Formatdate-time
updated_at*string

Last changed.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/sites/string/unpublish' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "subdomain": "string",  "url": "http://example.com",  "custom_domain": {    "hostname": "string",    "status": "pending"  },  "name": "string",  "tagline": "string",  "description": "string",  "hero_image_url": "http://example.com",  "contact_email": "user@example.com",  "contact_phone": "string",  "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"  },  "published": true,  "owner": {    "type": "user",    "id": "string",    "name": "string"  },  "listing_count": 0,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}