Matchai Docs

Update a projectComing soon

Changes the name, or replaces the description. Read the project first and keep what should stay.

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

Coming soon. Changes the name, or replaces the description. Read the project first and keep what should stay.

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

Request Body

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

Name.

Length1 <= length <= 120
description?|

The full new text. It replaces the old one.

Lengthlength <= 4000

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 PATCH 'https://api.matchai.co/v1/projects/string' \  -H 'Content-Type: application/json' \  -d '{}'
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"}