---
title: "PATCH /v1/contactBooks/{contactBookId}"
method: PATCH
path: "/v1/contactBooks/{contactBookId}"
---

# PATCH /v1/contactBooks/{contactBookId}

`PATCH /v1/contactBooks/{contactBookId}`

## Path parameters

- `contactBookId` string, required

## Request body

- object
  - `name` string
  - `emoji` string
  - `properties` object
  - `doubleOptInEnabled` boolean
  - `doubleOptInFrom` string, nullable
  - `doubleOptInSubject` string
  - `doubleOptInContent` string
  - `variables` string[]

## Response `200`

Update the contact book

- object
  - `id` string, required — The ID of the contact book
  - `name` string, required — The name of the contact book
  - `teamId` number, required — The ID of the team
  - `properties` object, required — Custom properties for the contact book
  - `variables` string[], required — Allowed personalization variables for contacts in this book
  - `emoji` string, required — The emoji associated with the contact book
  - `doubleOptInEnabled` boolean — Whether double opt-in is enabled for new contacts
  - `doubleOptInFrom` string, nullable — From address used for double opt-in emails (must use a verified domain)
  - `doubleOptInSubject` string, nullable — Subject line used for double opt-in confirmation email
  - `doubleOptInContent` string, nullable — Email editor JSON content used for double opt-in confirmation
  - `createdAt` string, required — The creation timestamp
  - `updatedAt` string, required — The last update timestamp
  - `_count` object
    - `contacts` number, required — The number of contacts in the contact book

## Other responses

- `403` — Forbidden - API key doesn't have access to this contact book
- `404` — Contact book not found

---

[API](https://skmtc.net/usesend/apis/usesend-api.md) · [All operations](https://skmtc.net/usesend/apis/usesend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usesend/usesend-api/versions/ee7832fe66a6/schema)