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

2026-07-20T08:58:34Z

‎Successful Response (200)

Ashley DeBon: /* Create Route */

2026-07-20T08:56:55Z

‎Create Route

Ashley DeBon: Created page with "== Create Route == === Base URL === https://apimobile.callproof.com === Endpoint === /api/routes === Purpose === Creates a new route for the authenticated user, including t..."

2026-07-20T08:56:37Z

Created page with "== Create Route == === Base URL === https://apimobile.callproof.com === Endpoint === /api/routes === Purpose === Creates a new route for the authenticated user, including t..."

New page

== Create Route ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/routes

=== Purpose ===
Creates a new route for the authenticated user, including the route name and the contacts assigned to that route. Optionally records who assigned the route.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

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

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| route_name || string || Yes || Name of the route (must be unique for the authenticated user)
|-
| contact_ids || string || Yes || Contact IDs to include on the route (must not be empty)
|-
| assigned_by || integer || No || User ID of the person who assigned the route
|}

=== Successful Response (200) ===
Indicates that the route was created successfully.

{| 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
|-
| message || string || Confirmation message (for example, "Routes added successfully")
|-
| route_id || integer || Unique identifier of the newly created route
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – the route could not be created
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – Route name already exists ("Route Name Already Exists"), contacts missing ("Route Contacts Required"), or another create error (for example, "Error while Adding Routes").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 08:56, 20 July 2026
Line 1:		Line 1:
−	== Create Route ==	+	== [[Mobile_API]] »Create Route ==

	=== Base URL ===		=== Base URL ===

@@ Line 41: / Line 41: @@
 | assigned_by || integer || No || User ID of the person who assigned the route
 |}
 === Successful Response (200) ===

Store Routes - Revision history

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

Ashley DeBon: /* Create Route */

Ashley DeBon: Created page with "== Create Route == === Base URL === https://apimobile.callproof.com === Endpoint === /api/routes === Purpose === Creates a new route for the authenticated user, including t..."