Template (Deprecated)

Create templates on a workspace

Changed on
post/v1/workspaces/{workspaceId}/templates

Request

  • Base URL: https://api.clockify.me/api
  • URL: https://api.clockify.me/api/v1/workspaces/{workspaceId}/templates
  • Auth: one of:
    • API key in header x-api-key
    • API key in header x-addon-token

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Request body

namestring required

Represents a template name.

timeEntryIdsstring[]

Represents a set of template time entry ids.

timeViewModestring
weekStartstring date

Represents a date of the starting day of the week in the yyyy-MM-dd format.

Example request

[
  {
    "name": "exampleTemplate",
    "projectsAndTasks": [
      {
        "projectId": "25b687e29ae1f428e7ebe123",
        "taskId": "54m377ddd3fcab07cfbb432w",
        "type": "REGULAR"
      }
    ],
    "timeEntryIds": [
      "64c777ddd3fcab07cfbb210c"
    ],
    "weekStart": "2019-08-24"
  }
]

Response

OK

idstring

Represents a template identifier across the system.

namestring

Represents a template name.

userIdstring

Represents a user identifier across the system.

weekStartstring date

Represents a day of the week.

workspaceIdstring

Represents a workspace identifier across the system.

Example response

[
  {
    "entries": [
      {
        "customFieldValues": [
          {
            "customFieldId": "44a687e29ae1f428e7ebe305",
            "sourceType": "WORKSPACE",
            "timeEntryId": "64c777ddd3fcab07cfbb210c"
          }
        ],
        "description": "This is a sample time entry description.",
        "id": "64c777ddd3fcab07cfbb210c",
        "projectId": "25b687e29ae1f428e7ebe123",
        "tagIds": [
          "321r77ddd3fcab07cfbb567y",
          "44x777ddd3fcab07cfbb88f"
        ],
        "taskId": "54m377ddd3fcab07cfbb432w",
        "timeInterval": {
          "duration": "PT1H30M"
        },
        "type": "REGULAR",
        "userId": "5a0ab5acb07987125438b60f",
        "workspaceId": "64a687e29ae1f428e7ebe303"
      }
    ],
    "id": "5b6d45c4b0798751107762b8",
    "name": "exampleTemplate",
    "projectsAndTasks": [
      {
        "projectId": "25b687e29ae1f428e7ebe123",
        "taskId": "54m377ddd3fcab07cfbb432w"
      }
    ],
    "userId": "89b687e29ae1f428e7ebe912",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]

Changes

    • info

      added the new optional request property /

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the request property default value was added

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status

    • info

      the response's property default value was added for the status