---
title: Assign a new form to an existing onboarding configuration
slug: detected-apis/assign-a-new-form-to-an-existing-onboarding-configuration
createdAt: 2025-09-16T11:18:22.139Z
---

## Overview

External systems may need to add specific items to an existing configuration, in this example it will be adding a new form to an existing profiles configuration.

The API flow is:

- Get all of the forms in Detected
- Update the onboarding configuration of a particular profile with a new form 

```mermaid
---
config:
  theme: redux-dark
  look: classic
---
sequenceDiagram
  participant ClientBackend as Clients App
  participant DetectedApis as Detected APIs
    Note over ClientBackend, DetectedApis: Authorisation
  ClientBackend ->> DetectedApis: POST /oauth/token
  DetectedApis -->> ClientBackend: Auth token
  Note over ClientBackend, DetectedApis: Get Available Forms
  ClientBackend ->> DetectedApis: GET /forms
    DetectedApis -->> ClientBackend: List of forms and references
  Note over ClientBackend, DetectedApis: Assign a form or forms to a profiles onboarding config
  ClientBackend ->> DetectedApis: PATCH /profile/{profile-id}/portal-configuration
DetectedApis -->> ClientBackend: 200 ok

```