API ReferenceTools

Upsert Contact Card

Create a new contact card or updates an existing one with full vCard data.

Headers

PINNACLE-API-KEYstringRequired

Request

This endpoint expects an object.
formattedNamestringRequired
Full display name for the vCard.
nameobjectRequired
Structured name components.
idintegerOptional
Unique identifier for the contact.
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.

idinteger or null
Contact's id
downloadUrlstring or null

Presigned download url to download vCard data.

This link will expire in one hour.

Errors