tools > contactCard

Upsert Contact Card

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.

post/tools/contact-card/upsert

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/tools/contact-card/upsert
  • Auth: API key in header PINNACLE-API-KEY

Request body

idstring

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

formattedNamestring required

Full display name for the vCard.

nicknamestring[]

Nicknames or aliases.

birthdaystring nullable

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

urlstring nullable

Website URL.

timezonestring nullable

Timezone (e.g., "America/New_York").

titlestring nullable

Job title or position.

rolestring nullable

Role or function within the organization.

categoriesstring[]

Categories or tags for organizing contacts.

notestring nullable

Additional notes or comments.

photostring nullable

Contact's photo

Response

Successfully created/updated contact card.

idstring

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

downloadUrlstring

Presigned download url to download vCard data. <br>

This link will expire in one hour.

Changes

No recorded changes to this operation across all 1 revision of this API.