View The Text Message Templates

From docs
Revision as of 06:54, 21 July 2026 by Ashley DeBon (talk | contribs) (Get Text Message Template Details)
Jump to: navigation, search

Mobile_API »Get Text Message Template Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/text-message-templates/{id}

Purpose

Retrieves a single text message template that belongs to the authenticated user, including its title and message body.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
id integer Yes Unique identifier of the text message template

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns the requested template details.

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
data object Template detail payload
uri string Requested resource URI

data

Field Type Description
id integer Unique identifier of the template
title string Template title (defaults to "Title" when empty)
message string Template message body

Error Responses

Status Code Meaning
400 Bad Request – the template could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – No matching template found for the user ("No Records Found"), or another retrieval error (for example, "Error while retrieving the text message template details").
  • 401 – Authentication failed or the access token is missing/expired.