EventForm Remove Process

From docs
Jump to: navigation, search

Mobile_API »Delete Contact Event Form

Base URL

https://apimobile.callproof.com

Endpoint

/api/contacteventform/{contact_event_form_id}

Purpose

Deletes a submitted contact event form and related records, including linked people, images, and any follow-ups created from that submission.

HTTP Method

DELETE

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
contact_event_form_id integer Yes Unique identifier of the contact event form submission to delete

Query Parameters

None.

Request Body

None.

cURL Example for Android

 curl --location --request DELETE 'https://apimobile.callproof.com/api/contacteventform/{contact_event_form_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

cURL Example for iOS

 curl --location --request DELETE 'https://apimobile.callproof.com/api/contacteventform/{contact_event_form_id}' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' 

Successful Response (200)

Indicates that the contact event form was deleted 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, "The Event Form has been deleted.")
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – the contact event form could not be deleted
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – Invalid contact event form ID ("ContactEventForm Id is Invalid"), or another delete error (for example, "Error while Remove ContactEventForm").
  • 401 – Authentication failed or the access token is missing/expired.