---
title: "Add shared profile"
method: POST
path: "/api/ab/shared/add"
tags: ["address book"]
---

# Add shared profile

`POST /api/ab/shared/add`

This function is an API endpoint that adds a shared profile to an address book. It is tagged with "address book" for OpenAPI documentation.

## Parameters

- `request`: A JSON object containing the shared profile to be added.

## Returns

If successful, this function returns a `Json<AbSharedProfilesResponse>` object containing the shared profiles in the address book.  <br>

## Request body

- AbSharedAddRequest
  - `name` string, required
  - `note` string, nullable

## Response `200`

- AbSharedProfilesResponse
  - `error` string, nullable
  - `total` integer, required
  - `data` AbProfile[], required
    - `guid` string, required
    - `name` string, required
    - `owner` string, required
    - `note` string, nullable
    - `rule` integer, required

## Other responses

- `401`

## Changes

- **2024-05-31** `12b1b72bc3f3` — 1 info
  - endpoint added
- **2024-05-19** `fafd43b82c78` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/nesaku/apis/sctgdesk-api-server/changes/api/ab/shared/add/post.md)

---

[API](https://skmtc.dev/nesaku/apis/sctgdesk-api-server.md) · [All operations](https://skmtc.dev/nesaku/apis/sctgdesk-api-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nesaku/sctgdesk-api-server/revisions/b1c0e7a4434f/schema)