favorites

Create a favorite

This endpoint allows the creation of a favorite given some parameters. The workspace is required, as well as either description or project (no favorite without both will be accepted). The user is also required, but it already goes in the authentication. Also, the user must have access to all resources being referenced in the favorite attributes, and these resources should have valid relationships. For instance, if you want a favorite in a given workspace and with some tags, the tags must belong to that workspace. In case of user having no access to an attribute, a 403 status is returned, if the attributes don't relate correctly between themselves the status returned will be 400.

post/me/favorites

Request

Query parameters

metaboolean

Should the response contain data for meta entities

Request body

billableboolean
descriptionstring
project_idinteger
tag_idsinteger[]
task_idinteger
workspace_idinteger

Example request

{
  "billable": true,
  "description": "Very often used TE",
  "project_id": 222222,
  "tag_ids": [
    100
  ],
  "task_id": 333333,
  "workspace_id": 111111
}

Response

Created favorite with its ID

billableboolean
client_namestring

Related entities meta fields - if requested

created_atstring
deleted_atstring
descriptionstring
favorite_idinteger
project_activeboolean
project_colorstring
project_idinteger
project_namestring
publicboolean
rankinteger
tag_idsinteger[]

tag IDs are loaded into this after loading the Favorite

task_idinteger
task_namestring
workspace_idinteger

Changes

No recorded changes to this operation across all 1 revision of this API.