Ashley DeBon: /* Get Event Form Select List */

2026-07-20T07:04:03Z

‎Get Event Form Select List

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

2026-07-20T07:03:40Z

‎Successful Response (200)

Ashley DeBon: 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`..."

2026-07-20T07:03:04Z

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`..."

New page

== 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 ===
{| 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
|-
| event_form_id || integer || No || Existing event form ID to exclude from the selectable list
|}

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

==== Request Body ====
None.

=== Successful Response (200) ===
Returns the selectable event forms for the contact, ordered by position.

{| 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
|-
| data || array || List of selectable event forms
|-
| uri || string || Requested resource URI
|}

==== data[] ====
{| class="wikitable"
! 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 || <code>true</code> when the form is treated as an appointment; otherwise <code>false</code>
|}

=== Error Responses ===
{| class="wikitable"
! 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.

← Older revision		Revision as of 07:04, 20 July 2026
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 ====
 None.
 === Successful Response (200) ===

EventForm Select Before the Add EventForm - Revision history

Ashley DeBon: /* Get Event Form Select List */

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

Ashley DeBon: 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`..."