Skip to main content
PUT
Update partner

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partnerId
string
required

Partner external ID

Example:

"abc123"

Body

application/json

Payload used to update a partner. Only the supplied properties are updated; unknown properties are ignored. id and clientApplicationId cannot be changed.

name
string

Partner name. If supplied, must be a non-blank string.

partnerCode
string | null

Partner code, must be unique. Free-form string - the server does not enforce a length limit or character-set restriction on it beyond the uniqueness check. Omitting this property leaves the current partner code unchanged. Sending an explicit null is also treated as omission and never clears the partner code - it cannot be cleared via this endpoint. This is unlike vat and sendEventToExternalSystem below, where null is a meaningful value that clears the field; despite nullable: true being set here too, for partnerCode specifically null behaves exactly like omitting the property.

vat
string | null

VAT number. Free-form string - the server does not validate, normalize, or restrict its format. Omitting this property leaves the current VAT number unchanged. Sending an explicit null clears it.

sendEventToExternalSystem
boolean | null

Whether events should be sent to an external system. Omitting this property leaves the current value unchanged. Sending an explicit null clears it.

settings
object

Partner settings map. Only these top-level keys are allowed: maxNumberOfCards, numberOfReportGroups, showReportOverview, fieldSettings, fortnox. Any other top-level key is rejected with INVALID_PARTNER_SETTINGS_KEY.

Response

Partner updated

Partner resource returned when a partner is created or updated.

id
string
required

Partner external ID

name
string
required

Partner name

clientApplicationId
string
required

Client application that owns the partner

dateCreated
string<date-time>
required

Creation date

partnerCode
string | null

Partner code

vat
string | null

VAT number

sendEventToExternalSystem
boolean | null

Whether events are sent to an external system

settings
object

Partner settings map. Only these top-level keys are allowed: maxNumberOfCards, numberOfReportGroups, showReportOverview, fieldSettings, fortnox. Any other top-level key is rejected with INVALID_PARTNER_SETTINGS_KEY.