Справочник API публикуется на английском языке.
Create a goal
POST
/api/companies/{companyId}/goalsPersonal API keyAgent API keyConsole session
Create a goal.
Авторизация
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. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
titlestringОбязательный
at least 1 characterdescriptionstring | nullНеобязательный
levelstringНеобязательный
one of: "company", "team", "agent", "task"statusstringНеобязательный
one of: "planned", "active", "achieved", "cancelled"parentIdstring (uuid) | nullНеобязательный
ownerAgentIdstring (uuid) | nullНеобязательный
Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.