Sign in

v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Organisations

Update Organisation

Update the details of a single organisation. This is a PUT request which uses upsert semantics. The organisation ID is validated first, if not found an error will be returned - this method cannot be used to create organisations. All changed fields will be updated in the Crezco system. Missing Users will be marked as Active: false. Users without a UserId will be created. Users with a UserId will be updated.

put/organisations/{organisationId}

Path parameters

organisationIdstring uuid required

The unique Crezco ID for an organisation

Headers

Crezco-Versionstring

The requested API version

Request body

organisationIdstring uuid
<p> Unique ID of the organisation in Crezco. Set by Crezco. Ignored when sent as part of a Create or an Update </p>
partnerClientIdstring required
<p> Unique ID of the client in the partner system. This is the unique ID of the client that owns the organisation in your system. Each organisation must have a unique Partner Client Id. </p>
companiesHouseNumberstring
<p> Company Registration Number (CRN) of the UK company as registered with companies house. This is a unique code that Companies House uses to help it quickly and correctly identify a company. A CRN is assigned upon incorporation, which means that limited companies and LLPs (limited liability partnerships) must have one. </p> <p> Some other types of business do not require a CRN because they are not incorporated and are not required to file their statutory records with Companies House. Types of business not requiring a CRN include sole traders and general partnerships. </p> <p> CRNs are always 8 characters long. These can be either 8 digits or 2 letters followed by 6 digits. </p>
companyNamestring

Name of the company that this organisation represents

featuresstring[]

Collection of features that are enabled for this organisation

Example request

{
  "organisationId": "BC77508B-E3C8-4A03-8D96-3045B0DBD499",
  "partnerClientId": "Your-Unique-ID",
  "companiesHouseNumber": "11752182",
  "companyName": "Crezco LIMITED",
  "users": [
    {
      "email": "firstname.lastname@example.org",
      "firstName": "Kah Hoo",
      "lastName": "Ly",
      "role": "Admin"
    }
  ]
}

Response

OK

organisationIdstring uuid
<p> Unique ID of the organisation in Crezco. Set by Crezco. Ignored when sent as part of a Create or an Update </p>
partnerClientIdstring required
<p> Unique ID of the client in the partner system. This is the unique ID of the client that owns the organisation in your system. Each organisation must have a unique Partner Client Id. </p>
companiesHouseNumberstring
<p> Company Registration Number (CRN) of the UK company as registered with companies house. This is a unique code that Companies House uses to help it quickly and correctly identify a company. A CRN is assigned upon incorporation, which means that limited companies and LLPs (limited liability partnerships) must have one. </p> <p> Some other types of business do not require a CRN because they are not incorporated and are not required to file their statutory records with Companies House. Types of business not requiring a CRN include sole traders and general partnerships. </p> <p> CRNs are always 8 characters long. These can be either 8 digits or 2 letters followed by 6 digits. </p>
companyNamestring

Name of the company that this organisation represents

featuresstring[]

Collection of features that are enabled for this organisation

Example response

{
  "organisationId": "BC77508B-E3C8-4A03-8D96-3045B0DBD499",
  "partnerClientId": "Your-Unique-ID",
  "companiesHouseNumber": "11752182",
  "companyName": "Crezco LIMITED",
  "users": [
    {
      "email": "firstname.lastname@example.org",
      "firstName": "Kah Hoo",
      "lastName": "Ly",
      "role": "Admin"
    }
  ]
}