Update a task

PUT

https://api.close.com/api/v1/task/:id/

PUT

/api/v1/task/:id/

$ curl -X PUT https://api.close.com/api/v1/task/id/ \
>      -H "Content-Type: application/json" \
>      -u "<CLOSE_API_KEY>:" \
>      -d '{
>   "is_complete": false
> }'

1 {
2   "_type": "lead",
3   "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
4   "assigned_to_name": "John Doe",
5   "contact_id": null,
6   "contact_name": null,
7   "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8   "created_by_name": "John Doe",
9   "date": "2013-02-06",
10   "date_created": "2015-02-08T20:30:54.314000+00:00",
11   "date_updated": "2015-02-26T19:11:36.128000+00:00",
12   "id": "task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI",
13   "is_complete": true,
14   "is_dateless": false,
15   "lead_id": "lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc",
16   "lead_name": "Close",
17   "object_id": null,
18   "object_type": null,
19   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
20   "text": "Connect with Account Manager",
21   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
22   "updated_by_name": "John Doe"
23 }

The assigned_to, date (either a date or a date-time), and is_complete fields may be updated on all tasks. If the task type is lead, the text field may also be modified.

curl -X PUT https://api.close.com/api/v1/task/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "is_complete": false
}'

{
  "_type": "lead",
  "assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "assigned_to_name": "John Doe",
  "contact_id": null,
  "contact_name": null,
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "created_by_name": "John Doe",
  "date": "2013-02-06",
  "date_created": "2015-02-08T20:30:54.314000+00:00",
  "date_updated": "2015-02-26T19:11:36.128000+00:00",
  "id": "task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI",
  "is_complete": true,
  "is_dateless": false,
  "lead_id": "lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc",
  "lead_name": "Close",
  "object_id": null,
  "object_type": null,
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "text": "Connect with Account Manager",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "updated_by_name": "John Doe"
}

The assigned_to, date (either a date or a date-time), and is_complete fields may be updated on all tasks. If the task type is lead, the text field may also be modified.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Request

This endpoint expects an object.

agent_config_idstring or nullOptional

assigned_tostringOptional

contact_idstring or nullOptional

created_bystringOptional

datedatetime or dateOptional

due_datedatetime or dateOptional

is_completebooleanOptional

is_datelessbooleanOptional

lead_idstringOptional

organization_idstringOptional

priorityenumOptional

Allowed values:

resolutionenum or nullOptional

Allowed values:

textstringOptional

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl -X PUT https://api.close.com/api/v1/task/id/ \
>	-H "Content-Type: application/json" \
>	-u "<CLOSE_API_KEY>:" \
>	-d '{
>	"is_complete": false
>	}'

1	{
2	"_type": "lead",
3	"assigned_to": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
4	"assigned_to_name": "John Doe",
5	"contact_id": null,
6	"contact_name": null,
7	"created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
8	"created_by_name": "John Doe",
9	"date": "2013-02-06",
10	"date_created": "2015-02-08T20:30:54.314000+00:00",
11	"date_updated": "2015-02-26T19:11:36.128000+00:00",
12	"id": "task_aRUZXCm9lMb2LwipTPhfFoFbCsUnaoQh1ncQ7WLnjlI",
13	"is_complete": true,
14	"is_dateless": false,
15	"lead_id": "lead_5LmpOyrMQdJSUlbNGBSGfK5XzcioIm7aC94PSQamQJc",
16	"lead_name": "Close",
17	"object_id": null,
18	"object_type": null,
19	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
20	"text": "Connect with Account Manager",
21	"updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
22	"updated_by_name": "John Doe"
23	}