Update partner

put

https://stage-api.findity.com/api/v1/admin/partners/{partnerId}

Updates an existing partner. Only the supplied properties are updated; unknown properties are ignored. For vat and sendEventToExternalSystem, omitting the property leaves its current value unchanged, while sending an explicit null clears it. partnerCode is the exception: a null value is treated the same as omitting the property and never clears the existing partner code, since it cannot be removed via this endpoint. See the request schema for the exact per-property behavior. id and clientApplicationId cannot be changed via this request. The caller must be allowed to administer the partner. Returns the updated partner.

Path Params

partnerId

string

required

Partner external ID

Body Params

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.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Partner updated

400Bad request - invalid JSON body, no known properties, an unrecognized settings key, or a duplicate partnerCode

403Forbidden - either no partner exists with the given partnerId, or the caller is not allowed to update it. These two cases are intentionally indistinguishable, so a caller without access cannot use this endpoint to discover whether a partnerId exists.