Matchai Docs

Archive a projectComing soon

Archives the project. Nothing in it is deleted.

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

Coming soon. Archives the project. Nothing in it is deleted.

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

Path Parameters

project_id*string

Project 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 project.

application/json
  1. response

A project groups the people, listings and files of one deal, with a client conversation and a team conversation.

id*string

Project id.

Length1 <= length <= 64
name*string

Name.

description?|

Description.

status*string
Value in"active""archived"
picture_url?|

Picture.

Formaturi
your_role*Role

owner: full control. admin: edit and manage. member: view.

Value in"owner""admin""member"
client_conversation_id?|

Conversation with the clients.

Length1 <= length <= 64
team_conversation_id?|

Conversation for the professionals only.

Length1 <= length <= 64
listing_count*integer

Listings.

Range0 <= value
member_count*integer

Members.

Range1 <= value
archived_at?|

Archived.

Formatdate-time
created_at*string

Created.

Formatdate-time
updated_at*string

Last changed.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/projects/string/archive' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d'
Example Response
{  "id": "string",  "name": "string",  "description": "string",  "status": "active",  "picture_url": "http://example.com",  "your_role": "owner",  "client_conversation_id": "string",  "team_conversation_id": "string",  "listing_count": 0,  "member_count": 1,  "archived_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}