Checklist

O Zammad tem diferentes endpoints de checklist:

• Checklists
• Itens de checklist
• Modelos de checklist

INFO

Modelos de checklist incluem seus itens, enquanto a checklist padrão tem um endpoint de item separado.

Checklists

INFO

Para adicionar itens de checklist, use o endpoint de itens de checklist.

Mostrar

Permissão necessária: ticket.agent

Solicitação GET enviada: /api/v1/checklists/{checklist id}

Details

// HTTP-Code 200 OK

{
  "name": "Return order",
  "sorted_item_ids": [
    "18",
    "19",
    "20",
    "21"
  ],
  "updated_by_id": 3,
  "created_by_id": 3,
  "ticket_id": 4,
  "id": 6,
  "created_at": "2024-10-15T08:47:50.860Z",
  "updated_at": "2024-10-15T08:50:52.698Z",
  "item_ids": [
    18,
    19,
    20,
    21
  ]
}

TIP

Você pode encontrar o atributo checklist_id de um ticket enviando uma solicitação GET para /api/v1/tickets/{ticket id}.

Criar

Permissão necessária: ticket.agent

Solicitação POST enviada: /api/v1/checklists

Details

{
  "ticket_id": 7,
  "template_id": 1
}

Atualização

Permissão necessária: ticket.agent

Solicitação PATCH enviada: /api/v1/checklists/{checklist id}

Details

{
  "name": "New checklist name",
  "sorted_item_ids": [
    "34",
    "33",
    "32"
  ]
}

Excluir

Permissão necessária: ticket.agent

Solicitação DELETE enviada: /api/v1/checklists/{checklist id}

Details

// HTTP-Code 200 OK

Itens de checklist

Mostrar

Permissão necessária: ticket.agent

Solicitação GET enviada: /api/v1/checklist_items/{checklist item id}

Details

// HTTP-Code 200 OK

{
  "text": "Hand over the goods to the shipping company",
  "checked": false,
  "updated_by_id": 3,
  "ticket_id": null,
  "created_by_id": 3,
  "checklist_id": 6,
  "id": 20,
  "created_at": "2024-10-15T08:48:14.216Z",
  "updated_at": "2024-10-15T08:49:10.467Z"
}

Criar

Permissão necessária: ticket.agent

Solicitação POST enviada: /api/v1/checklist_items

Details

{
  "text": "New Item via API!",
  "checklist_id": 12,
  "checked": false
}

Atualização

Permissão necessária: ticket.agent

Solicitação PATCH enviada: /api/v1/checklist_items/{checklist item id}

Details

{
  "text": "Changed checklist item",
  "checked": true
}

Excluir

Permissão necessária: ticket.agent

Solicitação DELETE enviada: /api/v1/checklist_items/{checklist item id}

Details

// HTTP-Code 200 OK

Modelos de checklist

Listar

Permissão necessária: admin.checklists

Solicitação GET enviada: /api/v1/checklist_templates

Details

{
  "id": 3,
  "name": "My checklist template",
  "active": true,
  "sorted_item_ids": [
    "7",
    "8",
    "9"
  ],
  "created_by_id": 3,
  "updated_by_id": 3,
  "created_at": "2026-04-07T12:43:21.347Z",
  "updated_at": "2026-04-07T12:43:21.378Z",
  "item_ids": [
    7,
    8,
    9
  ]
},
{
  "id": 4,
  "name": "Onboarding",
  "active": true,
  "sorted_item_ids": [
    "10",
    "11",
    "12",
    "13"
  ],
  "created_by_id": 3,
  "updated_by_id": 3,
  "created_at": "2026-04-07T12:45:11.249Z",
  "updated_at": "2026-04-07T12:45:11.269Z",
  "item_ids": [
    10,
    11,
    12,
    13
  ]
}

Mostrar

Permissão necessária: admin.checklists ou ticket.agent

Solicitação GET enviada: /api/v1/checklist_templates/{checklist template id}

Details

// HTTP-Code 200 OK

{
  "name": "Return order",
  "active": true,
  "updated_by_id": 3,
  "created_by_id": 3,
  "id": 28,
  "sorted_item_ids": [
    "18",
    "19",
    "20",
    "21"
  ],
  "created_at": "2024-10-15T12:43:14.642Z",
  "updated_at": "2024-10-15T12:43:34.242Z",
  "item_ids": [
    18,
    19,
    20,
    21
  ]
}

Criar

Permissão necessária: admin.checklists

Solicitação POST enviada: /api/v1/checklist_templates

Details

{
  "name": "My checklist template",
  "active": true,
  "items": [
    "Item 1",
    "Item 2",
    "Item 3"
  ]
}

Atualização

Permissão necessária: admin.checklists

Solicitação PATCH enviada: /api/v1/checklist_templates/{checklist template id}

Details

// HTTP-Code 200 OK

{
  "name": "My changed checklist template name",
  "active": true,
  "items": [
    "Item 7",
    "Item 8",
    "Item 9"
  ]
}

Excluir

Permissão necessária: admin.checklists

Solicitação DELETE enviada: /api/v1/checklist_templates/{checklist template id}

Details

// HTTP-Code 200 OK