Skip to content
Plune Plune Docs

Join a project of the company

POST
/v1/companies/{id}/projects/{projectId}/join
 
curl --request POST \
  --url https://beta-api.plune.ai/v1/companies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/projects/example/join \
  --header 'Authorization: Bearer <token>'

Anybody in the company, themself: into one of its projects with the role their company role maps to — owner and admin → owner, member → member, reader → reader. From then on the project opens to them as to any member of it. A project that is not the company’s answers 404; being in it already, 409.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid
projectId
required
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Joined — with this role

Media type application/json
object
projectId
required
string
role
required

What a member may do (B8-team). owner runs the project — members, roles, its name; member does everything else; reader is refused every write at the boundary, before a handler runs.

string
Allowed values: owner member reader
Example 
{
  "projectId": "9c4e7d10-0000-4000-8000-0000000000a4",
  "role": "member"
}

401

Section titled “401 ”

No / invalid token or session

404

Section titled “404 ”

No such company among yours, or no such project in it

Media type application/json
object
error
required
string
Example 
{
  "error": "project '9c4e7d10-0000-4000-8000-0000000000a4' not found"
}

409

Section titled “409 ”

Already in it, or the project is at its member limit

Media type application/json
object
error
required
string
Example 
{
  "error": "you are already in this project"
}

429

Section titled “429 ”

Rate-limited: either the per-route throttle or a tenant quota. Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the window rolls over