Organization Update

patch

https://partner-api.getpliant.com/api/organizations/{organizationId}

Update an existing organization. You need to provide all fields with their current values if they should remain unchanged. If you want to update a field, you need to provide the new value. If you want to remove a field, you need to provide null as value.

Path Params

organizationId

uuid

required

The unique identifier of the organization.

Body Params

billingEmail

string

required

The email address to which invoices and other billing information are sent.

partnersOrganizationId

string | null

deprecated

An identifier of the organization in the partner's system. This is defined by the partner and can be used to link the organization in the partner's system with the organization in the Pliant system.

partnerOrganizationId

string | null

An identifier of the organization in the partner's system. This is defined by the partner and can be used to link the organization in the partner's system with the organization in the Pliant system.

missingReceiptNotifications

boolean | null

If set to true, the organization will receive notifications about missing receipts. If set to false, the organization will not receive notifications about missing receipts.

vatId

string | null

The valid VAT ID of the organization.

tradeName

string | null

An organization may use a different name, e.g. for marketing purposes. In case a trade name is provided, this will be the one printed on the employees' physical cards, instead of the organization's legal name. This field is only optional, as long as the legal name of the organization is not longer than 20 characters.

If the legal name is longer than 20 characters, the trade name is required:

The trade name maximum length is 20 characters, since it is printed on the physical cards.
Trade name cannot be null or empty.

deliveryAddress

object

required

The delivery address of the organization. Used to deliver physical cards.

Responses

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

500Internal Server Error. The request was not completed due to an internal error.