v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
CRM Companies

Push Institution to CRM

Push a NationGraph institution to CRM as a new company.

Available fields to push:

From Institution:

  • name → CRM name
  • state → CRM state
  • city → CRM city
  • street → CRM address
  • county → Appended to CRM description
  • population → CRM numberofemployees
  • label → CRM industry (mapped to valid enum, e.g., "K12 District" → "PRIMARY_SECONDARY_EDUCATION")

From Institution Metadata:

  • website → CRM website (from homepage_url)
  • description → CRM description (from entity_understanding)
  • latitude → Appended to CRM description (hs_latitude is read-only)
  • longitude → Appended to CRM description (hs_longitude is read-only)

Default fields (if not specified): name, state, city, street, website, description

Auto-mapping: By default, this will also create a CRM-institution mapping so you can reference this company in future operations. Set create_mapping: false to skip.

Owner assignment: Optionally assign the company to a CRM owner using owner_id. Get available owners via GET /crm/{integration_id}/owners.

Custom fields: Optionally write literal values to existing CRM custom fields on the new company using custom_fields (e.g. a "Source" field set to "Nationgraph"). Field names must match the CRM's API name (HubSpot property name or Salesforce field API name); fields that don't exist on the CRM org are silently skipped.

post/api/v3/crm/{integration_id}/institutions/{institution_id}/company

Path parameters

integration_idstring uuid required

The CRM integration ID

The CRM integration ID

institution_idstring required

The NationGraph institution unique_id

The NationGraph institution unique_id

Request body

fieldsInstitutionFieldSelection[] nullable

Fields to include. If not specified, defaults to: name, state, city, street, website, description

create_mappingboolean

Whether to automatically create a CRM-institution mapping after pushing

owner_idstring nullable

CRM owner ID to assign the company to (get available owners via /crm/{integration_id}/owners)

Response

Successful Response

company_idstring required

The created CRM company ID

institution_idstring required

The NationGraph institution ID

properties_pushedobject required

Properties that were sent to CRM

mapping_createdboolean required

Whether a CRM mapping was created