LogoLogo
Go to app
  • Getting started
    • Authentication setup
    • Rate limits
    • Error handling
    • Pagination
  • CRM
    • People
  • Organizations
  • Segments
  • Workspaces
    • Workspaces
  • Tasks
  • Global
    • Tags
  • webhooks
    • Conversation
Powered by GitBook

(C) 2025 RogerRoger

On this page
Export as PDF

Tasks

PreviousWorkspacesNextTags

Last updated 2 days ago

Tasks are used on workspaces and can be connected to people, organizations, and conversations.

Good to know:

  • A task must always contain a title

  • A task must be part of a workspace

  • The type (task or deal) is determined by the workspace

Creates a Task resource.

post

Creates a Task resource.

Authorizations
Path parameters
idstringRequired

Task identifier

Responses
204
Task resource created
Responseany
400
Invalid input
403
Forbidden
422
An error occurred
post
POST /tasks/{id}/export HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Retrieves a Task resource.

get

Retrieves a Task resource.

Authorizations
Path parameters
idstringRequired

Task identifier

Responses
200
Task resource
403
Forbidden
404
Not found
get
GET /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "position": null,
  "totalComments": null,
  "title": null,
  "description": null,
  "isFlagged": null,
  "isSubTask": null,
  "indexNumber": null,
  "createdAt": null,
  "updatedAt": null,
  "completedAt": null,
  "archivedAt": null,
  "dueDate": null,
  "workspace": "https://example.com/",
  "status": "https://example.com/",
  "author": "https://example.com/",
  "parent": "https://example.com/",
  "tags": [
    "https://example.com/"
  ],
  "assignees": [
    "https://example.com/"
  ],
  "observers": [
    "https://example.com/"
  ],
  "subTasks": [
    "https://example.com/"
  ],
  "completedSubtasks": null,
  "totalSubtasks": null,
  "isTemplate": null,
  "storyPointEstimation": null,
  "timeEstimation": null,
  "dealSizeEstimation": null,
  "messageProvider": null,
  "scheduledOn": null,
  "previouslyScheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null,
  "isRecurring": null,
  "files": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "createdAt": null,
      "name": null,
      "size": null,
      "mimeType": null,
      "contentId": null,
      "updatedAt": null,
      "publicUrl": null
    }
  ],
  "messages": [
    "text"
  ],
  "conversationItems": [
    "https://example.com/"
  ],
  "people": [
    "https://example.com/"
  ],
  "organizations": [
    "https://example.com/"
  ],
  "recurringSettings": [
    "text"
  ],
  "automation": "https://example.com/",
  "startDate": null,
  "blockedFields": [
    "text"
  ]
}

Retrieves a TaskCommentResource resource.

get

Retrieves a TaskCommentResource resource.

Authorizations
Path parameters
taskIdstringRequired

TaskCommentResource identifier

idstringRequired

TaskCommentResource identifier

Responses
200
TaskCommentResource resource
403
Forbidden
404
Not found
get
GET /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}

Retrieves a TaskHistory resource.

get

Retrieves a TaskHistory resource.

Authorizations
Path parameters
taskIdstringRequired

TaskHistory identifier

idstringRequired

TaskHistory identifier

Responses
200
TaskHistory resource
403
Forbidden
404
Not found
get
GET /tasks/{taskId}/history/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "@id": "text",
  "@type": "text",
  "@context": "text",
  "id": "text",
  "createdAt": "2025-05-30T23:28:09.004Z",
  "changes": [
    "text"
  ],
  "author": "https://example.com/"
}

Retrieves the collection of Task resources.

get

Retrieves the collection of Task resources.

Authorizations
Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
author.idstringOptional
author.id[]string[]Optional
assignees.idstringOptional
assignees.id[]string[]Optional
observers.idstringOptional
observers.id[]string[]Optional
workspace.uuidstringOptional
workspace.uuid[]string[]Optional
status.uuidstringOptional
status.uuid[]string[]Optional
message.idstringOptional
message.id[]string[]Optional
tags.idstringOptional
tags.id[]string[]Optional
people.personIdstringOptional
people.personId[]string[]Optional
organizations.organizationIdstringOptional
organizations.organizationId[]string[]Optional
order[position]string · enumOptionalPossible values:
order[createdAt]string · enumOptionalPossible values:
order[dueDate]string · enumOptionalPossible values:
order[storyPointEstimation]string · enumOptionalPossible values:
order[timeEstimation]string · enumOptionalPossible values:
order[dealSizeEstimation]string · enumOptionalPossible values:
order[scheduledOn]string · enumOptionalPossible values:
completedAt[strictly_after]stringOptional
completedAt[after]stringOptional
completedAt[strictly_before]stringOptional
completedAt[before]stringOptional
archivedAt[strictly_after]stringOptional
archivedAt[after]stringOptional
archivedAt[strictly_before]stringOptional
archivedAt[before]stringOptional
dueDate[strictly_after]stringOptional
dueDate[after]stringOptional
dueDate[strictly_before]stringOptional
dueDate[before]stringOptional
createdAt[strictly_after]stringOptional
createdAt[after]stringOptional
createdAt[strictly_before]stringOptional
createdAt[before]stringOptional
scheduledOn[strictly_after]stringOptional
scheduledOn[after]stringOptional
scheduledOn[strictly_before]stringOptional
scheduledOn[before]stringOptional
snoozeUntil[strictly_after]stringOptional
snoozeUntil[after]stringOptional
snoozeUntil[strictly_before]stringOptional
snoozeUntil[before]stringOptional
startDate[strictly_after]stringOptional
startDate[after]stringOptional
startDate[strictly_before]stringOptional
startDate[before]stringOptional
exists[completedAt]booleanOptional
exists[archivedAt]booleanOptional
exists[snoozeUntil]booleanOptional
exists[assignees.id]booleanOptional
exists[workspace.uuid]booleanOptional
exists[message.id]booleanOptional
exists[tags.id]booleanOptional
exists[people.personId]booleanOptional
exists[organizations.organizationId]booleanOptional
exists[storyPointEstimation]booleanOptional
exists[dealSizeEstimation]booleanOptional
exists[timeEstimation]booleanOptional
qstringOptional
viewstring · enumOptional

Filter parameter to specify the view. To get only UUIDs, use 'idx'.

Possible values:
Responses
200
Task collection
403
Forbidden
get
GET /tasks HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "position": null,
      "totalComments": null,
      "title": null,
      "description": null,
      "isFlagged": null,
      "isSubTask": null,
      "indexNumber": null,
      "createdAt": null,
      "updatedAt": null,
      "completedAt": null,
      "archivedAt": null,
      "dueDate": null,
      "workspace": "https://example.com/",
      "status": "https://example.com/",
      "author": "https://example.com/",
      "parent": "https://example.com/",
      "tags": [
        "https://example.com/"
      ],
      "assignees": [
        "https://example.com/"
      ],
      "observers": [
        "https://example.com/"
      ],
      "subTasks": [
        "https://example.com/"
      ],
      "completedSubtasks": null,
      "totalSubtasks": null,
      "isTemplate": null,
      "storyPointEstimation": null,
      "timeEstimation": null,
      "dealSizeEstimation": null,
      "messageProvider": null,
      "scheduledOn": null,
      "previouslyScheduledOn": null,
      "plannedWeek": null,
      "plannedMonth": null,
      "snoozeUntil": null,
      "isRecurring": null,
      "files": [
        {
          "@context": "text",
          "@id": "text",
          "@type": "text",
          "id": null,
          "createdAt": null,
          "name": null,
          "size": null,
          "mimeType": null,
          "contentId": null,
          "updatedAt": null,
          "publicUrl": null
        }
      ],
      "messages": [
        "text"
      ],
      "conversationItems": [
        "https://example.com/"
      ],
      "people": [
        "https://example.com/"
      ],
      "organizations": [
        "https://example.com/"
      ],
      "recurringSettings": [
        "text"
      ],
      "automation": "https://example.com/",
      "startDate": null,
      "blockedFields": [
        "text"
      ]
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}

Retrieves the collection of TaskCommentResource resources.

get

Retrieves the collection of TaskCommentResource resources.

Authorizations
Path parameters
taskIdstringRequired

TaskCommentResource identifier

Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
createdAt[strictly_after]stringOptional
createdAt[after]stringOptional
createdAt[strictly_before]stringOptional
createdAt[before]stringOptional
flaggedbooleanOptional
author.idstringOptional
author.id[]string[]Optional
order[flagged]string · enumOptionalPossible values:
order[createdAt]string · enumOptionalPossible values:
Responses
200
TaskCommentResource collection
403
Forbidden
get
GET /tasks/{taskId}/comments HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "member": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "createdAt": null,
      "description": null,
      "flagged": null,
      "author": "https://example.com/",
      "mentions": [
        "https://example.com/"
      ]
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}

Retrieves the collection of TaskHistory resources.

get

Retrieves the collection of TaskHistory resources.

Authorizations
Path parameters
taskIdstringRequired

TaskHistory identifier

Query parameters
pageintegerOptional

The collection page number

Default: 1
itemsPerPageinteger · max: 30Optional

The number of items per page

Default: 15
order[createdAt]string · enumOptionalDefault: ascPossible values:
Responses
200
TaskHistory collection
403
Forbidden
get
GET /tasks/{taskId}/history HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Accept: */*
{
  "member": [
    {
      "@id": "text",
      "@type": "text",
      "@context": "text",
      "id": "text",
      "createdAt": "2025-05-30T23:28:09.004Z",
      "changes": [
        "text"
      ],
      "author": "https://example.com/"
    }
  ],
  "totalItems": 1,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "text",
    "template": "text",
    "variableRepresentation": "text",
    "mapping": [
      {
        "@type": "text",
        "variable": "text",
        "property": null,
        "required": true
      }
    ]
  }
}
  • POSTCreates a Task resource.
  • POSTCreates a Task resource.
  • POSTCreates a Task resource.
  • POSTCreates a TaskCommentResource resource.
  • GETRetrieves a Task resource.
  • GETRetrieves a TaskCommentResource resource.
  • PATCHUpdates the TaskCommentResource resource.
  • GETRetrieves a TaskHistory resource.
  • PUTReplaces the TaskCommentResource resource.
  • PATCHUpdates the UpdateTaskResource resource.
  • PUTReplaces the UpdateTaskResource resource.
  • GETRetrieves the collection of Task resources.
  • GETRetrieves the collection of TaskCommentResource resources.
  • GETRetrieves the collection of TaskHistory resources.

Creates a Task resource.

post

Creates a Task resource.

Authorizations
Body
parentstring | nullOptionalExample: https://example.com/
beforeTaskstring | nullOptionalExample: https://example.com/
afterTaskstring | nullOptionalExample: https://example.com/
positionTopboolean | nullOptional
participantsstring[]Optional
titlestring | nullRequired

Title of task

descriptionstring | nullOptional

Short description of task

statusstring | nullOptional

Workspace

Example: /workspaces/{workspaceId}/columns/{id}
authorstring | nullOptional

Author of this task

Example: /users/{id}
assigneesobject[]Optional

Assignees belonging to this task

Example: ["/users/{id}"]
observersobject[]Optional

Obersers belonging to this task

Example: ["/users/{id}"]
isFlaggedbooleanOptional

Highlight this task

archivedAtstring | nullOptional

Archive task

dueDatestring | nullOptional

Date when this task is due

isTemplatebooleanOptional

Task is a template

storyPointEstimationinteger | nullOptional
dealSizeEstimationinteger | nullOptional
timeEstimationinteger | null · max: 4294967295Optional
scheduledOnstring | nullOptional

Date when task is scheduled

plannedWeekstring | nullOptional

Date when task is planned in week

plannedMonthstring | nullOptional

Date when task is planned in month

snoozeUntilstring | nullOptional

Snooze task until

Responses
201
Task resource created
400
Invalid input
403
Forbidden
422
An error occurred
post
POST /tasks HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 714

{
  "parent": "https://example.com/",
  "beforeTask": "https://example.com/",
  "afterTask": "https://example.com/",
  "positionTop": null,
  "participants": [
    "text"
  ],
  "title": null,
  "description": null,
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "author": "/users/{id}",
  "assignees": [
    "/users/{id}"
  ],
  "observers": [
    "/users/{id}"
  ],
  "tags": [
    "/tags/{id}"
  ],
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ],
  "messages": [
    "/messages/{id}"
  ],
  "conversationItems": [
    "/conversations/{conversationId}/items/{id}"
  ],
  "isFlagged": true,
  "archivedAt": null,
  "dueDate": null,
  "isTemplate": true,
  "storyPointEstimation": null,
  "dealSizeEstimation": null,
  "timeEstimation": null,
  "scheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "position": null,
  "totalComments": null,
  "title": null,
  "description": null,
  "isFlagged": null,
  "isSubTask": null,
  "indexNumber": null,
  "createdAt": null,
  "updatedAt": null,
  "completedAt": null,
  "archivedAt": null,
  "dueDate": null,
  "workspace": "https://example.com/",
  "status": "https://example.com/",
  "author": "https://example.com/",
  "parent": "https://example.com/",
  "tags": [
    "https://example.com/"
  ],
  "assignees": [
    "https://example.com/"
  ],
  "observers": [
    "https://example.com/"
  ],
  "subTasks": [
    "https://example.com/"
  ],
  "completedSubtasks": null,
  "totalSubtasks": null,
  "isTemplate": null,
  "storyPointEstimation": null,
  "timeEstimation": null,
  "dealSizeEstimation": null,
  "messageProvider": null,
  "scheduledOn": null,
  "previouslyScheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null,
  "isRecurring": null,
  "files": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "createdAt": null,
      "name": null,
      "size": null,
      "mimeType": null,
      "contentId": null,
      "updatedAt": null,
      "publicUrl": null
    }
  ],
  "messages": [
    "text"
  ],
  "conversationItems": [
    "https://example.com/"
  ],
  "people": [
    "https://example.com/"
  ],
  "organizations": [
    "https://example.com/"
  ],
  "recurringSettings": [
    "text"
  ],
  "automation": "https://example.com/",
  "startDate": null,
  "blockedFields": [
    "text"
  ]
}

Creates a Task resource.

post

Creates a Task resource.

Authorizations
Path parameters
idstringRequired

Task identifier

Body

Duplicate task

statusstring | nullOptional

Set status

Example: /workspaces/{workspaceId}/columns/{id}
titlestring | nullOptionalExample: Title based on task to be copied
isTemplatebooleanOptional
Responses
201
Task resource created
400
Invalid input
403
Forbidden
422
An error occurred
post
POST /tasks/{id}/duplicate HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 178

{
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "title": "Title based on task to be copied",
  "isTemplate": true,
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ]
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "position": null,
  "totalComments": null,
  "title": null,
  "description": null,
  "isFlagged": null,
  "isSubTask": null,
  "indexNumber": null,
  "createdAt": null,
  "updatedAt": null,
  "completedAt": null,
  "archivedAt": null,
  "dueDate": null,
  "workspace": "https://example.com/",
  "status": "https://example.com/",
  "author": "https://example.com/",
  "parent": "https://example.com/",
  "tags": [
    "https://example.com/"
  ],
  "assignees": [
    "https://example.com/"
  ],
  "observers": [
    "https://example.com/"
  ],
  "subTasks": [
    "https://example.com/"
  ],
  "completedSubtasks": null,
  "totalSubtasks": null,
  "isTemplate": null,
  "storyPointEstimation": null,
  "timeEstimation": null,
  "dealSizeEstimation": null,
  "messageProvider": null,
  "scheduledOn": null,
  "previouslyScheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null,
  "isRecurring": null,
  "files": [
    {
      "@context": "text",
      "@id": "text",
      "@type": "text",
      "id": null,
      "createdAt": null,
      "name": null,
      "size": null,
      "mimeType": null,
      "contentId": null,
      "updatedAt": null,
      "publicUrl": null
    }
  ],
  "messages": [
    "text"
  ],
  "conversationItems": [
    "https://example.com/"
  ],
  "people": [
    "https://example.com/"
  ],
  "organizations": [
    "https://example.com/"
  ],
  "recurringSettings": [
    "text"
  ],
  "automation": "https://example.com/",
  "startDate": null,
  "blockedFields": [
    "text"
  ]
}

Creates a TaskCommentResource resource.

post

Creates a TaskCommentResource resource.

Authorizations
Path parameters
taskIdstringRequired

TaskCommentResource identifier

Body
@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
taskIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
flaggedboolean | nullOptional
authorstring | nullOptionalExample: https://example.com/
mentionsstring · iri-reference[]OptionalExample: https://example.com/
Responses
201
TaskCommentResource resource created
400
Invalid input
403
Forbidden
422
An error occurred
post
POST /tasks/{taskId}/comments HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 144

{
  "id": null,
  "taskId": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}

Updates the TaskCommentResource resource.

patch

Updates the TaskCommentResource resource.

Authorizations
Path parameters
taskIdstringRequired

TaskCommentResource identifier

idstringRequired

TaskCommentResource identifier

Body
idstring | nullOptional
taskIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
flaggedboolean | nullOptional
authorstring | nullOptionalExample: https://example.com/
mentionsstring · iri-reference[]OptionalExample: https://example.com/
Responses
200
TaskCommentResource resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
patch
PATCH /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 144

{
  "id": null,
  "taskId": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}

Replaces the TaskCommentResource resource.

put

Replaces the TaskCommentResource resource.

Authorizations
Path parameters
taskIdstringRequired

TaskCommentResource identifier

idstringRequired

TaskCommentResource identifier

Body
@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
idstring | nullOptional
taskIdstring | nullWrite-onlyOptional
createdAtstring | nullOptional
descriptionstring | nullRequired
flaggedboolean | nullOptional
authorstring | nullOptionalExample: https://example.com/
mentionsstring · iri-reference[]OptionalExample: https://example.com/
Responses
200
TaskCommentResource resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
put
PUT /tasks/{taskId}/comments/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 144

{
  "id": null,
  "taskId": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "id": null,
  "createdAt": null,
  "description": null,
  "flagged": null,
  "author": "https://example.com/",
  "mentions": [
    "https://example.com/"
  ]
}

Updates the UpdateTaskResource resource.

patch

Updates the UpdateTaskResource resource.

Authorizations
Path parameters
idstringRequired

UpdateTaskResource identifier

Body
completedAtstring | nullOptional

Task is completed at

filesstring · iri-reference[]OptionalExample: https://example.com/
recurringSettingsany ofOptional
or
nullOptional
idstring | nullOptional
titlestring | nullRequired

Title of task

descriptionstring | nullOptional

Short description of task

statusstring | nullOptional

Workspace

Example: /workspaces/{workspaceId}/columns/{id}
authorstring | nullOptional

Author of this task

Example: /users/{id}
assigneesstring · iri-reference[]Optional

Assignees belonging to this task

Example: ["/users/{id}"]
observersstring · iri-reference[]Optional

Obersers belonging to this task

Example: ["/users/{id}"]
tagsstring · iri-reference[]Optional

Tags of this task

Example: ["/tags/{id}"]
peoplestring · iri-reference[]Optional

People belonging to this task

Example: ["/people/{id}"]
organizationsstring · iri-reference[]Optional

Organizations belonging to this task

Example: ["/organizations/{id}"]
messagesstring · iri-reference[]Optional

Messages belonging to this task

Example: ["/messages/{id}"]
conversationItemsstring · iri-reference[]Optional

Messages belonging to this task

Example: ["/conversations/{conversationId}/items/{id}"]
isFlaggedbooleanOptional

Highlight this task

archivedAtstring | nullOptional

Archive task

dueDatestring | nullOptional

Date when this task is due

isTemplatebooleanOptional

Task is a template

storyPointEstimationinteger | nullOptional
dealSizeEstimationinteger | nullOptional
timeEstimationinteger | null · max: 4294967295Optional
scheduledOnstring | nullOptional

Date when task is scheduled

plannedWeekstring | nullOptional

Date when task is planned in week

plannedMonthstring | nullOptional

Date when task is planned in month

snoozeUntilstring | nullOptional

Snooze task until

Responses
200
UpdateTaskResource resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
patch
PATCH /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 782

{
  "completedAt": null,
  "files": [
    "https://example.com/"
  ],
  "recurringSettings": {
    "rrule": null,
    "recurUntilCount": 1,
    "recurUntil": null,
    "recurOnSchedule": true,
    "createNewTask": true,
    "snooze": true,
    "recurData": [
      "text"
    ]
  },
  "id": null,
  "title": null,
  "description": null,
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "author": "/users/{id}",
  "assignees": [
    "/users/{id}"
  ],
  "observers": [
    "/users/{id}"
  ],
  "tags": [
    "/tags/{id}"
  ],
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ],
  "messages": [
    "/messages/{id}"
  ],
  "conversationItems": [
    "/conversations/{conversationId}/items/{id}"
  ],
  "isFlagged": true,
  "archivedAt": null,
  "dueDate": null,
  "isTemplate": true,
  "storyPointEstimation": null,
  "dealSizeEstimation": null,
  "timeEstimation": null,
  "scheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "completedAt": null,
  "files": [
    "https://example.com/"
  ],
  "recurringSettings": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "rrule": null,
    "recurUntilCount": 1,
    "recurUntil": null,
    "recurOnSchedule": true,
    "createNewTask": true,
    "snooze": true,
    "recurData": [
      "text"
    ]
  },
  "id": null,
  "title": null,
  "description": null,
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "author": "/users/{id}",
  "assignees": [
    "/users/{id}"
  ],
  "observers": [
    "/users/{id}"
  ],
  "tags": [
    "/tags/{id}"
  ],
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ],
  "messages": [
    "/messages/{id}"
  ],
  "conversationItems": [
    "/conversations/{conversationId}/items/{id}"
  ],
  "isFlagged": true,
  "archivedAt": null,
  "dueDate": null,
  "isTemplate": true,
  "storyPointEstimation": null,
  "dealSizeEstimation": null,
  "timeEstimation": null,
  "scheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null
}

Replaces the UpdateTaskResource resource.

put

Replaces the UpdateTaskResource resource.

Authorizations
Path parameters
idstringRequired

UpdateTaskResource identifier

Body
@contextone ofRead-onlyOptional
stringOptional
or
@idstringRead-onlyOptional
@typestringRead-onlyOptional
completedAtstring | nullOptional

Task is completed at

filesstring · iri-reference[]OptionalExample: https://example.com/
recurringSettingsany ofOptional
or
nullOptional
idstring | nullOptional
titlestring | nullRequired

Title of task

descriptionstring | nullOptional

Short description of task

statusstring | nullOptional

Workspace

Example: /workspaces/{workspaceId}/columns/{id}
authorstring | nullOptional

Author of this task

Example: /users/{id}
assigneesstring · iri-reference[]Optional

Assignees belonging to this task

Example: ["/users/{id}"]
observersstring · iri-reference[]Optional

Obersers belonging to this task

Example: ["/users/{id}"]
tagsstring · iri-reference[]Optional

Tags of this task

Example: ["/tags/{id}"]
peoplestring · iri-reference[]Optional

People belonging to this task

Example: ["/people/{id}"]
organizationsstring · iri-reference[]Optional

Organizations belonging to this task

Example: ["/organizations/{id}"]
messagesstring · iri-reference[]Optional

Messages belonging to this task

Example: ["/messages/{id}"]
conversationItemsstring · iri-reference[]Optional

Messages belonging to this task

Example: ["/conversations/{conversationId}/items/{id}"]
isFlaggedbooleanOptional

Highlight this task

archivedAtstring | nullOptional

Archive task

dueDatestring | nullOptional

Date when this task is due

isTemplatebooleanOptional

Task is a template

storyPointEstimationinteger | nullOptional
dealSizeEstimationinteger | nullOptional
timeEstimationinteger | null · max: 4294967295Optional
scheduledOnstring | nullOptional

Date when task is scheduled

plannedWeekstring | nullOptional

Date when task is planned in week

plannedMonthstring | nullOptional

Date when task is planned in month

snoozeUntilstring | nullOptional

Snooze task until

Responses
200
UpdateTaskResource resource updated
400
Invalid input
403
Forbidden
404
Not found
422
An error occurred
put
PUT /tasks/{id} HTTP/1.1
Host: api.rogerroger.io
X-API-KEY: YOUR_API_KEY
Content-Type: application/ld+json
Accept: */*
Content-Length: 782

{
  "completedAt": null,
  "files": [
    "https://example.com/"
  ],
  "recurringSettings": {
    "rrule": null,
    "recurUntilCount": 1,
    "recurUntil": null,
    "recurOnSchedule": true,
    "createNewTask": true,
    "snooze": true,
    "recurData": [
      "text"
    ]
  },
  "id": null,
  "title": null,
  "description": null,
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "author": "/users/{id}",
  "assignees": [
    "/users/{id}"
  ],
  "observers": [
    "/users/{id}"
  ],
  "tags": [
    "/tags/{id}"
  ],
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ],
  "messages": [
    "/messages/{id}"
  ],
  "conversationItems": [
    "/conversations/{conversationId}/items/{id}"
  ],
  "isFlagged": true,
  "archivedAt": null,
  "dueDate": null,
  "isTemplate": true,
  "storyPointEstimation": null,
  "dealSizeEstimation": null,
  "timeEstimation": null,
  "scheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null
}
{
  "@context": "text",
  "@id": "text",
  "@type": "text",
  "completedAt": null,
  "files": [
    "https://example.com/"
  ],
  "recurringSettings": {
    "@context": "text",
    "@id": "text",
    "@type": "text",
    "rrule": null,
    "recurUntilCount": 1,
    "recurUntil": null,
    "recurOnSchedule": true,
    "createNewTask": true,
    "snooze": true,
    "recurData": [
      "text"
    ]
  },
  "id": null,
  "title": null,
  "description": null,
  "status": "/workspaces/{workspaceId}/columns/{id}",
  "author": "/users/{id}",
  "assignees": [
    "/users/{id}"
  ],
  "observers": [
    "/users/{id}"
  ],
  "tags": [
    "/tags/{id}"
  ],
  "people": [
    "/people/{id}"
  ],
  "organizations": [
    "/organizations/{id}"
  ],
  "messages": [
    "/messages/{id}"
  ],
  "conversationItems": [
    "/conversations/{conversationId}/items/{id}"
  ],
  "isFlagged": true,
  "archivedAt": null,
  "dueDate": null,
  "isTemplate": true,
  "storyPointEstimation": null,
  "dealSizeEstimation": null,
  "timeEstimation": null,
  "scheduledOn": null,
  "plannedWeek": null,
  "plannedMonth": null,
  "snoozeUntil": null
}