Criar um status

POST https://.account-name.krzlabs.io/api/v1/status

Realiza a criação de um status.


Body Params

Field Type Description Optional Searchable
name string Nome descritivo do item not required true
code string Código único de identificação do item required true
color string Cor associada ao item (ex.: código HEX ou nome da cor) not required false
enabled boolean Indica se o item está ativo not required false
notify boolean Indica se o item deve disparar notificações not required false
tags Array(string) Lista de tags ou palavras-chave associadas ao item not required false
outcome enum(StatusOutcomeEnum) Resultado ou status associado ao item (padrão: void)
Possíveis opções:
'void' = 'void',
'cancel' = 'cancel',
'done' = 'done'
not required false
{
    "name": "Status de Pedido",
    "code": "ST001",
    "color": "#FF0000",
    "enabled": true,
    "notify": false,
    "tags": ["urgente", "interno"],
    "outcome": "void"
}

Response

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
name string Nome descritivo do item not required true
code string Código único de identificação do item required true
color string Cor associada ao item (ex.: código HEX ou nome da cor) not required false
enabled boolean Indica se o item está ativo not required false
notify boolean Indica se o item deve disparar notificações not required false
tags Array(string) Lista de tags ou palavras-chave associadas ao item not required false
outcome enum(StatusOutcomeEnum) Resultado ou status associado ao item (padrão: void)
Possíveis opções:
'void' = 'void',
'cancel' = 'cancel',
'done' = 'done'
not required false
step_code string Código do passo associado ao status. Not required false

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved