Mobile_API »Get Event Form Edit Details
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{contact_id}/eventformedit/{event_form_id}/contacteventform/{contact_event_form_id}
Purpose
Retrieves an existing event form submission for editing. Returns contact summary details, event form info (including submission created date), selected people, and field definitions with previously saved values.
HTTP Method
GET
| 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 |
Yes |
Unique identifier of the event form definition
|
| contact_event_form_id |
integer |
Yes |
Unique identifier of the existing contact event form submission to edit
|
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformedit/{event_form_id}/contacteventform/{contact_event_form_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/contact/{contact_id}/eventformedit/{event_form_id}/contacteventform/{contact_event_form_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the editable event form payload for the given submission.
| 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 |
Event form edit payload
|
| uri |
string |
Requested resource URI
|
data.contact_details
| Field |
Type |
Description
|
| contact_id |
integer |
Contact identifier
|
| account_type |
string |
Contact type name
|
| account_type_id |
integer |
Contact type identifier
|
| account_number |
string |
Account number
|
| company_name |
string |
Company name
|
| parent_company |
string |
Parent company / title
|
| address1 |
string |
Address line 1
|
| address2 |
string |
Address line 2
|
| city |
string |
City
|
| state |
string |
State abbreviation
|
| state_id |
integer |
State identifier
|
| zipcode |
string |
ZIP/postal code
|
| country |
string |
Country name
|
| country_id |
integer |
Country identifier
|
| company_email |
string |
Contact email
|
| phone |
string |
Formatted phone number
|
| phone_type_id |
integer |
Phone type identifier
|
| country_code |
string |
Phone country/dialing code
|
| website |
string |
Website
|
data.eventform_info
| Field |
Type |
Description
|
| event_form_id |
integer |
Contact event form submission ID being edited
|
| event_form_name |
string |
Event form display name
|
| event_form_created_date |
string |
Submission created date/time in the user’s timezone (format: m-d-Y g:i A)
|
data.people_details
| Field |
Type |
Description
|
| people_field_selected_id |
string |
Comma-separated IDs of people already selected on this submission
|
| people_field_option |
array |
Available people for the contact (see below)
|
data.people_details.people_field_option[]
| Field |
Type |
Description
|
| id |
integer |
Person identifier
|
| full_name |
string |
Full name
|
| first_name |
string |
First name
|
| last_name |
string |
Last name
|
| title |
string |
Job title
|
data.custom_fields[]
| Field |
Type |
Description
|
| name |
string |
Field display name
|
| position |
integer |
Field display order
|
| points |
integer/number |
Field points value
|
| required |
boolean |
Whether the field is required
|
| custom_field_id |
integer |
Custom field identifier
|
| custom_field_inner_id |
integer |
Related/inner custom field identifier
|
| custom_field_regular_id |
integer |
Regular field identifier (0 when not a regular field)
|
| custom_field_type_id |
integer |
Field type identifier
|
| custom_field_table_id |
integer |
Custom field table identifier
|
| custom_field_type |
object/array |
Field type details
|
| custom_field_option |
array |
Available options for select/radio-style fields
|
| custom_field_option_default_id |
string |
Previously selected option ID(s), when applicable
|
| value |
string |
Previously saved field value
|
Error Responses
| Status Code |
Meaning
|
| 400 |
Bad Request – event form edit details could not be retrieved
|
| 401 |
Unauthorized – missing, invalid, or expired Bearer token
|
- 400 – An error occurred while loading the submission (for example, "Error while retriving the Event form Details").
- 401 – Authentication failed or the access token is missing/expired.
