This API retrieves comprehensive field headers and descriptions for CRM contact and entity management. It returns both standard fields and custom fields configured for your brand, helping you understand the exact field names and data types required for CRM operations.

💡 Pro Tip

Use this API before creating or updating contacts to ensure you're using the correct field names and data types. The response includes both standard contact fields and custom fields specific to your brand configuration.

Request Endpoint: https://app.zyntrohq.com/apis/public/fetchCRMFieldHeaders.php

Request Method: POST

Request Payload:

{
  "api_key": "your_zyntro_api_key",
  "org_id": "your_organization_id",
  "brand_id": "your_brand_id"
}

Response (JSON):

{
  "status": "success",
  "data": {
    "headers": [
      [
        "cont_role_label",
        "Contact Role (String)"
      ],
      [
        "cont_salutation",
        "Salutation (String Mr|Mrs|Ms|Dr|Prof|Etc.)"
      ],
      [
        "cont_name",
        "Full Name (String)"
      ],
      [
        "cont_fname",
        "First Name (String)"
      ],
      [
        "cont_lname",
        "Last Name (String)"
      ],
      [
        "cont_primary_email",
        "Email (String, Required)"
      ],
      [
        "cont_secondary_email",
        "Secondary Email (String)"
      ],
      [
        "cont_primary_phone",
        "Phone (String)"
      ],
      [
        "cont_secondary_phone",
        "Secondary Phone (String)"
      ],
      [
        "cont_address_combined",
        "Address as combined field"
      ],
      [
        "cont_address",
        "Address (String)"
      ],
      [
        "cont_address_line2",
        "Address Line 2 (String)"
      ],
      [
        "cont_city",
        "City (String)"
      ],
      [
        "cont_state",
        "State (String)"
      ],
      [
        "cont_zip",
        "Zip/Postal Code (String)"
      ],
      [
        "cont_country",
        "Country (String), e.g. United States"
      ],
      [
        "cont_country_code",
        "Country Code, Optional, ISO 2 Country Code, e.g. US"
      ],
      [
        "cont_timezone",
        "Timezone (String, Optional, IANA Timezone, e.g. America/New_York)"
      ],
      [
        "cont_source",
        "Acquisition Source (String)"
      ],
      [
        "cont_enrich",
        "Enrich Contact (Boolean)"
      ],
      [
        "cont_enriched",
        "Contact Enriched (0 or 1)"
      ],
      [
        "ent_name",
        "Entity Name (String)"
      ],
      [
        "ent_type",
        "Entity Type (String)"
      ],
      [
        "ent_label",
        "Entity Label (String)"
      ],
      [
        "ent_location",
        "Entity Location (String)"
      ],
      [
        "ent_website",
        "Entity Website (String)"
      ],
      [
        "ent_tags",
        "Entity Tags (String)"
      ],
      [
        "ent_socials",
        "Entity Socials (String, Follow pattern Platform|URL,Platform2|URL2)"
      ],
      [
        "custom_field_tag",
        "Custom Field Description"
      ]
    ]
  }
}

Response Fields:

  • status: Indicates success or error status
  • data: Object containing field headers
  • headers: Array of field definitions, where each element is an array containing [field_name, field_description]

Standard Contact Fields:

  • cont_role_label: Contact Role (String)
  • cont_salutation: Salutation (String Mr|Mrs|Ms|Dr|Prof|Etc.)
  • cont_name: Full Name (String)
  • cont_fname: First Name (String)
  • cont_lname: Last Name (String)
  • cont_primary_email: Email (String, Required)
  • cont_secondary_email: Secondary Email (String)
  • cont_primary_phone: Phone (String)
  • cont_secondary_phone: Secondary Phone (String)
  • cont_address_combined: Address as combined field
  • cont_address: Address (String)
  • cont_address_line2: Address Line 2 (String)
  • cont_city: City (String)
  • cont_state: State (String)
  • cont_zip: Zip/Postal Code (String)
  • cont_country: Country (String), e.g. United States
  • cont_country_code: Country Code, Optional, ISO 2 Country Code, e.g. US
  • cont_timezone: Timezone (String, Optional, IANA Timezone, e.g. America/New_York)
  • cont_source: Acquisition Source (String)
  • cont_enrich: Enrich Contact (Boolean)
  • cont_enriched: Contact Enriched (0 or 1)

Standard Entity Fields (B2B Mode Only):

  • ent_name: Entity Name (String)
  • ent_type: Entity Type (String)
  • ent_label: Entity Label (String)
  • ent_location: Entity Location (String)
  • ent_website: Entity Website (String)
  • ent_tags: Entity Tags (String)
  • ent_socials: Entity Socials (String, Follow pattern Platform|URL,Platform2|URL2)

Custom Fields:

  • Custom fields are dynamically added based on your brand configuration
  • Each custom field includes a field tag and description
  • Custom fields can be associated with either contacts or entities

Notes:

  • This is a public API and requires an API Key. You can get your API Key from inside your Zyntro Account under Me > API Keys
  • Ensure that the api_key, org_id, and brand_id are valid and correspond to your Zyntro account credentials
  • The org_id should correspond to an existing organization within your account
  • The brand_id should correspond to an existing brand within your organization
  • Organization must be active for API calls to be processed successfully
  • Entity fields are only included if CRM mode is not set to 'b2c'
  • Custom fields are retrieved from the database based on brand and organization configuration
  • Field descriptions include data types and validation requirements
  • Use these field names exactly as provided when creating or updating CRM records