{
  "opencollection": "1.0.0",
  "info": {
    "name": "Unified CRM Accounts Properties API",
    "version": "0.25.7"
  },
  "items": [
    {
      "info": {
        "name": "Properties",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List properties",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.supaglue.io/crm/v2/metadata/properties/:object_name",
            "headers": [
              {
                "name": "x-customer-id",
                "value": "my-customer-1"
              },
              {
                "name": "x-provider-name",
                "value": "salesforce"
              }
            ],
            "params": [
              {
                "name": "object_name",
                "value": "contact",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "List properties"
        },
        {
          "info": {
            "name": "Create property",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.supaglue.io/crm/v2/metadata/properties/:object_name",
            "headers": [
              {
                "name": "x-customer-id",
                "value": "my-customer-1"
              },
              {
                "name": "x-provider-name",
                "value": "salesforce"
              }
            ],
            "params": [
              {
                "name": "object_name",
                "value": "contact",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": "Creates a custom property in the provider and registers it in Supaglue.\n\n:::note\nThis endpoint is only supported for Salesforce and Hubspot currently.\n:::\n"
        },
        {
          "info": {
            "name": "Get property (preview)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.supaglue.io/crm/v2/metadata/properties/:object_name/:property_name",
            "headers": [
              {
                "name": "x-customer-id",
                "value": "my-customer-1"
              },
              {
                "name": "x-provider-name",
                "value": "salesforce"
              }
            ],
            "params": [
              {
                "name": "object_name",
                "value": "contact",
                "type": "path"
              },
              {
                "name": "property_name",
                "value": "email",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n"
        },
        {
          "info": {
            "name": "Update property (preview)",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.supaglue.io/crm/v2/metadata/properties/:object_name/:property_name",
            "headers": [
              {
                "name": "x-customer-id",
                "value": "my-customer-1"
              },
              {
                "name": "x-provider-name",
                "value": "salesforce"
              }
            ],
            "params": [
              {
                "name": "object_name",
                "value": "contact",
                "type": "path"
              },
              {
                "name": "property_name",
                "value": "email",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\n:::note\nThis endpoint is only supported for Salesforce and Hubspot currently.\n:::\n"
        },
        {
          "info": {
            "name": "Register Property (preview)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.supaglue.io/crm/v2/metadata/properties/:object_name/register",
            "headers": [
              {
                "name": "x-customer-id",
                "value": "my-customer-1"
              },
              {
                "name": "x-provider-name",
                "value": "salesforce"
              }
            ],
            "params": [
              {
                "name": "object_name",
                "value": "contact",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "x-api-key",
              "value": "{{x-api-key}}",
              "placement": "header"
            }
          },
          "docs": ":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\nRegisters a custom property in Supaglue.\nThis may be useful for custom properties that were already created in the Customer's provider.\nE.g. a custom field has some machine ID for a particular customer that you want to map to `my_custom_field`.\n"
        }
      ]
    }
  ],
  "bundled": true
}