Update Company

Update an existing company. Changing the VAT number or enterprise number revokes any open verification sessions for the company. If the company was already verified, its verification status is also revoked and the company must be verified again.

Authorization

AuthorizationBasic <token>

Basic API key authentication. Create a new API key and secret in the Recommand dashboard.

In: header

Path Parameters

companyId*string

The ID of the company to update

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

address?string

postalCode?string

city?string

country?string

Value in

"AU" | "AT" | "BE" | "BG" | "CA" | "HR" | "DK" | "EE" | "FI" | "FR" | "DE" | "GR" | "HU" | "IS" | "IE" | "IT" | "JP" | "LV" | "LU" | "MY" | "NL" | "NZ" | "NO" | "PL" | "PT" | "RO" | "SG" | "SK" | "SI" | "ES" | "SE" | "AE" | "GB" | "US"

enterpriseNumberScheme?string | null

Value in

"0002" | "0003" | "0004" | "0005" | "0006" | "0007" | "0008" | "0009" | "0010" | "0011" | "0012" | "0013" | "0014" | "0015" | "0016" | "0017" | "0018" | "0019" | "0020" | "0021" | "0022" | "0023" | "0024" | "0025" | "0026" | "0027" | "0028" | "0029" | "0030" | "0031" | "0032" | "0033" | "0034" | "0035" | "0036" | "0037" | "0038" | "0039" | "0040" | "0041" | "0042" | "0043" | "0044" | "0045" | "0046" | "0047" | "0048" | "0049" | "0050" | "0051" | "0052" | "0053" | "0054" | "0055" | "0056" | "0057" | "0058" | "0059" | "0060" | "0061" | "0062" | "0063" | "0064" | "0065" | "0066" | "0067" | "0068" | "0069" | "0070" | "0071" | "0072" | "0073" | "0074" | "0075" | "0076" | "0077" | "0078" | "0079" | "0080" | "0081" | "0082" | "0083" | "0084" | "0085" | "0086" | "0087" | "0088" | "0089" | "0090" | "0091" | "0093" | "0094" | "0095" | "0096" | "0097" | "0098" | "0099" | "0100" | "0101" | "0102" | "0104" | "0105" | "0106" | "0107" | "0108" | "0109" | "0110" | "0111" | "0112" | "0113" | "0114" | "0115" | "0116" | "0117" | "0118" | "0119" | "0120" | "0121" | "0122" | "0123" | "0124" | "0125" | "0126" | "0127" | "0128" | "0129" | "0130" | "0131" | "0132" | "0133" | "0134" | "0135" | "0136" | "0137" | "0138" | "0139" | "0140" | "0141" | "0142" | "0143" | "0144" | "0145" | "0146" | "0147" | "0148" | "0149" | "0150" | "0151" | "0152" | "0153" | "0154" | "0155" | "0156" | "0157" | "0158" | "0159" | "0160" | "0161" | "0162" | "0163" | "0164" | "0165" | "0166" | "0167" | "0168" | "0169" | "0170" | "0171" | "0172" | "0173" | "0174" | "0175" | "0176" | "0177" | "0178" | "0179" | "0180" | "0183" | "0184" | "0185" | "0186" | "0187" | "0188" | "0189" | "0190" | "0191" | "0192" | "0193" | "0194" | "0195" | "0196" | "0197" | "0198" | "0199" | "0200" | "0201" | "0202" | "0203" | "0204" | "0205" | "0206" | "0207" | "0208" | "0209" | "0210" | "0211" | "0212" | "0213" | "0214" | "0215" | "0216" | "0217" | "0218" | "0219" | "0220" | "0221" | "0222" | "0223" | "0224" | "0225" | "0226" | "0227" | "0228" | "0229" | "0230" | "0231" | "0232" | "0233" | "0234" | "0235" | "0236" | "0237" | "0238" | "0239" | "0240" | null

enterpriseNumber?string | null

The enterprise number of the company. Changing its value revokes open verification sessions, and also revokes verification status if the company was verified.

vatNumber?string | null

The VAT number of the company. Changing its value revokes open verification sessions, and also revokes verification status if the company was verified.

email?string | null

phone?string | null

isSmpRecipient?boolean

Response Body

`application/json`

curl -X PUT "https://app.recommand.eu/api/v1/companies/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true,
  "company": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "country": "string",
    "enterpriseNumberScheme": "string",
    "enterpriseNumber": "string",
    "vatNumber": "string",
    "email": "string",
    "phone": "string",
    "isSmpRecipient": true,
    "isVerified": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

{
  "success": false,
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`