Skip to main content
PUT
Update link
To change individual fields, use a partial update: PATCH changes only the fields you send. Value is required. LinkType: 0 other, 1 e-mail, 2 website, 3 LinkedIn, 4 Instagram, 5 X. For type 1 the value must be a valid e-mail address.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

customerId
string<uuid>
required

Customer ID.

Link ID.

Body

Value
null | string

Required. E-mail address or URL. Must be a valid e-mail address when LinkType is 1.

0: Other, 1: E-mail, 2: Website, 3: LinkedIn, 4: Instagram, 5: X.

Example:

1

Description
null | string

Description.

Example:

"Invoices"

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.