Update CNAM of a Number

This endpoint is in Beta. Some features may change as we receive and incorporate your feedback. We will notify you of any breaking changes before deploying them.

Use this endpoint to add aCNAM preset for a long-code phone number within a port order. Learn more about CNAM in this blog post.

Endpoint

PATCH /portorders/:portorder_id/relationships/numbers/:number_id/relationships/cnam

Path Parameters

  • portorder_id
    integer

    The unique identifier for the Port Order that you would like to update.

  • number_id
    integer

    The unique identifier for the number that you would like to update.

Body Parameters

  • cnam
    string

    The caller-ID name to be associated with a long-code number. You can store up to 15 characters for this value. Note: Not valid for toll-free numbers.


Example Request

curl https://api.flowroute.com/v2/portorders/899011/relationships/numbers/12068843283/relationships/cnam \
    -u accessKey:secretKey \
    -X PATCH \
    -d '{"data": {"type": "cnam", "id": "1234"}}' 

            

Example Response

{
  "type": "number",
  "id": "12068843283",
  "links": {
    "self": "https://api.flowroute.com/v2/portorders/899011/relationships/numbers/12068843283"
  },
  "attributes": {
    "alias": "new alias",
    "cnam_lookups_enabled": false,
    "number_type": "long-code",
    "rate_center": "seattle",
    "state": "wa",
    "value": "12068843283"
  },
  "relationships": {
    "cnam": {
      "data": {
        "type": "cnam",
        "id": "1234"
      }
    },
    "e911": {
      "data": null
    },
    "failover_route": {
      "data": null
    },
    "primary_route": {
      "data": null
    }
  },
  "included": [
    {
      "type": "cnam",
      "id": "1234"
    }
  ]
}