Update the board associated with an Issue or Pull Request¶
PUT /api/v5/org/{owner}/kanban/repo/{repo}/{type}/{iid}
This endpoint updates the board associated with the specified Issue or Pull Request. When calling it, provide the target board ID in the request body; the system re-binds the association between the Issue or Pull Request and the corresponding board, and returns an empty object on success.
Access token support¶
- AtomGit user access token (AtomGit user access tokens)
Anonymous access¶
This endpoint allows anonymous access.
Request parameters¶
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
owner |
path | string | Yes | Organization path |
repo |
path | string | Yes | Repository path |
type |
path | string | Yes | Type; enum: issue / merge_request |
iid |
path | string | Yes | IID of the Issue or Pull Request |
Request Body:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"kanban_id": {
"description": "Board ID",
"type": "string"
}
},
"required": ["kanban_id"]
}
Response parameters¶
On success, the response body is an empty JSON object {} with no business fields.
Error responses¶
This endpoint has no business error responses.
HTTP response status codes¶
| Status code | Description |
|---|---|
200 |
Success (OK) |
400 |
Invalid parameters (Bad Request) |
401 |
Requires authentication |
403 |
Forbidden |
404 |
Request path does not exist (Not Found) |
500 |
Internal system error (Internal Server Error) |
Request example¶
Parameter description¶
Replace <owner> with the organization path (the address path of an enterprise, organization, or individual); replace <repo> with the repository path; replace <type> with issue or merge_request; replace <iid> with the IID of the Issue or Pull Request; replace <kanban_id> with the board ID. This endpoint allows anonymous access; you may also carry an AtomGit user access token.
cURL¶
curl -X PUT 'https://api.atomgit.com/api/v5/org/<owner>/kanban/repo/<repo>/<type>/<iid>' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"kanban_id": "<kanban_id>"}'
JavaScript¶
// Native fetch (Node.js 18+ / browser)
const response = await fetch("https://api.atomgit.com/api/v5/org/<owner>/kanban/repo/<repo>/<type>/<iid>", {
method: "PUT",
headers: {
"Content-Type": "application/json",
"Accept": "application/json",
},
body: JSON.stringify({
kanban_id: "<kanban_id>",
}),
});
if (!response.ok) {
throw new Error(`Request failed: ${response.status}`);
}
console.log(await response.json());
Python¶
import requests
resp = requests.put(
"https://api.atomgit.com/api/v5/org/<owner>/kanban/repo/<repo>/<type>/<iid>",
json={"kanban_id": "<kanban_id>"},
headers={"Accept": "application/json"},
timeout=10,
)
resp.raise_for_status()
print(resp.json())
Response example¶
Status code: 200
Error codes¶
| Error code | Description |
|---|---|
401 |
Unauthenticated or invalid credentials (missing or invalid access credentials) |
400 |
Invalid parameters or unparseable request |
404 |
Request path does not exist |
405 |
Request method not supported |
429 |
Too many requests; rate limit triggered |
500 |
Internal system error |
Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc