Difference between revisions of "EventForm Select Before the Add EventForm"
Ashley DeBon (talk | contribs) (Created page with "== Get Event Form Select List == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventformselect/{event_form_id} `event_form_id`...") |
Ashley DeBon (talk | contribs) (→Get Event Form Select List) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Get Event Form Select List == | + | == [[Mobile_API]] »Get Event Form Select List == |
=== Base URL === | === Base URL === | ||
| Line 41: | Line 41: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformselect' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformselect' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 07:04, 20 July 2026
Mobile_API »Get Event Form Select List
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{contact_id}/eventformselect/{event_form_id}
`event_form_id` is optional: `/api/contact/{contact_id}/eventformselect`
Purpose
Retrieves the list of event forms available to select for a contact. Forms are filtered by the contact’s contact type access rules. When an existing event form ID is provided, that form is excluded from the list (useful when switching forms). When omitted, only non-hidden forms for the company are returned.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | integer | Yes | Unique identifier of the contact |
| event_form_id | integer | No | Existing event form ID to exclude from the selectable list |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformselect' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformselect' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the selectable event forms for the contact, ordered by position.
| 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 | array | List of selectable event forms |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the event form |
| name | string | Event form display name |
| is_schedule_followup | boolean | Whether the form can schedule a follow-up |
| send_email_to_rep | boolean | Whether an email is sent to the rep |
| post_back_method | string/integer | Post-back method configured for the form |
| is_clickable | boolean | Whether the form is clickable |
| event_form_treat_as_appointment | boolean | true when the form is treated as an appointment; otherwise false
|
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – event form select list could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while loading selectable event forms (for example, "No Records Found").
- 401 – Authentication failed or the access token is missing/expired.
