Skip to main content
PUT
Update organisation

Authorizations

x-dolfin-api-key
string
header
required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
required
industryId
string<uuid>
required
contactEmail
string
required
country
string
required

ISO 3166-1 alpha-2 country code (e.g. GB, US, DE)

phone
null | string
website
null | string
addressLine1
null | string
addressLine2
null | string
city
null | string
postalCode
null | string
taxNumber
null | string
companyRegistrationNumber
null | string
vatRegistered
null | boolean
businessType
null | any
Available options:
SoleTrader,
LimitedCompany,
LLP,
Partnership,
null
incorporationYear
employeeCount
null | any
Available options:
OneToTen,
ElevenToFifty,
FiftyOneToTwoHundred,
TwoHundredToOneThousand,
OneThousandPlus,
null
annualRevenue
null | any
Available options:
Under100k,
OneHundredToFiveHundredK,
FiveHundredKToTwoM,
TwoMPlus,
null
avgInvoicesPerMonth
null | any
Available options:
OneToTen,
ElevenToFifty,
FiftyToOneHundred,
OneHundredPlus,
null
avgInvoiceValue
null | any
Available options:
Under500,
FiveHundredToFiveK,
FiveKToFiftyK,
Over50k,
null
primaryPaymentMethod
null | any
Available options:
BankTransfer,
Card,
DirectDebit,
Cash,
null
primaryColour
null | string
logoUrl
null | string
defaultCurrency
null | string

ISO 4217 currency code (e.g. GBP, USD, EUR)

hasBeenOnboarded
null | boolean

Response

OK

name
string
required
contactEmail
string
required
country
string
required

ISO 3166-1 alpha-2 country code (e.g. GB, US, DE)

id
string<uuid>
companyId
null | string<uuid>

Parent company this organisation belongs to, when it is one site of a multi-site business. Null for a standalone organisation.

industryId
string<uuid>
industryCode
null | string
industryDisplayName
null | string
phone
null | string
website
null | string
addressLine1
null | string
addressLine2
null | string
city
null | string
postalCode
null | string
taxNumber
null | string
companyRegistrationNumber
null | string
vatRegistered
null | boolean
businessType
null | any
Available options:
SoleTrader,
LimitedCompany,
LLP,
Partnership,
null
incorporationYear
employeeCount
null | any
Available options:
OneToTen,
ElevenToFifty,
FiftyOneToTwoHundred,
TwoHundredToOneThousand,
OneThousandPlus,
null
annualRevenue
null | any
Available options:
Under100k,
OneHundredToFiveHundredK,
FiveHundredKToTwoM,
TwoMPlus,
null
avgInvoicesPerMonth
null | any
Available options:
OneToTen,
ElevenToFifty,
FiftyToOneHundred,
OneHundredPlus,
null
avgInvoiceValue
null | any
Available options:
Under500,
FiveHundredToFiveK,
FiveKToFiftyK,
Over50k,
null
primaryPaymentMethod
null | any
Available options:
BankTransfer,
Card,
DirectDebit,
Cash,
null
primaryColour
null | string
logoUrl
null | string
defaultCurrency
null | string

ISO 4217 currency code (e.g. GBP, USD, EUR)

hasBeenOnboarded
boolean
createdAt
string<date-time>
createdBy
null | string<uuid>
updatedAt
string<date-time>
updatedBy
null | string<uuid>