Update Routes

Mobile_API »Update Route

Base URL

https://apimobile.callproof.com

Endpoint

/api/routes/{route_id}

Purpose

Updates an existing route’s name, assigned contacts, and optional assigner for the authenticated user’s company.

HTTP Method

PUT

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter	Type	Required	Description
route_id	integer	Yes	Unique identifier of the route to update

Query Parameters

None.

Request Body

Parameter	Type	Required	Description
route_name	string	Yes	Updated route name (must not already exist under the validation rules used by this endpoint)
contact_ids	string	Yes	Updated contact IDs for 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 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, "Route was successfully updated.")
uri	string	Requested resource URI

Error Responses

Status Code	Meaning
400	Bad Request – the route could not be updated
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – Route name already exists ("Route Name Already Exists"), contacts missing ("Route Contacts Required"), or another update error.
• 401 – Authentication failed or the access token is missing/expired.