Matchai Docs

Put a contact on a projectComing soon

Puts one of your contacts on the project, for example a client or a notary.

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

Coming soon. Puts one of your contacts on the project, for example a client or a notary. It gives them no access by itself; invite a professional to share the project with them.

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

Request Body

application/json
  1. body

Puts a contact on the project, for example a client or a notary. It gives them no access by itself; invite a professional to give them access.

contact_id*string

A contact.

Length1 <= length <= 64

Response Body

The member.

application/json
  1. response
professional_id?|

Professional id, for a professional member.

Length1 <= length <= 64
contact_id?|

Contact id, for a contact on a project.

Length1 <= length <= 64
user_id?|

Account id.

Length1 <= length <= 64
display_name*string

Name.

username?|

Handle.

avatar_url?|

Picture.

Formaturi
role*|null
joined_at*string

Joined.

Formatdate-time
Example Request
curl -X POST 'https://api.matchai.co/v1/projects/string/members' \  -H 'Idempotency-Key: 6f1d3c2a-0b7e-4f5a-9c8d-1e2f3a4b5c6d' \  -H 'Content-Type: application/json' \  -d '{  "contact_id": "string"}'
Example Response
{  "professional_id": "string",  "contact_id": "string",  "user_id": "string",  "display_name": "string",  "username": "string",  "avatar_url": "http://example.com",  "role": "owner",  "joined_at": "2019-08-24T14:15:22Z"}