La referencia de la API se publica en inglés.
Create a goal
POST
/api/companies/{companyId}/goalsPersonal API keyAgent API keyConsole session
Create a goal.
Autorización
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.
Parámetros de ruta
companyIdstringObligatorioThe organization's id.
Cuerpo de la solicitud
application/json · obligatorio
titlestringObligatorio
at least 1 characterdescriptionstring | nullOpcional
levelstringOpcional
one of: "company", "team", "agent", "task"statusstringOpcional
one of: "planned", "active", "achieved", "cancelled"parentIdstring (uuid) | nullOpcional
ownerAgentIdstring (uuid) | nullOpcional
Respuestas
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.