---
title: "Sync phone book"
method: POST
path: "/v1/phone-book"
tags: ["Owner"]
---

# Sync phone book

`POST /v1/phone-book`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/phone-book`
- Auth: HTTP bearer

## Request body

- SyncPhoneBookRequest
  - `source` 'phone' | 'file', required
  - `device` string
  - `mode` 'full' | 'patch', required
  - `run` string
  - `final` boolean
  - `auto` boolean
  - `upserts` object[], required
    - `e164` string, required
    - `name` string, required
  - `removes` E164[]

## Response `200`

OK

- SyncPhoneBookResponse
  - `total` integer, required
  - `added` integer, required
  - `updated` integer, required
  - `removed` integer, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `413`: Body over the limit (64 KB; 512 KB for contact import).
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)