v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB

CRM Automation Push

Create Custom Object Schema

Create a custom object schema in the user's CRM workspace.

The schema_key determines which NationGraph schema to create. Currently supported schemas:

vendor_contract: Creates a NationGraph Vendor Contract custom object with fields for vendor, product, ACV, dates, summary, institution, and a link back to NationGraph. Associated with CRM companies/accounts.

HubSpot: Creates a custom object schema with all properties and company associations via the schemas API.

Salesforce: Creates a custom object via the Tooling API, then adds each custom field individually, including an Account lookup.

This endpoint is idempotent-safe — call the check endpoint first to verify the schema doesn't already exist.

post/api/v3/crm/{integration_id}/custom-object-schemas/{schema_key}

Path parameters

integration_idstring uuid required

The CRM integration ID

schema_keystring required

Schema identifier (e.g. 'vendor_contract')

Request body

account_layout_namestring nullable

Account page layout API name to add the related list to. Use the account-layouts endpoint to discover available layouts. If omitted, the related list is not added to any layout.

Response

Successful Response

schema_keystring required

The schema key that was created

providerstring required

CRM provider (hubspot or salesforce)

object_type_idstring required

Provider-specific object type identifier

fields_createdinteger required

Number of fields created