Difference between revisions of "EventForm Put Process Details"
Ashley DeBon (talk | contribs) (Created page with "== Update Event Form == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{contact_id}/eventformedit/{event_form_id}/contacteventform/{contact_e...") |
Ashley DeBon (talk | contribs) (→Update Event Form) |
||
| Line 1: | Line 1: | ||
| − | == Update Event Form == | + | == [[Mobile_API]] »Update Event Form == |
=== Base URL === | === Base URL === | ||
Revision as of 07:50, 20 July 2026
Contents
Mobile_API »Update Event Form
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{contact_id}/eventformedit/{event_form_id}/contacteventform/{contact_event_form_id}
Purpose
Updates an existing event form submission for a contact. Replaces linked people, updates custom/regular field values, and may resend notification emails with an “[UPDATED]” subject.
HTTP Method
POST
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 | Yes | Unique identifier of the event form definition |
| contact_event_form_id | integer | Yes | Unique identifier of the existing contact event form submission to update |
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| form_field | string (JSON array) | Yes | JSON array of field values to update on the submission |
| people | string (JSON array) | No | JSON array of people to link (replaces existing linked people; each item includes id)
|
| schedule_task | string (JSON) | No | Optional schedule/follow-up task payload (accepted in the request) |
form_field[] fields
| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | Conditional | Field display name (used in required-field error messages) |
| custom_field_id | integer | Yes* | Custom field identifier |
| custom_field_type_id | integer | Yes* | Field type identifier |
| value | string | Conditional | Field value (required when the field is marked required and no option default is set) |
| custom_field_option_default_id | string | Conditional | Selected option ID(s) for select/radio/multi-select fields |
| required | boolean | No | Whether the field is required |
\* Expected for each field entry processed during update.
Successful Response (200)
Indicates that the event form submission was updated successfully.
| 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, "Event Form has been updated.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the event form could not be updated |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Invalid contact ID ("ContactId is Invalid"), invalid event form ID ("EventFormId is Invalid"), required field missing (for example, "<Field Name> Required"), invalid field type mapping, or another update error (for example, "Unfortunately, we’ve encountered an error and alerted CallProof." / "Error while Updating EventForm").
- 401 – Authentication failed or the access token is missing/expired.
