Update an existing company by its ID

PUT/companies/{id}

Last modified: 2 months ago

Request

Path Params

string

required

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Accept-Language

string

optional

Example:

note

object (CompanyNoteForCreateDto)

optional

note

string | null

optional

tags

array[object (CobraTagForEmbeddedDto) {2}] | null

optional

string | null

optional

text

string | null

optional

<= 200 characters

socialMedias

array[object (EmbeddedSocialMediaForCreateDto) {2}] | null

optional

type

string | null

optional

<= 200 characters

profileLink

string | null

optional

name

string

required

>= 1 characters<= 200 characters

companyNameShort

string | null

optional

<= 70 characters

website

string | null

optional

industrySector

object (EmbeddedIndustrySectorInputDto)

optional

string

required

Match pattern:

^([A-F]|[a-f]|[0-9]){24}$

lifecycle

object (EmbeddedLifecycleInputDto)

optional

lifecycleId

string

required

Match pattern:

^([A-F]|[a-f]|[0-9]){24}$

foundingYear

integer <int32> | null

optional

> 1501< 9999

annualTurnover

string | null

optional

numberOfEmployees

object (EmbeddedNumberOfEmployeesInputDto)

optional

string

required

Match pattern:

^([A-F]|[a-f]|[0-9]){24}$

numberOfCustomers

object (EmbeddedNumberOfCustomersInputDto)

optional

string

required

Match pattern:

^([A-F]|[a-f]|[0-9]){24}$

legalForm

object (EmbeddedLegalFormInputDto)

optional

string

required

Match pattern:

^([A-F]|[a-f]|[0-9]){24}$

commercialRegisterNumber

string | null

optional

<= 200 characters

vatNumber

string | null

optional

<= 200 characters

taxId

string | null

optional

<= 200 characters

businessRelationSince

string <date-time> | null

optional

referenceNumbers

array[object (CompanyReferenceNumberForCreateDto) {2}] | null

optional

type

object (EmbeddedReferenceNumberTypeInputDto)

required

number

string | null

optional

<= 50 characters

bankAccounts

array[object (BankAccountDetailForPutDto) {6}] | null

optional

mandateReference

string | null

optional

<= 200 characters

mandateValidUntil

string <date-time> | null

optional

iban

string | null

optional

bic

string | null

optional

Match pattern:

([A-Z]{4})([A-Z]{2})(([2-9A-Z]{1})([0-9A-NP-Z]{1}))((([0-9A-WY-Z]{1})([0-9A-Z]{2}))|([X]{3})|)

directDebitAuthorized

boolean

optional

string | null

optional

status

string | null

optional

{
  "note": {
    "note": "string"
  },
  "tags": [
    {
      "id": "string",
      "text": "string"
    }
  ],
  "socialMedias": [
    {
      "type": "string",
      "profileLink": "string"
    }
  ],
  "name": "string",
  "companyNameShort": "string",
  "website": "string",
  "industrySector": {
    "id": "string"
  },
  "lifecycle": {
    "lifecycleId": "string"
  },
  "foundingYear": 1502,
  "annualTurnover": "string",
  "numberOfEmployees": {
    "id": "string"
  },
  "numberOfCustomers": {
    "id": "string"
  },
  "legalForm": {
    "id": "string"
  },
  "commercialRegisterNumber": "string",
  "vatNumber": "string",
  "taxId": "string",
  "businessRelationSince": "2019-08-24T14:15:22.123Z",
  "referenceNumbers": [
    {
      "type": {
        "id": "string"
      },
      "number": "string"
    }
  ],
  "bankAccounts": [
    {
      "mandateReference": "string",
      "mandateValidUntil": "2019-08-24T14:15:22.123Z",
      "iban": "string",
      "bic": "string",
      "directDebitAuthorized": true,
      "id": "string"
    }
  ],
  "status": "string"
}

Request samples

Responses

OK(200)

Forbidden(403)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

data

object (CompanyForDetailedDto)

optional

string | null

optional

createdBy

string | null

optional

modifiedBy

string | null

optional

dateCreated

string <date-time> | null

optional

dateModified

string <date-time> | null

optional

createdByUserId

string <uuid> | null

optional

modifiedByUserId

string <uuid> | null

optional

name

string | null

optional

companyNameShort

string | null

optional

website

string | null

optional

note

object (CompanyNoteForDetailedDto)

optional

documents

array[object (CompanyDocumentForDetailedDto) {11}] | null

optional