Difference between revisions of "Delete the Text Message Templates"
Ashley DeBon (talk | contribs) (Created page with "== Delete Text Message Template == === Base URL === https://apimobile.callproof.com === Endpoint === /api/text-message-templates/{id} === Purpose === Deletes a text message...") |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | == Delete Text Message Template == | + | == [[Mobile_API]] »Delete Text Message Template == |
=== Base URL === | === Base URL === | ||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/text-message-templates/YOUR_TEMPLATE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location --request DELETE 'https://apimobile.callproof.com/api/text-message-templates/YOUR_TEMPLATE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 07:21, 21 July 2026
Mobile_API »Delete Text Message Template
Base URL
https://apimobile.callproof.com
Endpoint
/api/text-message-templates/{id}
Purpose
Deletes a text message template that belongs to the authenticated user.
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 |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the text message template to delete |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location --request DELETE 'https://apimobile.callproof.com/api/text-message-templates/YOUR_TEMPLATE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location --request DELETE 'https://apimobile.callproof.com/api/text-message-templates/YOUR_TEMPLATE_ID' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Indicates that the text message template 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 text message templates are deleted successfully.") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – the template could not be deleted |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – Template not found for the user ("Text message templates not found"), or another deletion error (for example, "Error while deleting the text message template details").
- 401 – Authentication failed or the access token is missing/expired.
