Remove a CNAM Record From Your Account

Lets you remove a CNAM record from your account. This will automatically disassociate all numbers associated with the specified CNAM record.

Endpoint

DELETE /cnams/:cnam_id

Path Parameter

  • cnam_id
    integer REQUIRED

    The unique identifier for the CNAM record to be removed from your account.

Response Fields

On success, the HTTP status code in the response header is 204 No Content which means that the server successfully processed the request and is not returning any content. On error, the header status code is an error code and the response body contains an array of error objects.


Example Request

DELETE /v2/cnams/23181 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Example Request

curl -X DELETE https://api.flowroute.com/v2/e911s/23181 -u accessKey:secretKey

Example Request

This assumes that you have the Python API Wrapper installed and set up. The following example is from cnam_demo.py. Please make sure to use neutral (vertical) quotes in your request. Smart quotes are known to cause errors. 


# Instantiate the API client and create a controller for Messages
client = FlowroutenumbersandmessagingClient(basic_auth_user_name, basic_auth_password)
cnams_controller = client.cnams
print("\n--Remove a CNAM Record from your account")
result = cnams_controller.remove_cnam(cnam_id)
pprint.pprint(result)

Example Responses

204 NO CONTENT

404 Not Found

{
  "errors": [
    {
      "detail": "CNAM record not found. Nothing to delete.",
      "id": "849e9a08-dbed-417c-acf7-84e94877c317",
      "status": 404,
      "title": "Resource not found"
    }
  ]
}

403 Forbidden

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