Update Contact

This endpoint allows you to update the information of an existing contact in your organization’s database. You only need to include the fields you want to modify - any fields not included in the request will remain unchanged.

​

Use Cases

• Update a contact’s phone number, email, or other contact information
• Add or modify additional data fields for a contact
• Enrich contact records with new information from external sources
• Update contact status or notes after interaction

​

Path Parameters

​

Headers

​

Body Parameters

​

Response

​

Error Codes

• 400 Bad Request - Invalid input data format
• 401 Unauthorized - Invalid or missing API key
• 404 Not Found - Contact not found
• 409 Conflict - The update would create a duplicate phone number
• 500 Internal Server Error - Server-side error

​

Code Examples

# Update a contact's name and description
curl -X PATCH "https://api.contactship.ai/v1/contacts/c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6" \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Juan Carlos Pérez",
    "description": "Lead converted to customer"
  }'

{
  "id": "c1a2b3c4-d5e6-f7g8-h9i0-j1k2l3m4n5o6",
  "created_at": "2023-01-01T12:00:00Z",
  "phone_number": "+12125678901",
  "full_name": "Juan Carlos Pérez",
  "country": "México",
  "email": "juan.perez@ejemplo.com",
  "description": "Lead converted to customer",
  "additional_data": [
    {
      "type": "location",
      "field": "dirección",
      "value": "Av. Reforma 456"
    },
    {
      "type": "text",
      "field": "notas",
      "value": "Cliente activo con suscripción premium"
    },
    {
      "type": "date",
      "field": "fecha_conversión",
      "value": "2023-03-15"
    }
  ],
  "organization_id": "org123456"
}

​

Notes and Best Practices

• Only include the fields you want to update in the request body
• Be careful when updating the additional_data array, as it will replace the entire array rather than merge with existing values
• If you’re updating a phone number, ensure it doesn’t conflict with another contact’s phone number
• Consider implementing validation checks before submitting updates
• Keep track of contact update history in your application if needed for compliance or audit purposes