Enable or Disable CNAM Lookups on a Phone Number

Enable or disable CNAM lookups for a specific Flowroute DID.

Lets you enable or disable CNAM lookups on a long code or toll-free number on your account.

Endpoint

PATCH /numbers/:number_id

Path Parameters

  • number_id
    integer REQUIRED

    The unique identifier for your Flowroute longcode phone number to be disassociated with its related CNAM record.

Body Parameters

  • value
    string REQUIRED

    The string to be displayed as the CNAM for a long code number.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains information on the updated number object in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

  • cnam_lookups_enabled
    boolean

    "true" or "false" depending on the desired outcome.

  • type
    string

    This will always be number.


Example Request

PATCH /v2/numbers/12064205780 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "cnam_lookups_enabled": "true",
  "type": "number"
}

Example Request

curl -X PATCH https://api.flowroute.com/v2/numbers/12064205780 -u accessKey:secretKey -H 'Content-Type': 'application/vnd.api+json' -d '{"cnam_lookups_enabled: "true", "type": "number"}'

Example Response

200 OK

401 Unauthorized

{
  "errors": [
    {
      "detail": "Authentication failed.",
      "id": "7fc8c70a-ca58-430c-b383-b89df84f8083",
      "status": 401,
      "title": "Unauthorized"
    }
  ]
}

403 Forbidden

{  "errors": 
  [
    {
      "status": 403, 
      "detail": "", 
      "title": "ActionNotAuthorizedError"
    }
  ]
}