Upsert Contact Card | Pinnacle

1 import { PinnacleClient } from "rcs-js"; 2 3 async function main() { 4 const client = new PinnacleClient({ 5 environment: "https://api.pinnacle.sh", 6 }); 7 await client.tools.contactCard.upsert({ 8 formattedName: "Jane Smith", 9 name: { 10 familyName: "Smith", 11 givenName: "Jane", 12 additionalNames: [ 13 "A.", 14 ], 15 honorificPrefixes: [ 16 "Dr.", 17 ], 18 honorificSuffixes: [ 19 "PhD", 20 ], 21 }, 22 id: "cc_1234567890", 23 nickname: [ 24 "Janie", 25 ], 26 birthday: "1990-02-15", 27 addresses: [ 28 { 29 countryName: "USA", 30 extendedAddress: "Apt. 4B", 31 locality: "Anytown", 32 postalCode: "90210", 33 postOfficeBox: "PO Box 123", 34 region: "CA", 35 streetAddress: "123 Main St", 36 type: [ 37 "HOME", 38 "PREF", 39 ], 40 }, 41 ], 42 url: "https://app.pinnacle.sh", 43 phones: [ 44 { 45 type: [ 46 "CELL", 47 ], 48 value: "+15551234567", 49 }, 50 ], 51 emails: [ 52 { 53 type: [ 54 "INTERNET", 55 ], 56 value: "jane.smith@example.com", 57 }, 58 ], 59 timezone: "America/Los_Angeles", 60 geo: { 61 latitude: 34.0522, 62 longitude: -118.2437, 63 }, 64 title: "Engineer", 65 role: "Developer", 66 organization: { 67 name: "Acme Co", 68 units: [ 69 "Engineering", 70 "R&D", 71 ], 72 }, 73 categories: [ 74 "Friend", 75 "Colleague", 76 ], 77 note: "Test contact entry", 78 photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ", 79 }); 80 } 81 main();

1 { 2 "id": "cc_1234567890", 3 "downloadUrl": "https://files.short.ly/vcard/def456.vcf" 4 }

Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent via MMS as a media file.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

formattedNamestringRequired

Full display name for the vCard.

nameobjectRequired

Structured name components.

idstringOptional

The unique identifier of the contact. This identifier is a string that always begins with the prefix cc_, for example: cc_1234567890.

nicknamelist of stringsOptional

Nicknames or aliases.

birthdaystring or nullOptional

Birthday in ISO 8601 date format (YYYY-MM-DD).

addresseslist of objectsOptional

Physical addresses.

urlstring or nullOptional

Website URL.

phoneslist of objectsOptional

Phone numbers.

emailslist of objectsOptional

Email addresses.

timezonestring or nullOptional

Timezone (e.g., “America/New_York”).

geoobject or nullOptional

Geographic coordinates.

titlestring or nullOptional

Job title or position.

rolestring or nullOptional

Role or function within the organization.

organizationobjectOptional

Organization or company information.

categorieslist of stringsOptional

Categories or tags for organizing contacts.

notestring or nullOptional

Additional notes or comments.

photostring or nullOptional

Contact's photo

Response

Successfully created/updated contact card.

idstring or null

The unique identifier of the contact. This identifier is a string that always begins with the prefix cc_, for example: cc_1234567890.

downloadUrlstring or null

Presigned download url to download vCard data.

This link will expire in one hour.

Authentication

Request

Response

Errors