PATCH api/cli/{id}

The purpose of this method is to update information of a CLI via the CLI ID.

Error Messages
  • 404/NotFound - Cli with id = X not found - Specified ID is not assigned to a CLI
  • 400/BadRequest - Line Type not valid - The specified Line Type is not compatible with the CLI
  • 400/BadRequest - Call Type not valid - The specified Call Type is not compatible with the CLI
  • 400/BadRequest - The End date can't be set before the Start date - Specified End Date is before the start state.
  • 409/Conflict - Validation error message

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id CLI ID - The unique identifer for the CLI being updated. integer

Required

Body Parameters

CLIPatch
NameDescriptionTypeAdditional information
LineTypeID The ID of the Line Type integer

None.
CallType The type of call on the CLI e.g voice, data, etc string

String length: inclusive between 0 and 10
ChargesEndDate The endate of the current charge of the CLI date

None.
StartDate Start date of the CLI date

None.
EndDate The date the CLI will cease date

None.
ContractStartDate date

None.
ContractEndDate date

None.
CustomColumns Custom columns that can be used to add extra data to the CLI CLICustomColumns

None.

Request Formats

application/json, text/json

Sample: 
{
  "LineTypeID": 1,
  "CallType": "sample string 1",
  "ChargesEndDate": "2025-04-25T02:03:31.505",
  "StartDate": "2025-04-25T02:03:31.505",
  "EndDate": "2025-04-25T02:03:31.505",
  "ContractStartDate": "2025-04-25T02:03:31.505",
  "ContractEndDate": "2025-04-25T02:03:31.505",
  "CustomColumns": {
    "CustomColumn1": "sample string 1",
    "CustomColumn2": "sample string 2",
    "CustomColumn3": "sample string 3",
    "CustomColumn4": "sample string 4",
    "CustomColumn5": "sample string 5",
    "CustomColumn6": "sample string 6",
    "CustomColumn7": "sample string 7",
    "CustomColumn8": "sample string 8",
    "CustomColumn9": "sample string 9",
    "CustomColumn10": "sample string 10"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.