Create New Contact API Reference

Serverhttps://api.pinnacle.sh/

Create a new contact for a given phone number.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

Request payload for creating a new contact record.

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"

phoneNumberstring

Phone number to save for your contact, in E.164 format.

Example

"+14155550142"

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.create({
    phoneNumber: "phoneNumber"
});

Responses

{  "id": "co_1234567890"}

Create New Contact

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

Create New Contact

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`