# Adopt a shared record onto this page

Adopt lenders from the platform catalogue onto the workspace's Lenders board: each catalogue id becomes a directory row carrying the name, address, programs, states and amount range, linked so a retirement shows on it. Idempotent per entry. Admin only.

Access class: `def:read`.

## Endpoint

`POST /v1/definitions/{key}/rows/adopt`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| key | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "body": {
    "systemLenderIds": [
      1
    ]
  },
  "params": {
    ":key": "string"
  },
  "query": {}
}
```

## Responses

### 201

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "adopted": 1,
    "already": 1,
    "failed": 1,
    "requested": 1,
    "results": [
      {
        "error": "string",
        "lenderRowId": "",
        "name": "string",
        "outcome": "string",
        "systemLenderId": ""
      }
    ]
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```