Sign in
Profiles

List messaging profiles

Lists the messaging profiles owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

get/messaging_profiles

Query parameters

namestring

Filter by name

Consolidated filter parameter (deepObject style). Originally: filter[name]

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

filter[name][eq]string

Filter profiles by exact name match.

filter[name][contains]string

Filter profiles by name containing the given string.

Response

Successful response with a list of messaging profiles.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      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/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      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