Ashley DeBon: /* Successful Response (200) */

2026-07-20T08:07:00Z

‎Successful Response (200)

Ashley DeBon: /* Update Task */

2026-07-20T08:06:20Z

‎Update Task

Ashley DeBon: Created page with "== Update Task == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/task/{task_id} === Purpose === Updates an existing task (follo..."

2026-07-20T08:06:08Z

Created page with "== Update Task == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/task/{task_id} === Purpose === Updates an existing task (follo..."

New page

== Update Task ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/contact/{contact_id}/task/{task_id}

=== Purpose ===
Updates an existing task (follow-up) for a contact. Updates schedule, assignee, type, notes, optional priority, linked people, and can sync recurrence/calendar settings with Google or Office calendars when available.

=== HTTP Method ===
PUT

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| contact_id || integer || Yes || Unique identifier of the contact
|-
| task_id || integer || Yes || Unique identifier of the task to update
|}

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| date || integer (Unix timestamp) || Yes || Task date as a Unix timestamp
|-
| time || string || Yes || Task time (combined with <code>date</code> to form the start datetime)
|-
| duration || number || Yes || Task duration in minutes
|-
| task_assignment || integer/string || Yes || User ID of the person assigned to the task
|-
| task_type_id || integer || Yes || Task/follow-up type identifier
|-
| people || string (JSON array) || Yes || JSON array of personnel IDs linked to the task (for example, <code>[12,34]</code>)
|-
| notes || string || No || Task notes
|-
| task_priority_id || integer || No || Task priority identifier
|-
| google_calendar || integer/boolean || No || Whether to sync with Google Calendar (<code>1</code>/<code>0</code>)
|-
| office_calendar || integer/boolean || No || Whether to sync with Office Calendar (<code>1</code>/<code>0</code>)
|-
| recurrence_type || string || No || Recurrence type (for example, daily/weekly/monthly/yearly, or "Does not repeat")
|-
| repeat_interval || integer || No || Recurrence interval; used with <code>recurrence_type</code>
|-
| repeat_count || integer || No || Number of recurrence occurrences
|-
| end_date_daily || string || No || End date for daily recurrence
|-
| repeat_day || string || No || Day(s) for weekly recurrence
|-
| end_date_weekly || string || No || End date for weekly recurrence
|-
| assign_month_date || integer || No || Date of month for monthly recurrence
|-
| assign_month_day || string || No || Day setting for monthly recurrence
|-
| end_date_monthly || string || No || End date for monthly recurrence
|-
| assign_year_date || integer || No || Date for yearly recurrence
|-
| assign_year_month || integer || No || Month for yearly recurrence
|-
| end_date_year || string || No || End date for yearly recurrence
|-
| assign_year_day || string || No || Day setting for yearly recurrence
|-
| index || string || No || Recurrence index/helper value
|-
| recurrence_id || integer || No || Existing recurrence record identifier
|}

=== Successful Response (200) ===
Indicates that the task was updated successfully.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| message || string || Confirmation message (for example, "Task was successfully updated.")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – the task could not be updated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – Invalid <code>date</code> format ("Unauthorized"), task update failure ("Error while updating Task" / "Error while Adding Task"), or calendar sync failure (for example, "Error while Updating Event on Calendar").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 08:06, 20 July 2026
Line 1:		Line 1:
−	== Update Task ==	+	== [[Mobile_API]] »Update Task ==

	=== Base URL ===		=== Base URL ===

@@ Line 91: / Line 91: @@
 | recurrence_id || integer || No || Existing recurrence record identifier
 |}
 === Successful Response (200) ===

Task Details Updation Based on Task Id - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Update Task */

Ashley DeBon: Created page with "== Update Task == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/task/{task_id} === Purpose === Updates an existing task (follo..."