Skip to main content
POST
/
messaging
/
profiles
/
{id}
/
actions
/
regenerate
/
secret
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.messagingProfiles.actions.regenerateSecret(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.data);
{
  "data": {
    "record_type": "messaging_profile",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Profile for Messages",
    "webhook_url": "https://www.example.com/hooks",
    "webhook_failover_url": "https://backup.example.com/hooks",
    "enabled": true,
    "webhook_api_version": "2",
    "whitelisted_destinations": [
      "US"
    ],
    "created_at": "2019-01-23T18:10:02.574Z",
    "updated_at": "2019-01-23T18:10:02.574Z",
    "number_pool_settings": {
      "toll_free_weight": 10,
      "long_code_weight": 2,
      "skip_unhealthy": false,
      "sticky_sender": true,
      "geomatch": false
    },
    "url_shortener_settings": {
      "domain": "example.ex",
      "prefix": "cmpny",
      "replace_blacklist_only": true,
      "send_webhooks": false
    },
    "v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
    "health_webhook_url": null,
    "mms_fall_back_to_sms": false,
    "mms_transcoding": false,
    "daily_spend_limit": "100.00",
    "daily_spend_limit_enabled": false,
    "redaction_enabled": false,
    "redaction_level": 2,
    "mobile_only": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

The identifier of the messaging profile.

Response

Successful response with details about a messaging profile.

​
data
object
Example:
{
  "record_type": "messaging_profile",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Profile for Messages",
  "webhook_url": "https://www.example.com/hooks",
  "webhook_failover_url": "https://backup.example.com/hooks",
  "enabled": true,
  "webhook_api_version": "2",
  "whitelisted_destinations": ["US"],
  "created_at": "2019-01-23T18:10:02.574Z",
  "updated_at": "2019-01-23T18:10:02.574Z",
  "number_pool_settings": {
    "toll_free_weight": 10,
    "long_code_weight": 2,
    "skip_unhealthy": false,
    "sticky_sender": true,
    "geomatch": false
  },
  "url_shortener_settings": {
    "domain": "example.ex",
    "prefix": "cmpny",
    "replace_blacklist_only": true,
    "send_webhooks": false
  },
  "v1_secret": "rP1VamejkU2v0qIUxntqLW2c",
  "health_webhook_url": null,
  "mms_fall_back_to_sms": false,
  "mms_transcoding": false,
  "daily_spend_limit": "100.00",
  "daily_spend_limit_enabled": false,
  "redaction_enabled": false,
  "redaction_level": 2,
  "mobile_only": false
}