NationGraph CRM Automation Push API

The CRM Automation Push API from NationGraph — 12 operation(s) for crm automation push.

Documentation Provider Profile APIs.io OpenAPI GitHub

NationGraph CRM Automation Push API is one of 56 APIs that NationGraph publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM Automation Push. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 13 operations across 12 paths, and defines 36 schemas. It is described by OpenAPI 3.1.0, at version 0.2.36.

Requests are made against the base URL https://api.nationgraph.com.

13 operations 12 paths 36 schemas 7 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

0.2.36

Base URL

https://api.nationgraph.com

Authentication

HTTP Bearer

Resource Areas

Authentication & Security 1

NationGraph CRM Automation Push API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 13

Across 12 paths, the API surfaces 13 operations — 7 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

CRM Automation Push 13

GET

/api/v3/crm/{integration_id}/company-fields

List CRM Company Fields

list_crm_company_fields_api_v3_crm__integration_id__company_fields_get 1 param → 200422

GET

/api/v3/crm/{integration_id}/automations/{automation_id}/pushable-columns

Get Pushable Columns

get_automation_pushable_columns_api_v3_crm__integration_id__automations__automation_id__pushable_columns_get 2 params → 200422

GET

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/push-status

Get Push Status

get_push_status_api_v3_crm__integration_id__automations__automation_id__runs__run_id__push_status_get 3 params → 200422

GET

/api/v3/crm/{integration_id}/automations/{automation_id}/history

Get CRM Push History for an Automation

get_automation_push_history_api_v3_crm__integration_id__automations__automation_id__history_get 4 params → 200422

POST

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/push

Push Automation Results to CRM

push_automation_results_to_crm_api_v3_crm__integration_id__automations__automation_id__runs__run_id__push_post 3 params body → 200422

POST

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/results/{result_id}/push-activity

Push Automation Result as CRM Activity

push_automation_result_as_activity_api_v3_crm__integration_id__automations__automation_id__runs__run_id__results__result_id__push_activity_post 4 params body → 200422

POST

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/push-signals

Push Automation Run Signals to CRM

push_automation_run_signals_api_v3_crm__integration_id__automations__automation_id__runs__run_id__push_signals_post 3 params body → 200422

GET

/api/v3/crm/{integration_id}/account-layouts

List Account Page Layouts

list_account_layouts_api_v3_crm__integration_id__account_layouts_get 1 param → 200422

GET

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

Check Custom Object Schema

check_custom_object_schema_api_v3_crm__integration_id__custom_object_schemas__schema_key__get 2 params → 200422

POST

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

Create Custom Object Schema

create_custom_object_schema_api_v3_crm__integration_id__custom_object_schemas__schema_key__post 2 params body → 201422

GET

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

Get Custom Object Schema Spec

get_custom_object_schema_spec_api_v3_crm__integration_id__custom_object_schemas__schema_key__spec_get 2 params → 200422

POST

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/push-custom-objects

Push Automation Results as Custom Objects

push_automation_results_as_custom_objects_api_v3_crm__integration_id__automations__automation_id__runs__run_id__push_custom_objects_post 3 params body → 200422

POST

/api/v3/crm/{integration_id}/automations/{automation_id}/runs/{run_id}/push-contacts

Push Contacts as CRM Contact Records

push_run_contacts_api_v3_crm__integration_id__automations__automation_id__runs__run_id__push_contacts_post 3 params body → 200422

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are AutomationResultFilters (17 properties), PushSignalsResponse (8 properties), PushContactItem (8 properties), AutomationActivityPushRequest (7 properties). Each schema is shown below with its type and property counts.

ValidationError

object

5 properties 3 required

PushStatusResponse

object

Push status for a run+integration pair.

4 properties 3 required

CustomObjectSchemaCreateResponse

object

Response after creating a custom object schema in the CRM.

4 properties 4 required

ContactPushSelector

object

2 properties 2 required

PushCustomObjectsResponse

object

Summary response from pushing automation results as custom objects.

6 properties 5 required

CRMFieldResponse

object

A single field from the user's CRM.

4 properties 4 required

AutomationActivityPushRequest

object

Request to push an automation result as a CRM activity.

7 properties 1 required

PushResultItem

object

Outcome for a single institution push attempt.

4 properties 3 required

AutomationExecutionStatus

string

CustomObjectSchemaSpecResponse

object

Full, static definition of a custom object for manual setup instructions.

7 properties 7 required

CRMAccountLayoutResponse

object

A single page layout available on the Account/Company object.

2 properties 2 required

PushSignalsResponse

object

Summary response from pushing automation run signals to CRM.

8 properties 7 required

PushRunContactsRequest

object

2 properties

PostOptions

object

Options for creating a post in CRM.

2 properties

HTTPValidationError

object

1 property

TaskOptions

object

Options for creating a task in CRM.

5 properties

PushAutomationResultsRequest

object

Request body for pushing automation results to CRM.

3 properties 1 required

CustomObjectFieldSpec

object

A single property the user must create when building the object by hand.

4 properties 4 required

PushableColumnResponse

object

Describes a single column available for CRM push.

5 properties 5 required

TaskPriority

string

CRM task priority levels.

PushAutomationResultsResponse

object

Summary response from pushing automation results to CRM.

6 properties 5 required

CustomObjectSchemaCreateRequest

object

Request body for creating a custom object schema.

1 property

CRMActionResponse

object

Response from a CRM action.

5 properties 5 required

PushHistoryItem

object

A single CRM push event in the per-automation history.

7 properties 6 required

CRMActionType

string

Type of CRM action to perform on a signal.

PushSignalsRequest

object

Request to push signals from a ranked automation run to CRM as notes or tasks.

3 properties 1 required

FieldMapping

object

Maps a single automation column to an existing CRM field.

3 properties 2 required

PushRunContactsResponse

object

6 properties 4 required

PaginatedResponse_PushHistoryItem_

object

4 properties 4 required

PushContactItem

object

8 properties 3 required

PushCustomObjectsRequest

object

Request body for pushing automation results as custom object records.

2 properties

CustomObjectSchemaStatusResponse

object

Response describing whether a custom object schema exists in the CRM.

6 properties 3 required

SignalSourceType

string

AutomationResultFilters

object

17 properties

PushStatusItem

object

Push status for a single automation result.

5 properties 3 required

SignalPushItem

object

Outcome for a single signal push attempt.

6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs NationGraph publishes across the network.

NationGraph Accounts API

AE Profile APIs.io

NationGraph Automations API

AE Profile APIs.io

NationGraph Budgets API

AE Profile APIs.io

NationGraph Classifier API

AE Profile APIs.io

NationGraph Classifiers API

AE Profile APIs.io

NationGraph Contacts API

AE Profile APIs.io

NationGraph Contracts API

AE Profile APIs.io

NationGraph CRM API

AE Profile APIs.io

NationGraph CRM Companies API

AE Profile APIs.io

NationGraph CRM Contacts API

AE Profile APIs.io

NationGraph CRM History API

AE Profile APIs.io

NationGraph CRM Leads API

AE Profile APIs.io

#CRM Automation Push

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NationGraph CRM Automation Push API

Metadata

Authentication & Security 1

Paths & Operations 13

Schemas 36

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NationGraph CRM Automation Push API

Metadata

Authentication & Security 1

Paths & Operations 13

Schemas 36

Specification

Source

More from NationGraph 12

API Details

Provider

Explore more