Create Sync Config

POST 
/sync_configs

Create Sync Config

Request

application/json

Body

required

destination_name stringrequired
provider_name provider_namerequired

Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

config objectrequired
default_config objectrequired
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
common_objects object[]
A list of Supaglue objects to be synced.
Array [
object stringrequired
The Supaglue object name
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no additional associations will be fetched other than the ones required to populate the common model. Only relevant for Hubspot.
]
standard_objects object[]
A list of case-sensitive Provider objects to be synced.
Array [
object stringrequired
The Provider object name (case sensitive)
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.
]
custom_objects object[]
A list of case-sensitive custom objects to be synced. Only supported for Salesforce and Hubspot.
Array [
object stringrequired
The custom object name (case sensitive). For Salesforce, this should end with __c.
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.
]
entities object[]deprecated
Array [
entity_id stringrequired
]

Responses

201

SyncConfig created

application/json

Schema

Schema

id stringrequired
application_id stringrequired
destination_name stringrequired
provider_name provider_namerequired

Possible values: [hubspot, salesforce, pipedrive, zendesk_sell, ms_dynamics_365_sales, zoho_crm, capsule, outreach, gong, apollo, salesloft, intercom, linear, clearbit, 6sense, marketo, salesforce_marketing_cloud_account_engagement, slack]

config objectrequired
default_config objectrequired
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
common_objects object[]
A list of Supaglue objects to be synced.
Array [
object stringrequired
The Supaglue object name
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no additional associations will be fetched other than the ones required to populate the common model. Only relevant for Hubspot.
]
standard_objects object[]
A list of case-sensitive Provider objects to be synced.
Array [
object stringrequired
The Provider object name (case sensitive)
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.
]
custom_objects object[]
A list of case-sensitive custom objects to be synced. Only supported for Salesforce and Hubspot.
Array [
object stringrequired
The custom object name (case sensitive). For Salesforce, this should end with __c.
sync_strategy_override object
Configuration options for "how" to sync.
period_ms integerrequired
Possible values: >= 60000
The period (in milliseconds) to run the sync.
strategy stringrequired
Possible values: [full then incremental, full only]
"full then incremental" will run a full sync on the first run, then incremental syncs. "full only" will run a full sync on every run.
auto_start_on_connection boolean
If true, the sync will start automatically when the connection is created. Default: true
full_sync_every_n_incrementals number
If set, Supaglue will run a full sync after N consecutive incremental syncs.
associations_to_fetch string[]
A list of associated objects to fetch when syncing this object. If empty or unspecified, no associations will be fetched. Only relevant for Hubspot.
]
entities object[]deprecated
Array [
entity_id stringrequired
]

Example (from schema)

{
  "id": "465fdcb7-26b4-4090-894c-67cab41022bb",
  "application_id": "9572d08b-f19f-48cc-a992-1eb7031d3f6a",
  "destination_name": "postgres",
  "provider_name": "hubspot",
  "config": {
    "default_config": {
      "period_ms": 60000,
      "strategy": "full then incremental",
      "auto_start_on_connection": true,
      "full_sync_every_n_incrementals": 0
    },
    "common_objects": [
      {
        "object": "contact",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ],
    "standard_objects": [
      {
        "object": "Contact",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ],
    "custom_objects": [
      {
        "object": "MyCustomObject__c",
        "sync_strategy_override": {
          "period_ms": 60000,
          "strategy": "full then incremental",
          "auto_start_on_connection": true,
          "full_sync_every_n_incrementals": 0
        },
        "associations_to_fetch": [
          "account"
        ]
      }
    ]
  }
}

400

Bad request

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

401

Unauthorized

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

403

Forbidden

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

404

Not found

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

409

Conflict

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

422

Unprocessable entity

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

500

Internal server error

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

501

Not implemented

application/json

Schema

Schema

errors object[]
Array [
id stringrequired
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
detail stringrequired
A detailed description of the error.
problem_type stringdeprecated
The Supaglue error code associated with the error.
title stringrequired
A brief description of the error. The schema and type of message will vary by Provider.
code stringrequired
The Supaglue error code associated with the error.
status stringrequired
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
cause object
The cause of the error. Usually the underlying error from the remote Provider.
origin stringrequired
Possible values: [remote-provider, supaglue]
The origin of the error.
application_name string
The name of the application that generated the error.
property name* any
Additional metadata about the error.
]

Example (from schema)

{
  "errors": [
    [
      {
        "meta": {
          "cause": {
            "code": 400,
            "body": {
              "status": "error",
              "message": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
              "correlationId": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "category": "VALIDATION_ERROR"
            },
            "headers": {
              "access-control-allow-credentials": "false",
              "cf-cache-status": "DYNAMIC",
              "cf-ray": "8053d17b9dae9664-SJC",
              "connection": "close",
              "content-length": "361",
              "content-type": "application/json;charset=utf-8",
              "date": "Mon, 11 Sep 2023 23:51:22 GMT",
              "nel": "{\"success_fraction\":0.01,\"report_to\":\"cf-nel\",\"max_age\":604800}",
              "report-to": "{\"endpoints\":[{\"url\":\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\"}],\"group\":\"cf-nel\",\"max_age\":604800}",
              "server": "cloudflare",
              "strict-transport-security": "max-age=31536000; includeSubDomains; preload",
              "vary": "origin, Accept-Encoding",
              "x-content-type-options": "nosniff",
              "x-envoy-upstream-service-time": "91",
              "x-evy-trace-listener": "listener_https",
              "x-evy-trace-route-configuration": "listener_https/all",
              "x-evy-trace-route-service-name": "envoyset-translator",
              "x-evy-trace-served-by-pod": "iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2",
              "x-evy-trace-virtual-host": "all",
              "x-hubspot-correlation-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-hubspot-ratelimit-interval-milliseconds": "10000",
              "x-hubspot-ratelimit-max": "100",
              "x-hubspot-ratelimit-remaining": "99",
              "x-hubspot-ratelimit-secondly": "10",
              "x-hubspot-ratelimit-secondly-remaining": "9",
              "x-request-id": "ac94252c-90b5-45d2-ad1d-9a9f7651d7d2",
              "x-trace": "2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000"
            }
          }
        },
        "detail": "Property values were not valid: [{\"isValid\":false,\"message\":\"Property \\\"__about_us\\\" does not exist\",\"error\":\"PROPERTY_DOESNT_EXIST\",\"name\":\"__about_us\",\"localizedErrorMessage\":\"Property \\\"__about_us\\\" does not exist\"}]",
        "problem_type": "MISSING_REQUIRED_FIELD",
        "title": "Property values were not valid\n",
        "code": "MISSING_REQUIRED_FIELD",
        "status": "400",
        "id": "9366efb4-8fb1-4a28-bfb0-8d6f9cc6b5c5"
      }
    ]
  ]
}

Loading...