Companies

Update a company

Changes only the fields in the request. Either all of them are changed or none. See CompanyUpdate for how to clear a field.

patch/v1/locations/{locationId}/companies/{companyId}

Request

  • Base URL: https://api.cliento.com
  • URL: https://api.cliento.com/v1/locations/{locationId}/companies/{companyId}
  • Auth: HTTP bearer

Path parameters

locationIdstring required
companyIdstring required

Headers

Idempotency-Keystring

A value you make up for this one request, such as a UUID. Send the same value when you retry and the first answer is returned; see Retrying safely.

Request body

departmentstring nullable

A part of the company, when the location serves several of them.

emailstring nullable
namestring
notesstring nullable

Staff-facing notes, at most 1000 characters.

organisationNumberstring nullable

The Swedish organisation number: ten digits with a valid check digit, with no hyphen.

otherPhoneNumberstring nullable
phoneNumberstring nullable

Phone number in E.164 format: a plus sign, the country code and the number, at most 15 digits.

Example request

{
  "address": {
    "city": "Stockholm",
    "country": "SE",
    "line1": "Storgatan 12",
    "line2": "Lgh 1102",
    "postCode": "111 51"
  },
  "department": "Used cars",
  "email": "info@example.com",
  "name": "Bilfirman AB",
  "organisationNumber": "5560360793",
  "otherPhoneNumber": "+4686543210",
  "phoneNumber": "+46701234567"
}

Response

OK

createdAtstring date-time
departmentstring

A part of the company, when the location serves several of them.

emailstring
externalReferencestring

Your own id for it, as sent when it was created.

idstring required
locationIdstring required
namestring
notesstring

Staff-facing notes, at most 1000 characters.

organisationNumberstring

The Swedish organisation number: ten digits with a valid check digit, with no hyphen.

otherPhoneNumberstring
phoneNumberstring

Phone number, in E.164 format when it was set through this API.

updatedAtstring date-time

Example response

{
  "address": {
    "city": "Stockholm",
    "country": "SE",
    "line1": "Storgatan 12",
    "line2": "Lgh 1102",
    "postCode": "111 51"
  },
  "department": "Used cars",
  "email": "info@example.com",
  "externalReference": "crm-88121",
  "id": "com_6Tn3wRd8Kq1Vb5Xs9LmPyA",
  "locationId": "loc_4fK9xQ2mLr8TzB1vNc7HdW",
  "name": "Bilfirman AB",
  "organisationNumber": "5560360793",
  "otherPhoneNumber": "+4686543210",
  "phoneNumber": "+46701234567"
}

Changes

No recorded changes to this operation across all 1 revision of this API.