List schema mappings
GET/field_mappings
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
List schema mappings
Request
Header Parameters
The customer ID that uniquely identifies the customer in your application
The provider name
Responses
- 200
- 400
- 401
- 403
- 404
- 500
- 501
List of objects and their field mappings (if set)
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
Possible values: [common
, standard
]
fields object[]required
The name of the field as set in the schema
Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)
The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of schema_mapped_name
or customer_mapped_name
should be set.
The mapped name of the field as set by the customer. Only one of schema_mapped_name
or customer_mapped_name
should be set.
[
{
"object_name": "contact",
"object_type": "common",
"allow_additional_field_mappings": true,
"schema_id": "51797e8d-f081-496d-99ec-5e41b467df4b",
"fields": [
{
"name": "email",
"is_added_by_customer": true,
"schema_mapped_name": "string",
"customer_mapped_name": "string"
}
]
}
]
Bad request
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}
Internal server error
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}
Not implemented
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
errors object[]
A unique identifier for the instance of the error. Provide this to support when contacting Supaglue.
A detailed description of the error.
The Supaglue error code associated with the error.
A brief description of the error. The schema and type of message will vary by Provider.
The Supaglue error code associated with the error.
The HTTP status code associated with the error.
meta objectrequired
Additional metadata about the error.
The cause of the error. Usually the underlying error from the remote Provider.
Possible values: [remote-provider
, supaglue
]
The origin of the error.
The name of the application that generated the error.
Additional metadata about the error.
{
"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"
}
]
]
}