Organisations

Update an organisation

put/api/v2/partner/organisations/{id}

Request

Base URL: http://localhost:5100
URL: http://localhost:5100/api/v2/partner/organisations/{id}
Auth: API key in header Authorization

Path parameters

idinteger required

Organisation ID

Query parameters

subdomainstring

Optional subdomain to map to a portal provider

Request body

Example request

{
  "organisation": {
    "name": "Acme Ltd",
    "organisation_type": "NHS",
    "enabled": true,
    "partner_client_id": "partner-x-client-789",
    "terc_eap": "level_3",
    "terc_eap_code": "level_3",
    "login_url": "https://acme.example.com/login",
    "portal_url": "https://acme.example.com",
    "contract_start_date": "2025-01-01",
    "contract_end_date": "2025-12-31",
    "hire_agreement_signatory_contact_job_title": "HR Director",
    "hire_agreement_signatory_contact_name": "Jane Smith"
  }
}

Response

Organisation updated successfully

successboolean

Example response

{
  "success": true,
  "organisation": {
    "id": 123,
    "name": "Updated Org Name",
    "enabled": true,
    "staff_count": "100",
    "organisation_type": "NHS",
    "terc_eap": "level_3",
    "terc_eap_code": "EAP123",
    "partner_id": 10,
    "partner_client_id": "client-xyz",
    "login_url": "https://updated-login.example.com",
    "portal_url": "https://portal.example.com",
    "subdomain": "new-sub",
    "contract_start_date": "2024-01-01",
    "contract_end_date": "2025-01-01",
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2025-01-01T10:00:00Z"
  }
}

Changes

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