POST /teams/{teamId}/timelines/{timelineId}/posts/{postId}/pin
— POST /teams/{teamId}/timelines/{timelineId}/posts/{postId}/pin.
- Access: Member with scope
- Service:
https://api-workspace.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
— POST /teams/{teamId}/timelines/{timelineId}/posts/{postId}/pin.
Motivo: fixar post no header do canal. Idempotente.
Retorno: 200 {ok,created}; 400 uuid inválido; 500. Efeito: 1 INSERT em pinned_posts + 1 UPDATE em timeline_posts.is_pinned.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
timelineId | path | string | yes | |
postId | path | string | yes |
Request body
Corpo JSON. O schema detalhado deste endpoint ainda não está tipado na spec; veja a descrição da operação.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
(corpo) | object | no |
{}Responses
200
TBD
400
Uuid inválido
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
. Efeito: 1 INSERT em pinned_posts + 1 UPDATE em timeline_posts.is_pinned
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X POST 'https://api-workspace.axuz.net/teams/TEAM_ID/timelines/TIMELINE_ID/posts/POST_ID/pin' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'Node.js
const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/timelines/TIMELINE_ID/posts/POST_ID/pin", {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"POST",
"https://api-workspace.axuz.net/teams/TEAM_ID/timelines/TIMELINE_ID/posts/POST_ID/pin",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={},
timeout=30,
)
res.raise_for_status()
print(res.json())