Actions62
- Agent Actions
- Agent Version Actions
- Board Actions
- Call Actions
- Channel Actions
- Contact Actions
- Conversation Actions
- Credit Actions
- Event Actions
- Phone Number Actions
- Tag Actions
- Task Actions
- Voice Actions
- WhatsApp Actions
Contact → Create or Update
AI-generatedSummary
Create a new contact or update an existing one by searching for the contact using the provided phone number in international format. If a contact with that phone number exists, its details are updated; otherwise, a new contact is created.
Inputs
- Phone Number (required) — The phone number in international format which identifies the contact to create or update.
- Full Name (required) — The full name of the contact to set or update.
- Country (required) — The country of the contact.
- Email — Optional email address of the contact.
- Custom Properties — Optional free-form custom properties to store on the contact. Each property must include a field name, type (Text, Number, URL, Location, Calendar (Date)), and value.
- Contact Properties — Optional values for predefined contact properties defined in your organization within ContactShip.
Output shape
a single contact record representing the newly created contact or the updated existing contact.
The operation internally uses the phone number to determine whether to create a new contact or update an existing one. All required fields must be provided. Optional fields and properties are merged into the contact record. Errors are returned if required inputs are missing or the operation fails.
Examples
Example 1: Create a new contact with phone number, full name, country, and email
Set Phone Number to '+12125551234', Full Name to 'Nathan Smith', Country to 'Mexico', and optionally Email to 'nathan@example.com'.
Example 2: Update an existing contact's custom properties by phone number
Provide the phone number identifying the contact, fill Full Name and Country (required), and add Custom Properties such as address or calendar date to update those fields on the contact.