{"id":"24f9494a-8a43-4972-a362-b045d85e0930","createdDate":"2024-05-29T06:16:55.784Z","updatedDate":"2024-05-29T06:16:55.784Z","resourceId":"df9d892d-634d-4059-bb11-41600b7490e8","api":{"schema":{"object":{"displayName":"Task Object","description":"The `task` object represents all information available for tasks. A task is a specific action or assignment to be completed.","slug":"task-object","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","legacyExamples":[{"title":"Task","content":"{\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"2\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"APP\",\n \"appId\": \"3b916b16-1f2b-4844-8182-96c1deeecee5\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/\"\n }\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git"},"methods":[{"summary":"Create Task","description":"Creates a new task.","operationId":"wix.crm.tasks.v2.Tasks.CreateTask","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.CreateTaskResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateTaskRequest","description":"","properties":{"task":{"description":"Task to create.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["task"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Task Created","description":"Triggered when a task is created.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CONTACT_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.ContactNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_CREATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.CreateTaskRequest","responseMessage":"wix.crm.tasks.v2.CreateTaskResponse"},"legacyExamples":[{"name":"CreateTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Create Task","description":"Creates a new Task","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks' \\\n -H 'Accept: application/json, text/plain */*' \\\n -H 'Authorization: ' \\\n --data-raw '\n {\n \"task\": {\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\"\n }\n }\n }'","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v2/tasks","rpcOnly":false,"triggeredEvents":[{"title":"Task Created","description":"Triggered when a task is created.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_created","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CONTACT_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.ContactNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_CREATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.CreateTaskRequest","responseMessage":"wix.crm.tasks.v2.CreateTaskResponse"},"legacyExamples":[{"name":"CreateTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Create Task","description":"Creates a new Task","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks' \\\n -H 'Accept: application/json, text/plain */*' \\\n -H 'Authorization: ' \\\n --data-raw '\n {\n \"task\": {\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\"\n }\n }\n }'","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Create Task","slugifiedName":"create-task"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Get Task","description":"Retrieves a task by ID.","operationId":"wix.crm.tasks.v2.Tasks.GetTask","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"taskId","description":"ID of the task to retrieve.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.GetTaskResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.GetTaskRequest","responseMessage":"wix.crm.tasks.v2.GetTaskResponse"},"legacyExamples":[{"name":"GetTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Get Task","description":"Gets a Task","request":"curl -X GET \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Authorization: '","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"get","path":"/v2/tasks/{taskId}","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.GetTaskRequest","responseMessage":"wix.crm.tasks.v2.GetTaskResponse"},"legacyExamples":[{"name":"GetTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Get Task","description":"Gets a Task","request":"curl -X GET \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Authorization: '","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Get Task","slugifiedName":"get-task"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Delete Task","description":"Deletes a task by ID.","operationId":"wix.crm.tasks.v2.Tasks.DeleteTask","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"taskId","description":"ID of the task to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.DeleteTaskResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Task Deleted","description":"Triggered when a task is deleted.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_DELETE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.DeleteTaskRequest","responseMessage":"wix.crm.tasks.v2.DeleteTaskResponse"},"legacyExamples":[{"name":"DeleteTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Delete Task","description":"Deletes a new Task","request":"curl -X DELETE \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"delete","path":"/v2/tasks/{taskId}","rpcOnly":false,"triggeredEvents":[{"title":"Task Deleted","description":"Triggered when a task is deleted.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_deleted","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_DELETE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.DeleteTaskRequest","responseMessage":"wix.crm.tasks.v2.DeleteTaskResponse"},"legacyExamples":[{"name":"DeleteTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Delete Task","description":"Deletes a new Task","request":"curl -X DELETE \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Delete Task","slugifiedName":"delete-task"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Update Task","description":"Updates a task.\n\nEach time the task is updated, `revision` increments by 1.\nThe existing `revision` must be included when updating the task.\nThis ensures you're working with the latest task\nand prevents unintended overwrites.","operationId":"wix.crm.tasks.v2.Tasks.UpdateTask","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"task.id","description":"Task ID.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.UpdateTaskResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateTaskRequest","description":"","properties":{"task":{"description":"Task to update.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["task","task.id","task.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Task Updated","description":"Triggered when a task is updated.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CONTACT_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.ContactNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_UPDATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.UpdateTaskRequest","responseMessage":"wix.crm.tasks.v2.UpdateTaskResponse"},"legacyExamples":[{"name":"UpdateTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Update Task","description":"Updates a new Task","request":"curl -X PATCH \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Accept: application/json */*' \\\n -H 'Authorization: ' \\\n --data-raw '\n {\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"title\": \"Need to call someone else\",\n \"description\": \"Explain about your site to someone else\",\n \"dueDate\": \"2022-08-18T09:00:00.000Z\",\n \"status\": \"COMPLETED\",\n \"assigneeId\": \"a0bd4986-bcbc-4280-8597-03ec3aac2c37\",\n \"contact\": {\n \"id\": \"c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b\"\n }\n }\n }'","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"2\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-15T010:33:37.054Z\",\n \"title\": \"Need to call someone else\",\n \"description\": \"Explain about your site to someone else\",\n \"dueDate\": \"2022-08-18T09:00:00.000Z\",\n \"status\": \"COMPLETED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"a0bd4986-bcbc-4280-8597-03ec3aac2c37\",\n \"contact\": {\n \"id\": \"c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b\",\n \"firstName\": \"Someone\",\n \"lastName\": \"Else\",\n \"email\": \"anotheremail@example.com\",\n \"phone\": \"+97249755905\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"patch","path":"/v2/tasks/{task.id}","rpcOnly":false,"triggeredEvents":[{"title":"Task Updated","description":"Triggered when a task is updated.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.crm.tasks.v2.task_updated","sourceRepo":"git@github.com:wix-private/crm.git"}],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":400,"statusCode":"INVALID_ARGUMENT","applicationCode":"CONTACT_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.ContactNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_UPDATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.UpdateTaskRequest","responseMessage":"wix.crm.tasks.v2.UpdateTaskResponse"},"legacyExamples":[{"name":"UpdateTask","serviceName":"Tasks","type":"METHOD","content":{"title":"Update Task","description":"Updates a new Task","request":"curl -X PATCH \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002' \\\n -H 'Accept: application/json */*' \\\n -H 'Authorization: ' \\\n --data-raw '\n {\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"title\": \"Need to call someone else\",\n \"description\": \"Explain about your site to someone else\",\n \"dueDate\": \"2022-08-18T09:00:00.000Z\",\n \"status\": \"COMPLETED\",\n \"assigneeId\": \"a0bd4986-bcbc-4280-8597-03ec3aac2c37\",\n \"contact\": {\n \"id\": \"c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b\"\n }\n }\n }'","response":"{\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"2\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-15T010:33:37.054Z\",\n \"title\": \"Need to call someone else\",\n \"description\": \"Explain about your site to someone else\",\n \"dueDate\": \"2022-08-18T09:00:00.000Z\",\n \"status\": \"COMPLETED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"a0bd4986-bcbc-4280-8597-03ec3aac2c37\",\n \"contact\": {\n \"id\": \"c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b\",\n \"firstName\": \"Someone\",\n \"lastName\": \"Else\",\n \"email\": \"anotheremail@example.com\",\n \"phone\": \"+97249755905\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b/2528bd01086244efb191c1302d986566/\"\n }\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Update Task","slugifiedName":"update-task"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Query Tasks","description":"Retrieves a list of tasks, given the provided paging, filtering, and sorting.\n\nQuery Tasks runs with the following defaults, which you can override:\n- `_createdDate` in `DESC` order\n\nFor field support for filters and sorting, see [Tasks: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort).\n\nTo learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).","operationId":"wix.crm.tasks.v2.Tasks.QueryTasks","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.QueryTasksResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"QueryTasksRequest","description":"","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.QueryTasksRequest","responseMessage":"wix.crm.tasks.v2.QueryTasksResponse"},"legacyExamples":[{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":2,"content":{"title":"Queries second page Tasks","description":"Retrieves tasks by a query with cursor","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"cursorPaging\": {\n \"limit\": 50,\n \"cursor\": \"f7ec4508392aacd205bf1d05054347c6d8f56a5b.Eh0qGwoZCgZzdGF0dXMSDxoNQUNUSU9OX05FRURFRBomCgdkdWVEYXRlGhsqGQoXCgokdGltZXN0YW1wEgkRAAAo9BmieEIiJDI5Mjk0ZDJmLTEyNWYtNGFhZC05OGUwLTE1NDcxZTZkZDhkZg\"\n }\n }\n }'","response":"{\n \"tasks\": [\n {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"01d860fd1bb43b43dc86e7b554bb4254667943d0.CAESHSobChkKBnN0YXR1cxIPGg1BQ1RJT05fTkVFREVEGiYKB2R1ZURhdGUaGyoZChcKCiR0aW1lc3RhbXASCREAACj0GaJ4QiIkMmFhM2QxMGYtODk1MC00YmFjLWIwYTktNjM5MWJhMjRhYTgy\"\n },\n \"has_next\": false\n }\n }"}},{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":1,"content":{"title":"Queries first page Tasks","description":"Retrieves tasks by a query with filter and sort","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"dueDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"$and\": [\n {\n \"status\": \"ACTION_NEEDED\"\n },\n {\n \"dueDate\": {\"$gt\": \"2023-08-20T12:00:00.000Z\"}\n },\n {\n \"contact.id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\"\n }\n ]\n },\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"tasks\": [\n {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"f7ec4508392aacd205bf1d05054347c6d8f56a5b.Eh0qGwoZCgZzdGF0dXMSDxoNQUNUSU9OX05FRURFRBomCgdkdWVEYXRlGhsqGQoXCgokdGltZXN0YW1wEgkRAAAo9BmieEIiJDI5Mjk0ZDJmLTEyNWYtNGFhZC05OGUwLTE1NDcxZTZkZDhkZg\"\n },\n \"has_next\": true\n }\n }"}},{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":3,"content":{"title":"Queries Tasks","description":"Retrieves empty list when there is no tasks that match the filter","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"$and\": [\n {\n \"status\": \"COMPLETED\"\n },\n {\n \"updatedDate\": {\"lte\": \"2023-08-20T12:00:00.000Z\"}\n }\n ]\n },\n \"cursorPaging\": {\n \"limit\": 5\n }\n }\n }'","response":"{\n \"tasks\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"has_next\": false\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v2/tasks/query","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.QueryTasksRequest","responseMessage":"wix.crm.tasks.v2.QueryTasksResponse"},"legacyExamples":[{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":2,"content":{"title":"Queries second page Tasks","description":"Retrieves tasks by a query with cursor","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"cursorPaging\": {\n \"limit\": 50,\n \"cursor\": \"f7ec4508392aacd205bf1d05054347c6d8f56a5b.Eh0qGwoZCgZzdGF0dXMSDxoNQUNUSU9OX05FRURFRBomCgdkdWVEYXRlGhsqGQoXCgokdGltZXN0YW1wEgkRAAAo9BmieEIiJDI5Mjk0ZDJmLTEyNWYtNGFhZC05OGUwLTE1NDcxZTZkZDhkZg\"\n }\n }\n }'","response":"{\n \"tasks\": [\n {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"prev\": \"01d860fd1bb43b43dc86e7b554bb4254667943d0.CAESHSobChkKBnN0YXR1cxIPGg1BQ1RJT05fTkVFREVEGiYKB2R1ZURhdGUaGyoZChcKCiR0aW1lc3RhbXASCREAACj0GaJ4QiIkMmFhM2QxMGYtODk1MC00YmFjLWIwYTktNjM5MWJhMjRhYTgy\"\n },\n \"has_next\": false\n }\n }"}},{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":1,"content":{"title":"Queries first page Tasks","description":"Retrieves tasks by a query with filter and sort","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"dueDate\",\n \"order\": \"DESC\"\n }\n ],\n \"filter\": {\n \"$and\": [\n {\n \"status\": \"ACTION_NEEDED\"\n },\n {\n \"dueDate\": {\"$gt\": \"2023-08-20T12:00:00.000Z\"}\n },\n {\n \"contact.id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\"\n }\n ]\n },\n \"cursorPaging\": {\n \"limit\": 1\n }\n }\n }'","response":"{\n \"tasks\": [\n {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Need to call someone\",\n \"description\": \"Explain about your site\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n ],\n \"pagingMetadata\": {\n \"count\": 1,\n \"cursors\": {\n \"next\": \"f7ec4508392aacd205bf1d05054347c6d8f56a5b.Eh0qGwoZCgZzdGF0dXMSDxoNQUNUSU9OX05FRURFRBomCgdkdWVEYXRlGhsqGQoXCgokdGltZXN0YW1wEgkRAAAo9BmieEIiJDI5Mjk0ZDJmLTEyNWYtNGFhZC05OGUwLTE1NDcxZTZkZDhkZg\"\n },\n \"has_next\": true\n }\n }"}},{"name":"QueryTasks","serviceName":"Tasks","type":"METHOD","order":3,"content":{"title":"Queries Tasks","description":"Retrieves empty list when there is no tasks that match the filter","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/query' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"query\": {\n \"sort\": [\n {\n \"fieldName\": \"createdDate\",\n \"order\": \"ASC\"\n }\n ],\n \"filter\": {\n \"$and\": [\n {\n \"status\": \"COMPLETED\"\n },\n {\n \"updatedDate\": {\"lte\": \"2023-08-20T12:00:00.000Z\"}\n }\n ]\n },\n \"cursorPaging\": {\n \"limit\": 5\n }\n }\n }'","response":"{\n \"tasks\": [],\n \"pagingMetadata\": {\n \"count\": 0,\n \"has_next\": false\n }\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Query Tasks","slugifiedName":"query-tasks"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Count Tasks","description":"Counts the number of tasks.\n\n\nThis endpoint returns the count of all tasks regardless of the task `status`.\n\nOptionally, you can pass a filter to count only tasks based\non specified criteria.","operationId":"wix.crm.tasks.v2.Tasks.CountTasks","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.CountTasksResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CountTasksRequest","description":"","properties":{"filter":{"description":"Filter tasks to count. See [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort) for supported filters.\n\nFilter tasks in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_TO_COUNT"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.CountTasksRequest","responseMessage":"wix.crm.tasks.v2.CountTasksResponse"},"legacyExamples":[{"name":"CountTasks","serviceName":"Tasks","type":"METHOD","content":{"title":"Count Tasks","description":"Count tasks by a query with filter and sort","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/count' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"filter\": {\n \"status\": \"ACTION_NEEDED\"\n },\n }'","response":"{\n \"count\": 2\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v2/tasks/count","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":428,"statusCode":"FAILED_PRECONDITION","applicationCode":"TOO_MANY_TO_COUNT"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_READ"],"externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.CountTasksRequest","responseMessage":"wix.crm.tasks.v2.CountTasksResponse"},"legacyExamples":[{"name":"CountTasks","serviceName":"Tasks","type":"METHOD","content":{"title":"Count Tasks","description":"Count tasks by a query with filter and sort","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/count' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"filter\": {\n \"status\": \"ACTION_NEEDED\"\n },\n }'","response":"{\n \"count\": 2\n }"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Count Tasks","slugifiedName":"count-tasks"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true},{"summary":"Move Task After","description":"Moves a task specified by ID to be placed after another task in the display.\n\nYou can reposition a task to be first in the display by ommitting `beforeTaskId`.","operationId":"wix.crm.tasks.v2.Tasks.MoveTaskAfter","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"taskId","description":"The task ID to move.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.crm.tasks.v2.MoveTaskAfterResponse","description":""}},"deprecated":false,"servers":[{"url":"https://manage.wix.com/_api/tasks-app","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/_api/tasks-app","destinationPath":"","url":"manage._base_domain_","serviceName":"wix.crm.tasks.v2.Tasks"}},{"url":"https://www.wixapis.com/crm/tasks/v2/tasks","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/crm/tasks/v2/tasks","destinationPath":"/v2/tasks","url":"www.wixapis.com","serviceName":"wix.crm.tasks.v2.Tasks"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"MoveTaskAfterRequest","description":"","properties":{"beforeTaskId":{"description":"The task ID after which the moved task is positioned in the display.\nIf `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.","format":"GUID","title":"beforeTaskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["taskId"]}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"TASK_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.TaskNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_UPDATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.MoveTaskAfterRequest","responseMessage":"wix.crm.tasks.v2.MoveTaskAfterResponse"},"legacyExamples":[{"name":"MoveTaskAfter","serviceName":"Tasks","type":"METHOD","content":{"title":"Move Task after","description":"Change a task position in the tasks list","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002/move-after' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"filter\": {\n \"taskId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"beforeTaskId\": \"fca1ab15-0576-4121-9de0-024f0b5743fd\"\n },\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git"},"httpMethod":"post","path":"/v2/tasks/{taskId}/move-after","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.crm.tasks.v2.Tasks","errors":[{"httpCode":404,"statusCode":"NOT_FOUND","applicationCode":"TASK_NOT_FOUND","errorSchemaName":"wix.crm.tasks.v2.TaskNotFoundError"}],"exposure":"PUBLIC","maturity":"GA","permissions":["CRM_TASKS.TASK_UPDATE"],"externalPermissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"protoArtifactId":"com.wixpress.crm.tasks:tasks-app","serviceArtifactId":"com.wixpress.crm.tasks.tasks-app","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.crm.tasks.v2.MoveTaskAfterRequest","responseMessage":"wix.crm.tasks.v2.MoveTaskAfterResponse"},"legacyExamples":[{"name":"MoveTaskAfter","serviceName":"Tasks","type":"METHOD","content":{"title":"Move Task after","description":"Change a task position in the tasks list","request":"curl -X POST \\\n 'https://www.wixapis.com/crm/tasks/v2/tasks/4973f73a-40ef-11ee-be56-0242ac120002/move-after' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '\n {\n \"filter\": {\n \"taskId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"beforeTaskId\": \"fca1ab15-0576-4121-9de0-024f0b5743fd\"\n },\n }'","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/crm.git","contentLink":{"displayName":"Move Task After","slugifiedName":"move-task-after"},"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":true}],"webhooks":[{"summary":"Task Overdue","title":"Task Task Overdue","description":"Triggered when a task reaches its due date.","permissions":["CRM_TASKS.TASK_READ"],"payload":{"schemaName":"wix.crm.tasks.v2.TaskOverdue"},"exposure":"PUBLIC","maturity":"GA","slug":"task_overdue","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"CUSTOM_ACTION","externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"eventType":"wix.crm.tasks.v2.task_task_overdue","legacyExamples":[{"name":"TaskOverdue","eventType":"ACTION","type":"DOMAIN_EVENT","content":"{\n \"id\": \"200a394d-4646-482c-b328-23e94563c90c\",\n \"entityFqdn\": \"wix.crm.tasks.v2.task\",\n \"slug\": \"task_overdue\",\n \"entityId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"actionEvent\": {\n \"body\": {\n \"task\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Needtocallsomeone\",\n \"description\": \"Explainaboutyoursite\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n }\n },\n \"eventTime\": \"2020-10-20T07:22:04.564864Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/wix.crm.tasks.v2.TaskOverdue","contentLink":{"displayName":"Task Overdue","slugifiedName":"task-overdue"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Task Created","title":"Task Created","description":"Triggered when a task is created.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"CREATED","externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"eventType":"wix.crm.tasks.v2.task_created","legacyExamples":[{"name":"TaskCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"200a394d-4646-482c-b328-23e94563c90c\",\n \"entityFqdn\": \"wix.crm.tasks.v2.task\",\n \"slug\": \"created\",\n \"entityId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"1\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-13T08:49:37.054Z\",\n \"title\": \"Needtocallsomeone\",\n \"description\": \"Explainaboutyoursite\",\n \"dueDate\": \"2022-08-17T09:00:00.000Z\",\n \"status\": \"ACTION_NEEDED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"f6eb6c40-7379-481e-8d52-58cfb6dc4c9a\",\n \"contact\": {\n \"id\": \"c3341c32-f40e-4de5-8e90-d181c9cddb04\",\n \"firstName\": \"Some\",\n \"lastName\": \"One\",\n \"email\": \"email@example.com\",\n \"phone\": \"+97297495550\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c3341c32-f40e-4de5-8e90-d181c9cddb04/2528bd01086244efb191c1302d986566/\"\n }\n }\n },\n \"eventTime\": \"2020-10-20T07:22:04.564864Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","contentLink":{"displayName":"Task Created","slugifiedName":"task-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Task Updated","title":"Task Updated","description":"Triggered when a task is updated.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"eventType":"wix.crm.tasks.v2.task_updated","legacyExamples":[{"name":"TaskUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"30b49365-4af7-47c0-bde1-6bcb7e4be0f8\",\n \"entityFqdn\": \"wix.crm.tasks.v2.task\",\n \"slug\": \"updated\",\n \"entityId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"revision\": \"2\",\n \"createdDate\": \"2022-08-13T07:43:18.125Z\",\n \"updatedDate\": \"2022-08-15T010:33:37.054Z\",\n \"title\": \"Needtocallsomeoneelse\",\n \"description\": \"Explainaboutyoursitetosomeoneelse\",\n \"dueDate\": \"2022-08-18T09:00:00.000Z\",\n \"status\": \"COMPLETED\",\n \"source\": {\n \"sourceType\": \"USER\",\n \"userId\": \"fe213e9b-a560-4bcc-aae4-ef31c4152002\"\n },\n \"assigneeId\": \"a0bd4986-bcbc-4280-8597-03ec3aac2c37\",\n \"contact\": {\n \"id\": \"c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b\",\n \"firstName\": \"Someone\",\n \"lastName\": \"Else\",\n \"email\": \"anotheremail@example.com\",\n \"phone\": \"+97249755905\",\n \"imageUrl\": \"https://www.wix.com/contacts-server/api/v1/metasite/avatar/c5d0b2b8-529e-40b4-bb89-1afe1f55ef8b/2528bd01086244efb191c1302d986566/\"\n }\n }\n },\n \"eventTime\": \"2020-10-18T13:42:11.943838Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","contentLink":{"displayName":"Task Updated","slugifiedName":"task-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]},{"summary":"Task Deleted","title":"Task Deleted","description":"Triggered when a task is deleted.","permissions":["CRM_TASKS.TASK_READ"],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.crm.tasks.v2.task","serviceName":"wix.crm.tasks.v2.Tasks","domainEvent":"DELETED","externalPermissionScopes":[{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"}],"eventType":"wix.crm.tasks.v2.task_deleted","legacyExamples":[{"name":"TaskDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"1d186ed0-e111-4405-accd-9bc5eaa9173b\",\n \"entityFqdn\": \"wix.crm.tasks.v2.task\",\n \"slug\": \"deleted\",\n \"entityId\": \"4973f73a-40ef-11ee-be56-0242ac120002\",\n \"deletedEvent\": {},\n \"eventTime\": \"2020-10-18T13:42:41.068589Z\",\n \"triggeredByAnonymizeRequest\": false\n}\n"}],"sourceRepo":"git@github.com:wix-private/crm.git","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","contentLink":{"displayName":"Task Deleted","slugifiedName":"task-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[{"name":"Manage Tasks","scopeId":"SCOPE.DC-CRM.MANAGE-TASKS"},{"name":"Read Tasks","scopeId":"SCOPE.DC-CRM.READ-TASKS"},{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}]}],"articles":[{"displayName":"Tasks","slugifyName":"tasks","content":"# About Tasks\n\nThe Tasks API allows you to create and manage tasks. You can organize and prioritize daily task activities, such as follow up calls and emails, or scheduling meetings. \n\nWith Tasks you can:\n- Create, update, and delete tasks. \n- Link tasks to a contact.\n- Create reminder notifications by setting a due date for tasks. \n- Prioritize tasks by adjusting their display order.\n- Retrieve tasks.\n- Count how many tasks you have based on specified filters.\n\n## Task reminders\n\nWhen you set a due date for a task, reminder notifications are sent on:\n- The day before the due date. \n- The due date. \n\nReminder notifications are not sent for overdue tasks.\n"},{"displayName":"Filter and sort","slugifyName":"filter-and-sort","content":"# CRM Tasks: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the task object:\n\n| Field | Supported Filters | Sortable |\n| ------------- | ------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$in` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `dueDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `status` | `$eq`, `$ne`, `$in`, `$nin` | |\n| `contact.id` | `$eq`, `$ne`, `$in`, `$exists` | |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Tasks](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::df9d892d-634d-4059-bb11-41600b7490e8slug::query-tasks*fallback::https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/query-tasks)\n"}],"components":{"schemas":{"wix.crm.tasks.v2.Task":{"type":"object","properties":{"id":{"description":"Task ID.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing `revision` must be used when updating a task.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Title of the task.","minLength":1,"maxLength":250,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"description":{"description":"Description of the task.","minLength":1,"maxLength":500,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the task was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the task was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"dueDate":{"description":"Due date for the task.","title":"dueDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Status of the task.\n\nDefault: `ACTION_NEEDED`","title":"status","type":"string","$ref":"#/components/schemas/wix.crm.tasks.v2.Task.TaskStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"source":{"description":"Details about the task source.","$ref":"#/components/schemas/wix.crm.tasks.v2.TaskSource","summary":"source","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contact":{"description":"Information about the contact associated with the task.","$ref":"#/components/schemas/wix.crm.tasks.v2.ContactInfo","summary":"contact","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Task","description":""},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.crm.tasks.v2.Task.TaskStatus":{"type":"string","description":"Possible statuses in which the task may be.","title":"TaskStatus","enum":["UNKNOWN_STATUS","ACTION_NEEDED","COMPLETED"]},"wix.crm.tasks.v2.TaskSource":{"type":"object","properties":{"sourceType":{"description":"How the task was created.","readOnly":true,"title":"sourceType","type":"string","$ref":"#/components/schemas/wix.crm.tasks.v2.TaskSource.SourceType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"App ID, if the task was created by an app.","format":"GUID","readOnly":true,"title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"userId":{"description":"User ID, if the task was created by a user.","format":"GUID","readOnly":true,"title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaskSource","description":""},"wix.crm.tasks.v2.TaskSource.SourceType":{"type":"string","description":"Possible sources that can create tasks.","title":"SourceType","enum":["UNKNOWN_SOURCE_TYPE","APP","USER"]},"wix.crm.tasks.v2.ContactInfo":{"type":"object","properties":{"id":{"description":"ID of the contact associated with the task.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"firstName":{"description":"Contact's first name.","readOnly":true,"title":"firstName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"lastName":{"description":"Contact's last name.","readOnly":true,"title":"lastName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"imageUrl":{"description":"Contact's image url.","readOnly":true,"title":"imageUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"email":{"description":"Contact's primary email.","readOnly":true,"title":"email","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"phone":{"description":"Contact's primary phone.","readOnly":true,"title":"phone","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactInfo","description":""},"wix.crm.tasks.v2.DeleteCompletedTasksRequest":{"type":"object","properties":{"taskIds":{"description":"Optional list of tasks ids of the tasks to delete. If the list is not provided the filter is used.","format":"GUID","maxItems":1000,"title":"taskIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filter":{"description":"An optional filter of tasks to count. See 'queryTasks' for supported filter options.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteCompletedTasksRequest","description":""},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.crm.tasks.v2.DeleteCompletedTasksResponse":{"type":"object","properties":{},"title":"DeleteCompletedTasksResponse","description":""},"wix.crm.tasks.v2.SendTasksReminderRequest":{"type":"object","properties":{"taskIds":{"description":"Ids of the tasks to remind","format":"GUID","maxItems":50,"title":"taskIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reminderType":{"description":"The reminder type","title":"reminderType","type":"string","$ref":"#/components/schemas/wix.crm.tasks.v2.SendTasksReminderRequest.ReminderType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SendTasksReminderRequest","description":""},"wix.crm.tasks.v2.SendTasksReminderRequest.ReminderType":{"type":"string","description":"","title":"ReminderType","enum":["UNKNOWN_REMINDER_TYPE","FIRST_REMINDER","LAST_REMINDER"]},"wix.crm.tasks.v2.SendTasksReminderResponse":{"type":"object","properties":{},"title":"SendTasksReminderResponse","description":""},"wix.crm.tasks.v2.RepositionTask":{"type":"object","properties":{"taskId":{"description":"The id of the last task that was re-positioned","format":"GUID","title":"taskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"position":{"description":"The position of the last task that was re-positioned","title":"position","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RepositionTask","description":""},"wix.crm.tasks.v2.TaskOverdue":{"type":"object","properties":{"task":{"description":"The overdue task.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaskOverdue","description":""},"wix.crm.tasks.v2.TaskAssigned":{"type":"object","properties":{"assigneeId":{"description":"The id of the assignee","format":"GUID","title":"assigneeId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"task":{"description":"The task that was assigned","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaskAssigned","description":""},"wix.crm.tasks.v2.CreateTaskRequest":{"type":"object","properties":{"task":{"description":"Task to create.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTaskRequest","description":""},"wix.crm.tasks.v2.CreateTaskResponse":{"type":"object","properties":{"task":{"description":"The created task.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateTaskResponse","description":""},"wix.crm.tasks.v2.ContactNotFoundError":{"type":"object","properties":{"contactId":{"description":"","format":"GUID","title":"contactId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ContactNotFoundError","description":""},"wix.crm.tasks.v2.GetTaskRequest":{"type":"object","properties":{"taskId":{"description":"ID of the task to retrieve.","format":"GUID","title":"taskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTaskRequest","description":""},"wix.crm.tasks.v2.GetTaskResponse":{"type":"object","properties":{"task":{"description":"The retrieved task.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetTaskResponse","description":""},"wix.crm.tasks.v2.UpdateTaskRequest":{"type":"object","properties":{"task":{"description":"Task to update.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTaskRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.crm.tasks.v2.UpdateTaskResponse":{"type":"object","properties":{"task":{"description":"The updated task.","$ref":"#/components/schemas/wix.crm.tasks.v2.Task","summary":"task","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateTaskResponse","description":""},"wix.crm.tasks.v2.DeleteTaskRequest":{"type":"object","properties":{"taskId":{"description":"ID of the task to delete.","format":"GUID","title":"taskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteTaskRequest","description":""},"wix.crm.tasks.v2.DeleteTaskResponse":{"type":"object","properties":{},"title":"DeleteTaskResponse","description":""},"wix.crm.tasks.v2.QueryTasksRequest":{"type":"object","properties":{"query":{"description":"Query options.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorQuery","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTasksRequest","description":""},"wix.crm.tasks.v2.upstream.wix.common.CursorQuery":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorQuery","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorQuery.pagingMethod"}]},"wix.crm.tasks.v2.upstream.wix.common.CursorQuery.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.crm.tasks.v2.upstream.wix.common.Sorting":{"type":"object","properties":{"fieldName":{"description":"Name of the field to sort by.","title":"fieldName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"order":{"description":"Sort order.","title":"order","type":"string","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.SortOrder","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Sorting","description":""},"wix.crm.tasks.v2.upstream.wix.common.SortOrder":{"type":"string","description":"","title":"SortOrder","enum":["ASC","DESC"]},"wix.crm.tasks.v2.upstream.wix.common.CursorPaging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursor":{"description":"Pointer to the next or previous page in the list of results.\n\nYou can get the relevant cursor token\nfrom the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request.","title":"cursor","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPaging","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"wix.crm.tasks.v2.QueryTasksResponse":{"type":"object","properties":{"tasks":{"description":"The retrieved tasks.","title":"tasks","type":"array","items":{"$ref":"#/components/schemas/wix.crm.tasks.v2.Task"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Paging metadata.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorPagingMetadata","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTasksResponse","description":""},"wix.crm.tasks.v2.upstream.wix.common.CursorPagingMetadata":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Offset that was requested.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hasNext":{"description":"Indicates if there are more results after the current page.\nIf `true`, another page of results can be retrieved.\nIf `false`, this is the last page.","title":"hasNext","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CursorPagingMetadata","description":""},"wix.crm.tasks.v2.upstream.wix.common.Cursors":{"type":"object","properties":{"next":{"description":"Cursor pointing to next page in the list of results.","title":"next","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"prev":{"description":"Cursor pointing to previous page in the list of results.","title":"prev","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Cursors","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.crm.tasks.v2.CountTasksRequest":{"type":"object","properties":{"filter":{"description":"Filter tasks to count. See [Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/filter-and-sort) for supported filters.\n\nFilter tasks in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountTasksRequest","description":""},"wix.crm.tasks.v2.CountTasksResponse":{"type":"object","properties":{"count":{"description":"The number of tasks that match the provided filter.","title":"count","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CountTasksResponse","description":""},"wix.crm.tasks.v2.QueryTasksInternalRequest":{"type":"object","properties":{"query":{"description":"WQL expression","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.QueryV2","summary":"query","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTasksInternalRequest","description":""},"wix.crm.tasks.v2.upstream.wix.common.QueryV2":{"type":"object","properties":{"filter":{"description":"Filter object in the following format:\n`\"filter\" : {\n\"fieldName1\": \"value1\",\n\"fieldName2\":{\"$operator\":\"value2\"}\n}`\nExample of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`","title":"filter","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sort":{"description":"Sort object in the following format:\n`[{\"fieldName\":\"sortField1\",\"order\":\"ASC\"},{\"fieldName\":\"sortField2\",\"order\":\"DESC\"}]`","title":"sort","type":"array","items":{"$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.Sorting"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fields":{"description":"Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"fieldsets":{"description":"Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.","title":"fieldsets","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryV2","description":"","oneOf":[{"description":"","summary":"pagingMethod","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.QueryV2.pagingMethod"}]},"wix.crm.tasks.v2.upstream.wix.common.QueryV2.pagingMethod":{"type":"object","title":"pagingMethod","properties":{"paging":{"description":"Paging options to limit and skip the number of items.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.Paging","summary":"paging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursorPaging":{"description":"Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.CursorPaging","summary":"cursorPaging","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.crm.tasks.v2.upstream.wix.common.Paging":{"type":"object","properties":{"limit":{"description":"Number of items to load.","minimum":0,"maximum":1000,"title":"limit","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Number of items to skip in the current sort order.","minimum":0,"title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Paging","description":""},"wix.crm.tasks.v2.QueryTasksInternalResponse":{"type":"object","properties":{"tasks":{"description":"The retrieved Tasks","title":"tasks","type":"array","items":{"$ref":"#/components/schemas/wix.crm.tasks.v2.Task"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pagingMetadata":{"description":"Details on the paged set of results returned.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.PagingMetadataV2","summary":"pagingMetadata","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QueryTasksInternalResponse","description":""},"wix.crm.tasks.v2.upstream.wix.common.PagingMetadataV2":{"type":"object","properties":{"count":{"description":"Number of items returned in the response.","title":"count","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"offset":{"description":"Offset that was requested.","title":"offset","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"total":{"description":"Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.","title":"total","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tooManyToCount":{"description":"Flag that indicates the server failed to calculate the `total` field.","title":"tooManyToCount","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cursors":{"description":"Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.","$ref":"#/components/schemas/wix.crm.tasks.v2.upstream.wix.common.Cursors","summary":"cursors","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PagingMetadataV2","description":""},"wix.crm.tasks.v2.MoveTaskAfterRequest":{"type":"object","properties":{"taskId":{"description":"The task ID to move.","format":"GUID","title":"taskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"beforeTaskId":{"description":"The task ID after which the moved task is positioned in the display.\nIf `beforeTaskId` is not provided, the moved task is positioned first in the display of tasks.","format":"GUID","title":"beforeTaskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MoveTaskAfterRequest","description":""},"wix.crm.tasks.v2.MoveTaskAfterResponse":{"type":"object","properties":{},"title":"MoveTaskAfterResponse","description":""},"wix.crm.tasks.v2.TaskNotFoundError":{"type":"object","properties":{"taskId":{"description":"The task id that was not found","format":"GUID","title":"taskId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TaskNotFoundError","description":""},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Task","description":"The `task` object represents all information available for tasks. A task is a specific action or assignment to be completed.","fqdn":"wix.crm.tasks.v2.task"},"articles":[{"displayName":"Tasks","slugifyName":"tasks","content":"# About Tasks\n\nThe Tasks API allows you to create and manage tasks. You can organize and prioritize daily task activities, such as follow up calls and emails, or scheduling meetings. \n\nWith Tasks you can:\n- Create, update, and delete tasks. \n- Link tasks to a contact.\n- Create reminder notifications by setting a due date for tasks. \n- Prioritize tasks by adjusting their display order.\n- Retrieve tasks.\n- Count how many tasks you have based on specified filters.\n\n## Task reminders\n\nWhen you set a due date for a task, reminder notifications are sent on:\n- The day before the due date. \n- The due date. \n\nReminder notifications are not sent for overdue tasks.\n"},{"displayName":"Filter and sort","slugifyName":"filter-and-sort","content":"# CRM Tasks: Supported Filters and Sorting\n\nThe following table shows field support for filters and sorting\nfor the task object:\n\n| Field | Supported Filters | Sortable |\n| ------------- | ------------------------------------------ | -------- |\n| `id` | `$eq`, `$ne`, `$in` | Sortable |\n| `createdDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `updatedDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `dueDate` | `$eq`, `$ne`, `$gt`, `$lt`, `$gte`, `$lte` | Sortable |\n| `status` | `$eq`, `$ne`, `$in`, `$nin` | |\n| `contact.id` | `$eq`, `$ne`, `$in`, `$exists` | |\n\n__Related content:__\n[API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language),\n[Query Tasks](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::df9d892d-634d-4059-bb11-41600b7490e8slug::query-tasks*fallback::https://dev.wix.com/docs/rest/api-reference/crm/tasks/task-v2/query-tasks)\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}