Difference between revisions of "Start Appointment For Contact"
Ashley DeBon (talk | contribs) (Created page with "== Start Contact Appointment == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/start-appointment === Purpose === Starts an active appointmen...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 45: | Line 45: | ||
| event_form_id || integer || No || Event form identifier to associate with the appointment, when applicable | | event_form_id || integer || No || Event form identifier to associate with the appointment, when applicable | ||
|} | |} | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/contact/start-appointment' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ | ||
| + | --form 'contact_id=12345' \ | ||
| + | --form 'start=1752739200' | ||
| + | </pre> | ||
| + | === cURL Example for iOS === | ||
| + | <pre> | ||
| + | curl --location --request POST 'https://apimobile.callproof.com/api/contact/start-appointment' \ | ||
| + | --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ | ||
| + | --form 'contact_id=12345' \ | ||
| + | --form 'start=1752739200' | ||
| + | </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 07:54, 17 July 2026
Contents
Start Contact Appointment
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/start-appointment
Purpose
Starts an active appointment / check-in for a specific contact. If the user already has an open appointment, the request is rejected. When started successfully, any previous open appointment may be auto-ended, the user’s location can be logged, and appointment activity is recorded for the contact.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | integer | Yes | Unique identifier of the contact for which the appointment is started |
| start | number | Yes | Appointment start time as a Unix timestamp |
| latitude | number | No | User’s latitude at the start of the appointment |
| longitude | number | No | User’s longitude at the start of the appointment |
| event_form_id | integer | No | Event form identifier to associate with the appointment, when applicable |
cURL Example for Android
curl --location --request POST 'https://apimobile.callproof.com/api/contact/start-appointment' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'contact_id=12345' \ --form 'start=1752739200'
cURL Example for iOS
curl --location --request POST 'https://apimobile.callproof.com/api/contact/start-appointment' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --form 'contact_id=12345' \ --form 'start=1752739200'
Successful Response (200)
Indicates that the appointment was started successfully for the specified contact.
| 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, "Appointment Started Successfully") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Validation failure – request body failed validation (returned with an error payload and clientStatusCode 401)
|
| 400 | Bad Request – the appointment could not be started (for example, contact not found, appointment already exists, or processing error) |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 200 (validation failure) – Required fields are missing or invalid (for example, missing or non-integer
contact_id, or missing/non-numericstart). - 400 – The contact was not found, an appointment is already active for the user ("Appointment Already Exist"), or another error occurred while starting the appointment.
- 401 – Authentication failed or the access token is missing/expired.
