Update circuit partially

1 minute(s) read

Prev Next

Patch

/circuits/{id}/

Operation is used to update specific fields in existing circuit. Available from product version 3.2.6.

Security

API Key: Token

Header parameter nameAuthorization

Token issued for API consumer.

Path parameters

integerRequired

Id of circuit to update

Body parameters

Circuit attributes and values to be updated

object

areaCode

string

Circuit area code

comments

string

Circuit comments. Available from product version 3.2.8.

contractLength

integer

Circuit contract length

contractNumber

string

Circuit contract number

customer

integer

Circuit customer id

directLength

number (float)

Circuit direct length

identifier

string

Circuit identifier

identifierAlt

string

Circuit alternative identifier

importance

integer

Circuit importance id

installationAddresses

Array of string

Circuit installations addresses

string (url)

length

number (float)

Circuit length

orderNumber

string

Circuit order number

organisation

integer

Circuit organisation id

redundancy

integer

Circuit redundancy id

sections

Array of string

Circuit sections

string (url)

supercircuit

integer

Super circuit ID. Available from product version v2026.2.

supercircuitOrderNo

integer

Order number of this circuit within the super circuit. Available from product version v2026.2.

Responses

200

Object was updated successfully

object

areaCode

string

Circuit area code

comments

string

Circuit comments. Available from product version 3.2.8.

contractLength

integer

Circuit contract length

contractNumber

string

Circuit contract number

createdAt

string (date-time)

Creation timestamp (date and time). Available from product version v2026.1.

createdBy

string

Creator username

createdTs

string (date)

Creation date (date only, existing field)

customer

integer

Circuit customer id

directLength

number (float)

Circuit direct length

integer

Primary key

identifier

string

Circuit identifier

identifierAlt

string

Circuit alternative identifier

importance

integer

Circuit importance id

installationAddresses

Array of string

Circuit installations addresses

string (url)

length

number (float)

Circuit length

orderNumber

string

Circuit order number

organisation

integer

Circuit organisation id

redundancy

integer

Circuit redundancy id

sections

Array of string

Circuit sections

string (url)

supercircuit

integer

Super circuit ID. Available from product version v2026.2.

supercircuitOrderNo

integer

Order number of this circuit within the super circuit. Available from product version v2026.2.

updatedAt

string (date-time)

Last update timestamp (date and time). Available from product version v2026.1.

updatedBy

string

Last updater username

updatedTs

string (date)

Last update date (date only, existing field)

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

Standard error response payload

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

Standard error response payload

details

string

Detailed description of error

Documentation Index

Update circuit partially