AvantGuard - Pax8 - Partner icon

AvantGuard - Pax8 - Partner

AvantGuard - Pax8

Actions28

Overview

This node operation updates an existing contact within a specified company by sending a PUT request to the API. It is useful for scenarios where you need to modify contact details such as name, email, phone number, or other optional fields in a CRM or contact management system integrated via this API.

Practical examples include:

  • Updating a contact’s phone number after they change it.
  • Correcting or adding missing information like email or last name.
  • Adding additional metadata fields to a contact record during update.

Properties

Name Meaning
Company Id The unique identifier of the company to which the contact belongs.
Contact Id The unique identifier of the contact to be updated.
First Name The contact's first name.
Last Name The contact's last name.
Email The contact's email address.
Phone The contact's phone number.
Additional Body Fields Optional additional fields to include in the update request body:
- Id: An additional id field (string).
- Created Date: The date the contact was created (string, e.g., "2020-05-12").
- Types: A JSON array representing types associated with the contact.

Output

The node outputs JSON data representing the updated contact object returned from the API after the PUT update operation. This typically includes all the contact fields reflecting the new state post-update.

If the API supports binary data output for contacts (e.g., profile pictures), it would be included accordingly, but based on the provided code and properties, the primary output is JSON.

Dependencies

  • Requires an API key credential for authentication with the external Pax8 Partner API service.
  • The base URL for requests is https://api.pax8.com/v1.
  • The node uses standard HTTP headers for JSON content (Accept and Content-Type set to application/json).

Troubleshooting

  • Missing Required Fields: Errors may occur if required fields like Company Id, Contact Id, First Name, Last Name, Email, or Phone are not provided. Ensure all mandatory inputs are filled.
  • Invalid IDs: Providing incorrect or non-existent Company Id or Contact Id will likely result in a "not found" or similar error from the API.
  • Malformed JSON in Types Field: The Types field expects valid JSON; invalid JSON syntax will cause parsing errors.
  • Authentication Failures: If the API key credential is missing or invalid, the node will fail to authenticate with the API.
  • API Rate Limits or Downtime: Network issues or API rate limiting can cause request failures; check API status and retry policies.

Links and References

Discussion