Axuz Developers

POST /teams/{teamId}/tasks/{id}/deliverables

Gate de escrita → body (400) → conteúdo validado (413/422) → 1 tx.

  • Access: Team member
  • 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`.

Gate de escrita → body (400) → conteúdo validado (413/422) → 1 tx.

createDeliverableHandler — POST .../tasks/{id}/deliverables.

Retorno: 201; 400; 401; 403; 404; 413; 422; 500. Fluxo: "adicionar entrega" no card.

Parameters

NameInTypeRequiredDescription
teamIdpathstringyes
idpathstringyes

Request body

application/json · Required

NameTypeRequiredDescription
kindstringno

Obrigatorio no POST; imutavel no PATCH

enum: "text", "link", "file"

titlestringno
bodystringno

markdown (kind=text)

urlstringno

https (kind=link)

fileDeliverableFileno
file.file_idstring<uuid>yes
file.namestringyes
file.mimestringyes
file.sizeintegeryes
positionnumberno
{
  "kind": "text",
  "title": "string",
  "body": "string",
  "url": "string",
  "file": {
    "file_id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "mime": "string",
    "size": 1
  },
  "position": 1
}

Responses

201

Criada

NameTypeRequiredDescription
idstring<uuid>yes
team_idstring<uuid>yes
task_idstring<uuid>yes
kindstringyes

enum: "text", "link", "file"

titlestringno
bodystringno

markdown CRU (a sanitizacao e na renderizacao)

urlstringno
fileDeliverableFileno
file.file_idstring<uuid>yes
file.namestringyes
file.mimestringyes
file.sizeintegeryes
positionnumberyes
created_bystring<uuid>yes
created_atstring<date-time>yes
updated_atstring<date-time>yes

400

Erro ({"error": "..."})

NameTypeRequiredDescription
errorstringyes

401

Sem credencial valida

NameTypeRequiredDescription
errorstringyes

403

Erro ({"error": "..."})

NameTypeRequiredDescription
errorstringyes

404

Erro ({"error": "..."})

NameTypeRequiredDescription
errorstringyes

413

Erro ({"error": "..."})

NameTypeRequiredDescription
errorstringyes

422

Erro ({"error": "..."})

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

. Fluxo: "adicionar entrega" no card

NameTypeRequiredDescription
errorstringyes

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/tasks/ID/deliverables' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind":"text","title":"string","body":"string","url":"string","file":{"file_id":"00000000-0000-0000-0000-000000000000","name":"string","mime":"string","size":1},"position":1}'

Node.js

const res = await fetch("https://api-workspace.axuz.net/teams/TEAM_ID/tasks/ID/deliverables", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "kind": "text",
    "title": "string",
    "body": "string",
    "url": "string",
    "file": {
      "file_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "mime": "string",
      "size": 1
    },
    "position": 1
  }),
});
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/tasks/ID/deliverables",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "kind": "text",
        "title": "string",
        "body": "string",
        "url": "string",
        "file": {
            "file_id": "00000000-0000-0000-0000-000000000000",
            "name": "string",
            "mime": "string",
            "size": 1,
        },
        "position": 1,
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())