POST
/
api
/
crm_integrations
curl --request POST \
  --url https://app.herondata.io/api/crm_integrations \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "auth": {},
  "config": {
    "data_source_accounts_config": {
      "description": "A company or person",
      "external_lookup_config": {
        "external_lookup_fields_and": [
          "<string>"
        ],
        "external_lookup_fields_or": [
          "<string>"
        ],
        "sort_field_name": "CreatedDate",
        "sort_order": "ASC"
      },
      "external_name": "Account",
      "field_mappings": [
        {
          "external_lookup_field_name": "<string>",
          "external_object_name_for_id": "Account",
          "field_name": "Name",
          "heron_company_attribute_label": "owner_1_first_name",
          "max_length": 255,
          "overwrite_on_update": true,
          "regex_remove": "pattern",
          "required": true,
          "static_value": "static value",
          "static_value_key": "date_today",
          "value_mapping_name": "state",
          "value_type": "Text"
        }
      ],
      "is_optional": false,
      "key": "Account",
      "required_ids": [
        {
          "alias": "Company",
          "external_name": "Account"
        }
      ],
      "static_data": [
        {
          "key": "status",
          "value": "<any>"
        }
      ]
    },
    "default_id": {
      "alias": "Company",
      "external_name": "Account"
    },
    "object_configs": [],
    "policy_evaluation_config": {
      "external_object_name": "Opportunity",
      "failure_reason_external_name": "Failure_Reason__c",
      "result_external_name": "Submission_Result_from_Heron__c"
    },
    "sync_file_classes": {},
    "value_mappings": []
  },
  "failure_notification_channel": null,
  "instance_url": "https://sandbox.salesforce.com",
  "is_enabled": true,
  "is_live": true,
  "provider": "salesforce",
  "secret": "<string>"
}'
{
  "crm_integration": {
    "config": {
      "data_source_accounts_config": {
        "description": "A company or person",
        "external_lookup_config": {
          "external_lookup_fields_and": [
            "<string>"
          ],
          "external_lookup_fields_or": [
            "<string>"
          ],
          "sort_field_name": "CreatedDate",
          "sort_order": "ASC"
        },
        "external_name": "Account",
        "field_mappings": [
          {
            "external_lookup_field_name": "<string>",
            "external_object_name_for_id": "Account",
            "field_name": "Name",
            "heron_company_attribute_label": "owner_1_first_name",
            "max_length": 255,
            "overwrite_on_update": true,
            "regex_remove": "pattern",
            "required": true,
            "static_value": "static value",
            "static_value_key": "date_today",
            "value_mapping_name": "state",
            "value_type": "Text"
          }
        ],
        "is_optional": false,
        "key": "Account",
        "required_ids": [
          {
            "alias": "Company",
            "external_name": "Account"
          }
        ],
        "static_data": [
          {
            "key": "status",
            "value": "<any>"
          }
        ]
      },
      "default_id": {
        "alias": "Company",
        "external_name": "Account"
      },
      "object_configs": [],
      "policy_evaluation_config": {
        "external_object_name": "Opportunity",
        "failure_reason_external_name": "Failure_Reason__c",
        "result_external_name": "Submission_Result_from_Heron__c"
      },
      "sync_file_classes": {},
      "value_mappings": []
    },
    "failure_notification_channel": null,
    "heron_id": "<string>",
    "instance_url": "https://sandbox.salesforce.com",
    "is_enabled": true,
    "is_live": true,
    "provider": "salesforce"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json

Response

201 - application/json

Created

The response is of type object.