---
title: "Update a contact"
method: PATCH
path: "/api/v1/contacts/{id}"
tags: ["Contacts"]
---

# Update a contact

`PATCH /api/v1/contacts/{id}`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/contacts/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `contacts:write`)

Partial update. Omitted fields are left alone.

`email` is NOT writable: an address is the contact's identity on this API, and rewriting it in place would silently change what every earlier send was addressed to. Create the new address instead.

`custom_fields` REPLACES the stored object rather than merging into it, so a key you omit is gone. Read the contact first if you mean to change one key and keep the rest.

Requires the `contacts:write` scope — Create, update, and delete your contacts.

## Path parameters

- `id` string, uuid, required: Resource id.

## Request body

- ContactV1Update: Body for PATCH /api/v1/contacts/{id}. `email` is deliberately absent: an address is the contact's identity on this API, and changing it in place would silently rewrite what every earlier send was addressed to. Create the new address instead.
  - `custom_fields` union: Arbitrary JSON value (string, number, boolean, null, array, or object).
    - string
    - number
    - boolean
    - object
  - `subscribed` boolean

## Response `200`

The updated contact

- ContactV1: A contact as exposed on the v1 API.
  - `created_at` string, date-time, required
  - `custom_fields` union, required: Arbitrary JSON value (string, number, boolean, null, array, or object).
    - string
    - number
    - boolean
    - object
  - `email` string, required
  - `id` string, uuid, required
  - `subscribed` boolean, required
  - `updated_at` string, date-time, required

## Other responses

- `401`: `invalid_api_key` or `invalid_session` — missing or invalid credentials.
- `403`: `scope_missing`, `project_access_denied`, or `project_disabled`.
- `404`: `resource_not_found` — no contact with this id belongs to the authenticated project.
- `422`: `validation_error` — query, path, or body parameters did not match the schema.
- `429`: `rate_limited` — see `Retry-After` and the `RateLimit` headers.
- `500`: `internal_error`.

---

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