Sign in
Profiles

Retrieve a messaging profile

Returns the complete configuration of the specified messaging profile, including webhook and sender-selection settings.

get/messaging_profiles/{id}

Path parameters

idstring uuid required

The id of the messaging profile to retrieve

Response

Successful response with details about a messaging profile.

Example response

{
  "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,
    "features": {
      "ai_opt_out_detection_enabled": true
    }
  }
}

Changes

Changed in 3 of the 99 revisions of this API.71

  • a6a61a29ecdd1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type changed from object to no type for status

      response-body-type-changed

    • ▲

      the / response's property type changed from object to no type for status

      response-property-type-changed

    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type changed from no type to object for status

      response-body-type-changed

    • ▲

      the / response's property type changed from no type to object for status

      response-property-type-changed

    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    • ▲

      the /// response's property format changed from json-pointer to no format for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.