Skip to main content

Update your organization

Route

PUT
/api/v1/organizations

Usage

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request PUT "$LAGO_URL/api/v1/organizations" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"organization": {
"name": "Name1",
"webhook_url": "https://test-example.example",
"country": "CZ",
"address_line1": "address1",
"address_line2": null,
"state": "state1",
"zipcode": "10000",
"email": "org@email.com",
"city": "city125",
"legal_name": null,
"legal_number": null,
"tax_identification_number": "EU123456789",
"timezone": "Europe/Paris",
"email_settings": [
"invoice.finalized",
"credit_note.created"
],
"billing_configuration": {
"invoice_footer": "footer custom",
"invoice_grace_period": 3,
"document_locale": "fr",
"vat_rate": 15.0
}
}
}'

Arguments

{
"organization": {
"webhook_url": "https://test-example.example",
"country": "CZ",
"address_line1": "address1",
"address_line2": null,
"state": "state1",
"zipcode": "10000",
"email": "org@email.com",
"city": "city125",
"legal_name": null,
"legal_number": null,
"tax_identification_number": "EU123456789",
"timezone": "Europe/Paris",
"email_settings": ["invoice.finalized", "credit_note.created"],
"billing_configuration": {
"invoice_footer": "footer custom",
"invoice_grace_period": 3,
"document_locale": "fr",
"vat_rate": 15.0
}
}
}
AttributesTypeDescription
webhook_urlString      OptionalWebhook URL
countryString      Optional
ISO 3166 (alpha-2)
Country where the organization is located
address_line1String      OptionalAddress (first line)
address_line2String      OptionalAddress (second line)
stateString      OptionalState where the organization is located
zipcodeString      OptionalZip code associated with the organization's address
emailString      OptionalBusiness email address
cityString      OptionalCity where the organization is located
legal_nameString      OptionalLegal name of the organization
legal_numberString      OptionalLegal number of the organization
tax_identification_numberString      OptionalTax identification number of the organization
timezoneString      Optional
TZ database
Timezone of the organization - learn more
UTC by default
email_settingsArray      Optional
Possible values are invoice.finalized and credit_note.created
Email settings of the organization
billing_configurationObject      OptionalCustom billing settings

Billing configuration

AttributesTypeDescription
invoice_footerString      OptionalCustom invoice footer
invoice_grace_periodInteger      OptionalGrace period (in days)
document_localeString      OptionalDocument locale in ISO 639-1 format - learn more
vat_rateFloat      OptionalCustom VAT rate

Responses

The organization was successfully updated

Returns an organization object.