# Update a contact (/docs/api-reference/contacts/update-contact)

Changes the fields given; `properties` are merged (`null` removes one).

`PATCH https://api.coss.com/v1/contacts/{id}`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Path parameters

- `id` (string, required): The contact's id, or its address (URL-encoded).

## Request body

- `first_name` (string | null, 1-256 characters): Their first name. `null` removes it.
- `last_name` (string | null, 1-256 characters): Their last name. `null` removes it.
- `properties` (map of string | number | boolean | null): Custom properties by key (define them first, see contact properties). Merged into the contact's existing properties; `null` removes one.
- `status` ("subscribed" | "unsubscribed"): Sets the contact's consent. Omitted, a new contact is `subscribed` and an existing one keeps its status.
- `topics` (object[], at most 100 items)
  - `topic` (string, required): The topic's key.
  - `status` ("opted_in" | "opted_out", required): `opted_in` or `opted_out` of the topic.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.email.contacts.update("contact_01k7c8m4q2f3e9v6t5r1n0p8yz", {
  last_name: "Byron",
  properties: {
    seats: null,
  },
});
```

HTTP:

```sh
curl -X PATCH "https://api.coss.com/v1/contacts/contact_01k7c8m4q2f3e9v6t5r1n0p8yz" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "last_name": "Byron",
  "properties": {
    "seats": null
  }
}'
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.email.contacts.update(
    id="contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
    last_name="Byron",
    properties={
        "seats": None
    },
)
```

Go:

```go
import (
	"context"

	coss "github.com/cosscom/coss-go"
	cossclient "github.com/cosscom/coss-go/client"
	email "github.com/cosscom/coss-go/email"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &email.UpdateContactRequest{
    ID: "contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
    LastName: coss.String(
        "Byron",
    ),
    Properties: map[string]*email.UpdateContactRequestPropertiesValue{},
}
client.Email.Contacts.Update(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.email.contacts.update(
  id: "contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
  last_name: "Byron",
  properties: {
    seats: nil
  }
)
```

PHP:

```php
<?php

use Coss\Coss;
use Coss\Email\Contacts\Requests\UpdateContactRequest;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->email->contacts->update(
    'contact_01k7c8m4q2f3e9v6t5r1n0p8yz',
    new UpdateContactRequest([
        'lastName' => 'Byron',
        'properties' => [
            'seats' => null,
        ],
    ]),
);
```

Java:

```java
import com.coss.Coss;
import com.coss.resources.email.contacts.requests.UpdateContactRequest;
import com.coss.resources.email.contacts.types.UpdateContactRequestPropertiesValue;
import java.util.HashMap;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.email().contacts().update(
    "contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
    UpdateContactRequest
        .builder()
        .lastName(
            OptionalNullable.of("Byron")
        )
        .properties(
            new HashMap<String, OptionalNullable<UpdateContactRequestPropertiesValue>>() {{
                put("seats", Nullable.ofNull());
            }}
        )
        .build()
);
```

.NET:

```csharp
using Coss;
using Coss.Email;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.Email.Contacts.UpdateAsync(
    new UpdateContactRequest
    {
        Id = "contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
        LastName = "Byron",
        Properties = new Dictionary<string, OneOf<string, double, bool>?>() { { "seats", null } },
    }
);
```

## Response 200

The contact.

- `object` ("contact", required)
- `id` (string, required)
- `email` (string, required): The contact's address. Unique in the environment, case-insensitively.
- `first_name` (string | null, required): Their first name. `null`: not set.
- `last_name` (string | null, required): Their last name. `null`: not set.
- `status` ("subscribed" | "unsubscribed" | "pending", required): Consent to marketing email: `subscribed`, `unsubscribed` (never receives marketing email; transactional email is unaffected) or `pending` (waiting for a double opt-in confirmation).
- `properties` (map of string | number | boolean, required): Custom properties by key.
- `source` ("api" | "dashboard" | "import" | "preference_center" | "form", required): How the contact was created.
- `subscribed_at` (string | null, required, date-time): When it last became `subscribed`. `null`: it hasn't.
- `unsubscribed_at` (string | null, required, date-time): When it became `unsubscribed`. `null` unless it is.
- `confirmed_at` (string | null, required, date-time): When the contact confirmed a double opt-in.
- `created_at` (string, required, date-time)
- `updated_at` (string, required, date-time)

Example:

```json
{
  "object": "contact",
  "id": "contact_01k7c8m4q2f3e9v6t5r1n0p8yz",
  "email": "ada@example.com",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "status": "subscribed",
  "properties": {
    "plan": "pro",
    "seats": 5
  },
  "source": "api",
  "subscribed_at": "2026-10-10T12:00:00.000Z",
  "unsubscribed_at": null,
  "confirmed_at": null,
  "created_at": "2026-10-10T12:00:00.000Z",
  "updated_at": "2026-10-10T12:00:00.000Z"
}
```

## Errors

- `400`: The body is not valid JSON (`invalid_json`). Also when the `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `404`: No contact with this id or address exists in the API key's environment (`not_found`).
- `413`: The request body is larger than 5 MB (`payload_too_large`).
- `415`: The body is not sent as `application/json` (`unsupported_media_type`).
- `422`: The body failed validation (`validation_error`), names an unknown property or topic, or a value of the wrong type.
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).