# Amend the given organisations details

**PUT /organisations/{OrganisationId}**




## Servers
- Raidiam Directory Sandbox Environment: https://matls-api.sandbox.raidiam.io (Raidiam Directory Sandbox Environment)


## Authentication methods
- O auth


## Parameters
### Headers
- **x-fapi-auth-date** (string)
  The time when the PSU last logged in with the TPP. 
  All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
  Sun, 10 Sep 2017 19:43:31 UTC
- **x-fapi-customer-ip-address** (string)
  The PSU's IP address if the PSU is currently logged in with the TPP.
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.
- **x-customer-user-agent** (string)
  Indicates the user-agent that the PSU is using.

### Path parameters
- **OrganisationId** (string)
  The organisation ID


### Body: application/json (object)

- **AddressLine1** (string)
  Address line 1
- **AddressLine2** (string)
  Address line 2
- **City** (string)
  City
- **CompanyRegister** (string)
  Legal company register for the country, i.e. Companies House
- **Country** (string)
  Country
- **CountryOfRegistration** (string)
  Country of registration for the org
- **EnforceIdpUserManagement** (boolean)
  When true, prevents the creation of users directly on the organisation and mandates all users are managed by SSO Configured IDPs
- **Flags** (array[string])
  Unique ID of the flag
- **LegalEntityName** (string)
  Legal Entity name for the org. Usually the same as org name
- **LogoUri** (string(uri))
  A compliant URI
- **OrganisationName** (string)
  Name of the organisation.
- **ParentOrganisationReference** (string)
  Parent Organisation Reference
- **Postcode** (string)
  Postcode
- **RegisteredName** (string)
  Registered legal name
- **RegistrationId** (string)
  Registered ID for the organisation i.e. Legal Entity identifier number
- **RegistrationNumber** (string)
  Company registration number from company register i.e. Companies House registration number
- **RequiresParticipantTermsAndConditionsSigning** (boolean)
  Participant Terms and Conditions Signing Required
- **Size** (string)
  Size of the organisation
- **Status** (string)
  Status of the directory registration of an organisation
- **TaxRegistrationNumber** (string)
  Company tax registration number


## Responses
### 200
Full details of the organisation including warnings on a create or update operation

#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **OperationWarnings** (array[string])
  A warning code that describes a warning condition that occurred during the last operation
- **AddressLine1** (string)
  Address line 1
- **AddressLine2** (string)
  Address line 2
- **Authority** (boolean)
  Indicates if the subject organisation has been configured as an Authority
- **City** (string)
  City
- **CompanyRegister** (string)
  Legal company register for the country, i.e. Companies House
- **Country** (string)
  Country
- **CountryOfRegistration** (string)
  Country of registration for the org
- **CreatedOn** (string)
  JSONDatetime of organisation creation.
- **EnforceIdpUserManagement** (boolean)
  When true, prevents the creation of users directly on the organisation and mandates all users are managed by SSO Configured IDPs
- **Flags** (array[object])

- **LegalEntityName** (string)
  Legal Entity name for the org. Usually the same as org name
- **LogoUri** (string(uri))
  A compliant URI
- **OrganisationId** (string)
  Unique ID associated with the organisation
- **OrganisationName** (string)
  Name of the organisation.
- **ParentOrganisationReference** (string)
  Parent Organisation Reference
- **Postcode** (string)
  Postcode
- **RegisteredName** (string)

- **RegistrationId** (string)
  Registered ID for the organisation i.e. Legal Entity identifier number
- **RegistrationNumber** (string)
  Company registration number from company register i.e. Companies House registration number
- **RequiresParticipantTermsAndConditionsSigning** (boolean)
  true - this organisation requires terms and conditions to be signed. false - this organisation does not require terms and conditions to be signed
- **Size** (string)
  Size of the organisation
- **Status** (string)
  Status of the directory registration of an organisation
- **TaxRegistrationNumber** (string)
  Company tax registration number

### 400
Bad Request
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 401
Unauthorized
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 403
Forbidden
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 404
Not found
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

#### Body: application/json (object)
- **errors** (array[string])
  Validation Error messages

### 406
Not Acceptable
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 429
Too many requests, maximum capacity reached. Requests are now throttled.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 500
Internal Server Error
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 502
Bad Gateway
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.

### 504
Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
#### Headers
- **x-fapi-interaction-id** (string)
  An RFC4122 UID used as a correlation id.


[Powered by Bump.sh](https://bump.sh)