api/docs/project/join.md

33 lines
1.2 KiB
Markdown

# `/project/join` - POST
Lets the authenticated account join the project.
## Urlencoded Parameters
You have to set one parameter.
Setting none or two parameters will result in a _400 Bad Request_ Response.
| Parameter | Description |
|-----------|-----------------------------------------------------------------------|
| name | The projectname of the user on which the operation will be performed. |
| id | The projectid of the user on which the operation will be performed. |
## HTTP Headers
| Header | Content |
|---------------|--------------------|
| Authorization | `Bearer {token}` |
| Content-Type | `application/json` |
## Content - JSON
| Field | Description |
|---------|-----------------------------------------------------------|
| message | The request message the projects maintainers will review. |
## Responses
### 200 - Success
Your request will be reviewed.
### 208 - Already Reported
You already joined the project.
### 400 - Error: Bad Request
The request was malformed.
### 403 - Error: Forbidden
Blocked for security reasons.
### 404 - Error: Not Found
The project wasn't found.