Guides

Criar Workflow

Suggest Edits

Através desse endpoint, poderemos criar grupos de trabalho para facilitar nossa gestão de documentos.

POST /workflows

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

⚠️ Os workflows representam um grupo de informações dentro da organização onde apenas usuários que fazem parte deste grupo podem realizar ações como por exemplo: criar, editar e deletar contratos.

Exemplo de payload:

{ 
  "workflow": { 
    "name": "Título para o workflow"
  } 
}

Descrição do payload:

NameTypeDescription
name *stringtítulo do grupo

🚨 Os campos marcados com * são obrigatórios.

Exemplo de resposta:

{
    "data": {
        "contracts_count": null,
        "id": 2385,
        "inserted_at": "2024-05-22T14:45:35",
        "is_default": false,
        "name": "Título para o workflow",
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-17T13:36:23",
            "workflows": null
        },
        "statuses": null,
        "updated_at": "2024-05-22T14:45:35",
        "users": []
    }
}

Como criar grupos?

Acesse nossa central de ajuda e veja o passo a passo completo:

Como adicionar usuários e criar grupos?

Updated 3 months ago