CiviCRMInstall

Summary

Create a new contact in CiviCRM with specified field values and optional contact type. Optionally set primary email, phone, and address with configurable location types. Supports per-execution runtime bearer token and per-item base URL override for multi-instance targeting.

Inputs

• Contact Type — Type of contact to create: Individual, Organization, or Household. Defaults to Individual.
• Email Location Type — Location category for the email address (Home, Work, Other). Defaults to Work.
• Mark Email as Primary — Whether the provided email is marked as primary. Defaults to true.
• Phone Location Type — Location category for the phone number (Home, Work, Mobile, Other). Defaults to Work.
• Mark Phone as Primary — Whether the provided phone number is marked as primary. Defaults to true.
• Address Location Type — Location category for the address (Home, Work, Billing, Other). Defaults to Home.
• Mark Address as Primary — Whether the provided address is marked as primary. Defaults to true.
• Fields (required) — A collection of field name/value pairs to set on the contact entity. Supports special keys like 'email', 'phone', 'address' and prefixed fields like 'email.work' to assign subfields.
• Runtime Bearer Token (Optional) — Optional JWT token for executing the request as a specific real user, bypassing the node's credentials and enforcing that user's permissions without fallback.
• Base URL Override — Optional URL string to override the credential's base URL, useful for targeting multiple CiviCRM instances with a single credential.

Output shape

a single record representing the newly created contact including its fields, primary email, phone, and address.

Returns the full contact record retrieved after creation, including chained retrieval of emails, phones, and addresses. Throws an error if creation fails. Uses provided runtime bearer token if set; otherwise uses credential authentication with possible JWT auto-resolution.

Examples

Example 1: Create an Individual contact with primary work email and phone

Set Contact Type to Individual, set 'email' and 'phone' fields in Fields collection, set Email and Phone Location Type to Work (default), and primary flags true (default). Leave runtime bearer token and base URL override empty if not needed.

Links

• n8n community nodes installation guide