Difference between revisions of "EventForm Add Process Enabled Checkbox for SchedultTask Details"
Ashley DeBon (talk | contribs) (Created page with "== Get Event Form Schedule Task Details == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/eventformscheduletask === Purpose === Retrieves th...") |
Ashley DeBon (talk | contribs) (→Get Event Form Schedule Task Details) |
||
| Line 1: | Line 1: | ||
| − | == Get Event Form Schedule Task Details == | + | == [[Mobile_API]] »Get Event Form Schedule Task Details == |
=== Base URL === | === Base URL === | ||
Latest revision as of 07:18, 20 July 2026
Contents
Mobile_API »Get Event Form Schedule Task Details
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/eventformscheduletask
Purpose
Retrieves the lookup data needed to schedule a follow-up/task from an event form, including assignable users, task actions, date/time options, durations, priorities, and whether Google/Office calendar sync options are available for the authenticated user.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
None.
Successful Response (200)
Returns schedule-task configuration for the company and authenticated user.
| 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 |
| data | object | Schedule task payload |
| uri | string | Requested resource URI |
data
| Field | Type | Description |
|---|---|---|
| task_assignment | array | Users who can be assigned the task |
| task_action | array | Available follow-up/task action types |
| task_date | array | Preset date options |
| task_time | object | Time selection options and default time |
| task_duration | array | Available task durations |
| task_priority | array | Available task priorities |
| is_enabled_google_calender | boolean | Whether Google Calendar sync is available for this user |
| add_google_calender | boolean | Whether the Google Calendar checkbox should be pre-checked |
| is_enabled_office_calender | boolean | Whether Office Calendar sync is available for this user |
| add_office_calender | boolean | Whether the Office Calendar checkbox should be pre-checked |
data.task_assignment[]
| Field | Type | Description |
|---|---|---|
| user_id | integer | Assignable user identifier |
| name | string | Full name of the assignable user |
data.task_action[]
| Field | Type | Description |
|---|---|---|
| follow_type_id | integer | Follow-up/task action type identifier |
| name | string | Action type name |
| position | integer | Display order |
| is_default | boolean | Whether this action is the default |
data.task_date[]
| Field | Type | Description |
|---|---|---|
| name | string | Preset label (for example, Current Date, Tomorrow, One Week) |
| value | string | Date value in m-d-Y format
|
| timestamp | integer | Unix timestamp for the date |
| default | boolean | Whether this date option is the default |
data.task_time
| Field | Type | Description |
|---|---|---|
| default_id | object | Default time (hour=08, minutes=00, meridiem=AM)
|
| hours | array | Available hour values |
| minutes | array | Available minute values (00, 15, 30, 45) |
| meridiem | array | AM/PM options |
data.task_duration[]
| Field | Type | Description |
|---|---|---|
| duration_id | string | Duration identifier in minutes (for example, 15, 30, 60) |
| name | string | Duration display name |
| default | boolean | Whether this duration is the default |
data.task_priority[]
| Field | Type | Description |
|---|---|---|
| priority_id | integer | Priority identifier |
| name | string | Priority name |
| default | boolean | Whether this priority is the default (true when priority_id is 3)
|
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – schedule task details could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading schedule task details.
- 401 – Authentication failed or the access token is missing/expired.