updateCompany

WRITE

Update company.

POST /api/v1/settings/updateCompany

curl -X POST '<your-host>/api/v1/settings/updateCompany' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "stateProvince": "string",
    "postalCode": "string",
    "countryCode": "string",
    "baseCurrencyCode": "string",
    "timezone": "string",
    "website": "string",
    "taxId": "string",
    "phone": "string",
    "fax": "string",
    "email": "string",
    "vatNumber": "string",
    "eori": "string",
    "registrationNumber": "string"
  }'

Parameters

ParameterType

min length 1

pattern ^\+[1-9]\d{1,14}$

min length 1

pattern ^\+[1-9]\d{1,14}$

min length 1

Input schema

schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "addressLine1": {
      "type": "string",
      "minLength": 1
    },
    "addressLine2": {
      "type": "string"
    },
    "city": {
      "type": "string",
      "minLength": 1
    },
    "stateProvince": {
      "type": "string"
    },
    "postalCode": {
      "type": "string",
      "minLength": 1
    },
    "countryCode": {
      "type": "string",
      "minLength": 1
    },
    "baseCurrencyCode": {
      "type": "string"
    },
    "timezone": {
      "type": "string",
      "minLength": 1
    },
    "website": {
      "type": "string"
    },
    "taxId": {
      "type": "string"
    },
    "phone": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$"
    },
    "fax": {
      "type": "string",
      "pattern": "^\\+[1-9]\\d{1,14}$"
    },
    "email": {
      "type": "string"
    },
    "vatNumber": {
      "type": "string"
    },
    "eori": {
      "type": "string"
    },
    "registrationNumber": {
      "type": "string"
    }
  }
}