Update Contact API Reference

Serverhttps://api.pinnacle.sh/

Update an existing contact.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

This endpoint expects and object.

Only the fields provided in the request will be updated, while all other existing contact data remains unchanged.

TypeScript Definitions

Use the request body type in TypeScript.

descriptionstringOptional

New notes or details for your contact.

Example

"Primary messaging workflow"

emailstringOptional

New email address for your contact.

Example

"avery@example.com"

namestringOptional

New name for your contact.

Example

"Acme Support"

tagsarray<string>Optional

New tags for your contact.

Each item

Example

"vip"

idstring

ID of the contact you want to update. This identifier is a string that always begins with the prefix co_, for example: co_1234567890.

Example

"contact_01J8K3R7M9"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.contacts.update({
    description: "Retired",
    email: "alvaroopedtech@pinnacle.sh",
    name: "Retired Bestie",
    tags: ["friend"],
    id: "co_1234567890"
});

Responses

{  "id": "co_1234567890"}

Update Contact

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Update Contact

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`