Update your organization

Route

PUT

/api/v1/organizations

Usage

Curl

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",
      "vat_rate": 15.0,
      "country": "CZ",
      "address_line1": "address1",
      "address_line2": null,
      "state": "state1",
      "zipcode": "10000",
      "email": "org@email.com",
      "city": "city125",
      "legal_name": null,
      "legal_number": null,
      "invoice_footer": "footer custom"
    }
  }'

Python

from lago_python_client import Client
from lago_python_client.models import Organization

client = Client(api_key='__YOUR_API_KEY__')

params = Organization(
  webhook_url="https://new.url",
  vat_rate=14.2
)
client.organizations().update(params)

Ruby

require 'lago-ruby-client'

client = Lago::Api::Client.new({api_key: '__YOUR_API_KEY__'})

update_params = {
  webhook_url: 'https://webhook_url.com',
  vat_rate: 10
}
client.organizations.update(update_params)

Node.js

import Organization from 'lago-nodejs-client/organization'

let client = new Client('__API_KEY__')

await client.updateOrganization(new Organization({
  webhookUrl: "https://newwebhookurl.com",
  vatRate: 15.5
}))

Go

  import "fmt"
  import "github.com/getlago/lago-go-client"

  func main() {
    lagoClient := lago.New().
      SetApiKey("__YOUR_API_KEY__")

    organizationInput := &lago.OrganizationInput{
      LegalName: "Legal Name",
    }

    organization, err := lagoClient.Organization().Update(organizationInput)
    if err != nil {
      // Error is *lago.Error
      panic(err)
    }
      
    // organization is *lago.Organization
    fmt.Println(organization)
  }

Arguments

{
  "organization": {
    "webhook_url": "https://test-example.example",
    "vat_rate": 15.0,
    "country": "CZ",
    "address_line1": "address1",
    "address_line2": null,
    "state": "state1",
    "zipcode": "10000",
    "email": "org@email.com",
    "city": "city125",
    "legal_name": null,
    "legal_number": null,
    "invoice_footer": "footer custom"
  }
}

Attributes	Type	Description
webhook_url	String      Optional	Webhook URL.
vat_rate	Float      Optional	VAT rate.
country	String      Optional	Country alpha-2 code
address_line1	String      Optional	Address first line.
address_line2	String      Optional	Address second line.
state	String      Optional	Organization state.
zipcode	String      Optional	Organization zipcode.
email	String      Optional	Business email.
city	String      Optional	Organization city.
legal_name	String      Optional	Organization legal name.
legal_number	String      Optional	Organization legal number.
invoice_footer	String      Optional	Custom invoice footer.

Responses

HTTP 200

The organization was successfully updated

Returns an organization object.

HTTP 400

{
  "status": 400,
  "error": "Bad Request"
}

The organization json root is not present in the request body.

HTTP 401

{
  "status": 401,
  "error": "Unauthorized"
}

Access to the API endpoint is unhautorized.

Possible reasons are:

• The Authorization header is missing
• The Authorization header does not contain the API key
• The Api key is invalid or expired

HTTP 422

{
  "status": 422,
  "error": "Unprocessable entity",
  "message": "message"
}

Possible error messages:

• Validation error on the record