From 6dc83f33b3a7fae0169b75f6ff5e271d7da06c91 Mon Sep 17 00:00:00 2001 From: tom Date: Tue, 10 Oct 2023 13:55:26 -0700 Subject: [PATCH] chore: audit responses. remove unused mgmt apis --- apps/api/middleware/openapi.ts | 12 + .../mgmt/v2/customer/connection/index.ts | 7 +- apps/api/routes/mgmt/v2/destination/index.ts | 78 -- apps/api/routes/mgmt/v2/entity/index.ts | 3 + apps/api/routes/mgmt/v2/index.ts | 4 - apps/api/routes/mgmt/v2/provider/index.ts | 97 --- docs/docs/api/v2/actions/actions-api.info.mdx | 2 +- .../actions/send-passthrough-request.api.mdx | 46 +- docs/docs/api/v2/crm/create-account.api.mdx | 6 +- docs/docs/api/v2/crm/create-contact.api.mdx | 6 +- docs/docs/api/v2/crm/create-lead.api.mdx | 6 +- .../api/v2/crm/create-opportunity.api.mdx | 6 +- docs/docs/api/v2/crm/get-account.api.mdx | 6 +- docs/docs/api/v2/crm/get-contact.api.mdx | 6 +- docs/docs/api/v2/crm/get-lead.api.mdx | 6 +- docs/docs/api/v2/crm/get-opportunity.api.mdx | 6 +- docs/docs/api/v2/crm/get-user.api.mdx | 6 +- docs/docs/api/v2/crm/list-accounts.api.mdx | 6 +- docs/docs/api/v2/crm/list-contacts.api.mdx | 6 +- .../api/v2/crm/list-list-memberships.api.mdx | 6 +- docs/docs/api/v2/crm/list-lists.api.mdx | 6 +- docs/docs/api/v2/crm/search-contacts.api.mdx | 6 +- docs/docs/api/v2/crm/search-leads.api.mdx | 6 +- .../v2/crm/send-passthrough-request.api.mdx | 46 +- docs/docs/api/v2/crm/unified-crm-api.info.mdx | 2 +- docs/docs/api/v2/crm/update-account.api.mdx | 6 +- docs/docs/api/v2/crm/update-contact.api.mdx | 6 +- docs/docs/api/v2/crm/update-lead.api.mdx | 6 +- .../api/v2/crm/update-opportunity.api.mdx | 6 +- docs/docs/api/v2/crm/upsert-account.api.mdx | 6 +- docs/docs/api/v2/crm/upsert-contact.api.mdx | 6 +- docs/docs/api/v2/crm/upsert-lead.api.mdx | 6 +- .../api/v2/data/data-listing-api.info.mdx | 2 +- .../v2/data/list-hubspot-companies.api.mdx | 6 +- .../api/v2/data/list-hubspot-contacts.api.mdx | 6 +- .../v2/data/list-salesforce-accounts.api.mdx | 6 +- .../v2/data/list-salesforce-contacts.api.mdx | 6 +- .../api/v2/engagement/create-account.api.mdx | 6 +- .../api/v2/engagement/create-contact.api.mdx | 6 +- .../engagement/create-sequence-state.api.mdx | 6 +- .../engagement/create-sequence-step.api.mdx | 12 +- .../api/v2/engagement/create-sequence.api.mdx | 12 +- .../api/v2/engagement/get-account.api.mdx | 6 +- .../api/v2/engagement/get-contact.api.mdx | 6 +- .../api/v2/engagement/get-mailbox.api.mdx | 6 +- .../v2/engagement/get-sequence-state.api.mdx | 6 +- .../api/v2/engagement/get-sequence.api.mdx | 6 +- docs/docs/api/v2/engagement/get-user.api.mdx | 6 +- .../send-passthrough-request.api.mdx | 46 +- .../unified-engagement-api.info.mdx | 2 +- .../api/v2/engagement/update-account.api.mdx | 6 +- .../api/v2/engagement/update-contact.api.mdx | 6 +- .../api/v2/enrichment/enrich-person.api.mdx | 6 +- .../unified-enrichment-api.info.mdx | 2 +- .../get-form-fields.api.mdx | 6 +- .../marketing-automation/list-forms.api.mdx | 6 +- .../marketing-automation/submit-form.api.mdx | 6 +- .../unified-enrichment-api.info.mdx | 2 +- .../metadata/create-association-type.api.mdx | 6 +- .../v2/metadata/create-custom-object.api.mdx | 6 +- .../api/v2/metadata/create-property.api.mdx | 6 +- .../v2/metadata/get-association-types.api.mdx | 6 +- .../api/v2/metadata/get-custom-object.api.mdx | 6 +- .../docs/api/v2/metadata/get-property.api.mdx | 6 +- .../v2/metadata/list-custom-objects.api.mdx | 6 +- .../list-properties-deprecated.api.mdx | 6 +- .../metadata/list-properties-preview.api.mdx | 6 +- .../v2/metadata/list-standard-objects.api.mdx | 6 +- .../api/v2/metadata/metadata-api.info.mdx | 2 +- .../api/v2/metadata/register-property.api.mdx | 6 +- .../v2/metadata/update-custom-object.api.mdx | 6 +- .../api/v2/metadata/update-property.api.mdx | 6 +- .../api/v2/mgmt/connection-created.api.mdx | 6 +- .../api/v2/mgmt/connection-deleted.api.mdx | 6 +- .../api/v2/mgmt/create-connection.api.mdx | 25 +- .../api/v2/mgmt/create-destination.api.mdx | 42 -- docs/docs/api/v2/mgmt/create-entity.api.mdx | 10 +- .../api/v2/mgmt/create-magic-link.api.mdx | 8 +- docs/docs/api/v2/mgmt/create-provider.api.mdx | 70 -- docs/docs/api/v2/mgmt/create-schema.api.mdx | 10 +- .../api/v2/mgmt/create-sync-config.api.mdx | 10 +- .../delete-connection-sync-config.api.mdx | 6 +- .../api/v2/mgmt/delete-connection.api.mdx | 6 +- docs/docs/api/v2/mgmt/delete-customer.api.mdx | 16 +- .../api/v2/mgmt/delete-entity-mapping.api.mdx | 6 +- docs/docs/api/v2/mgmt/delete-entity.api.mdx | 8 +- .../api/v2/mgmt/delete-magic-link.api.mdx | 6 +- docs/docs/api/v2/mgmt/delete-provider.api.mdx | 54 -- docs/docs/api/v2/mgmt/delete-schema.api.mdx | 8 +- .../api/v2/mgmt/delete-sync-config.api.mdx | 8 +- docs/docs/api/v2/mgmt/destinations.tag.mdx | 20 - .../entity-entity-mapping-created.api.mdx | 6 +- .../entity-entity-mapping-deleted.api.mdx | 6 +- .../entity-entity-mapping-updated.api.mdx | 6 +- .../mgmt/get-connection-sync-config.api.mdx | 12 +- docs/docs/api/v2/mgmt/get-connection.api.mdx | 25 +- docs/docs/api/v2/mgmt/get-connections.api.mdx | 25 +- docs/docs/api/v2/mgmt/get-customer.api.mdx | 16 +- docs/docs/api/v2/mgmt/get-customers.api.mdx | 16 +- docs/docs/api/v2/mgmt/get-destination.api.mdx | 42 -- .../docs/api/v2/mgmt/get-destinations.api.mdx | 42 -- docs/docs/api/v2/mgmt/get-entities.api.mdx | 8 +- docs/docs/api/v2/mgmt/get-entity.api.mdx | 8 +- docs/docs/api/v2/mgmt/get-magic-links.api.mdx | 8 +- .../api/v2/mgmt/get-provider-user-id.api.mdx | 6 +- docs/docs/api/v2/mgmt/get-provider.api.mdx | 54 -- docs/docs/api/v2/mgmt/get-providers.api.mdx | 54 -- docs/docs/api/v2/mgmt/get-schema.api.mdx | 8 +- docs/docs/api/v2/mgmt/get-schemas.api.mdx | 8 +- docs/docs/api/v2/mgmt/get-sync-config.api.mdx | 8 +- .../docs/api/v2/mgmt/get-sync-configs.api.mdx | 8 +- docs/docs/api/v2/mgmt/get-sync-runs.api.mdx | 10 +- docs/docs/api/v2/mgmt/get-syncs.api.mdx | 10 +- .../api/v2/mgmt/list-entity-mappings.api.mdx | 6 +- .../api/v2/mgmt/list-field-mappings.api.mdx | 6 +- docs/docs/api/v2/mgmt/management-api.info.mdx | 2 +- .../mgmt/object-field-mapping-created.api.mdx | 6 +- .../mgmt/object-field-mapping-updated.api.mdx | 6 +- docs/docs/api/v2/mgmt/pause-sync.api.mdx | 10 +- docs/docs/api/v2/mgmt/providers.tag.mdx | 20 - docs/docs/api/v2/mgmt/resume-sync.api.mdx | 10 +- docs/docs/api/v2/mgmt/sidebar.js | 2 +- docs/docs/api/v2/mgmt/sync-complete.api.mdx | 6 +- docs/docs/api/v2/mgmt/trigger-sync.api.mdx | 10 +- .../api/v2/mgmt/update-destination.api.mdx | 42 -- docs/docs/api/v2/mgmt/update-entity.api.mdx | 10 +- .../mgmt/update-object-field-mappings.api.mdx | 6 +- docs/docs/api/v2/mgmt/update-provider.api.mdx | 78 -- docs/docs/api/v2/mgmt/update-schema.api.mdx | 10 +- .../api/v2/mgmt/update-sync-config.api.mdx | 10 +- .../upsert-connection-sync-config.api.mdx | 16 +- docs/docs/api/v2/mgmt/upsert-customer.api.mdx | 25 +- .../api/v2/mgmt/upsert-entity-mapping.api.mdx | 6 +- .../v2/ticketing/create-attachment.api.mdx | 6 +- .../api/v2/ticketing/create-comment.api.mdx | 6 +- .../api/v2/ticketing/create-ticket.api.mdx | 6 +- .../docs/api/v2/ticketing/get-account.api.mdx | 6 +- .../api/v2/ticketing/get-attachment.api.mdx | 6 +- .../api/v2/ticketing/get-collection.api.mdx | 6 +- .../docs/api/v2/ticketing/get-contact.api.mdx | 6 +- docs/docs/api/v2/ticketing/get-tag.api.mdx | 6 +- docs/docs/api/v2/ticketing/get-team.api.mdx | 6 +- docs/docs/api/v2/ticketing/get-ticket.api.mdx | 6 +- docs/docs/api/v2/ticketing/get-user.api.mdx | 6 +- .../api/v2/ticketing/list-accounts.api.mdx | 6 +- .../api/v2/ticketing/list-attachments.api.mdx | 6 +- .../ticketing/list-collection-users.api.mdx | 6 +- .../api/v2/ticketing/list-collections.api.mdx | 6 +- .../api/v2/ticketing/list-comments.api.mdx | 6 +- .../api/v2/ticketing/list-contacts.api.mdx | 6 +- docs/docs/api/v2/ticketing/list-tags.api.mdx | 6 +- docs/docs/api/v2/ticketing/list-teams.api.mdx | 6 +- .../api/v2/ticketing/list-tickets.api.mdx | 6 +- docs/docs/api/v2/ticketing/list-users.api.mdx | 6 +- .../unified-ticketing-api-preview.info.mdx | 2 +- .../api/v2/ticketing/update-ticket.api.mdx | 6 +- .../schemas/create_destination.yaml | 21 +- .../schemas/objects/connection.yaml | 2 + .../objects/connection_entity_mapping.yaml | 3 +- .../objects/connection_entity_mappings.yaml | 1 + .../components/schemas/objects/customer.yaml | 1 + .../schemas/objects/destination.yaml | 35 +- .../components/schemas/objects/entity.yaml | 1 + .../schemas/objects/entity_config.yaml | 1 + .../schemas/objects/entity_field_mapping.yaml | 1 + .../schemas/objects/magic_link.yaml | 4 +- .../components/schemas/objects/provider.yaml | 1 + .../objects/provider_entity_mapping.yaml | 1 + .../objects/provider_entity_mappings.yaml | 1 + .../objects/s3_config_at_least_safe.yaml | 18 - .../schemas/objects/s3_config_safe.yaml | 15 - .../schemas/objects/s3_config_unsafe.yaml | 19 - .../components/schemas/objects/schema.yaml | 1 + .../schemas/objects/schema_config.yaml | 1 + .../objects/schema_mappings_config.yaml | 1 + .../schemas/objects/simple_customer.yaml | 19 + .../mgmt/components/schemas/objects/sync.yaml | 47 +- .../schemas/objects/sync_config_data.yaml | 1 + .../components/schemas/objects/sync_run.yaml | 18 + .../sync_with_provider_and_customer.yaml | 40 +- openapi/v2/mgmt/openapi.bundle.json | 693 ++++++------------ openapi/v2/mgmt/openapi.yaml | 10 +- .../paths/connections@{connection_id}.yaml | 5 - openapi/v2/mgmt/paths/customers.yaml | 2 +- .../mgmt/paths/customers@{customer_id}.yaml | 18 +- openapi/v2/mgmt/paths/sync_runs.yaml | 5 +- openapi/v2/mgmt/paths/syncs.yaml | 1 + openapi/v2/mgmt/paths/syncs@_pause.yaml | 17 +- openapi/v2/mgmt/paths/syncs@_resume.yaml | 19 +- openapi/v2/mgmt/paths/syncs@_trigger.yaml | 23 +- packages/schemas/gen/v2/mgmt.ts | 384 ++++------ packages/types/magic_link.ts | 1 - 192 files changed, 1059 insertions(+), 2205 deletions(-) delete mode 100644 apps/api/routes/mgmt/v2/destination/index.ts delete mode 100644 apps/api/routes/mgmt/v2/provider/index.ts delete mode 100644 docs/docs/api/v2/mgmt/create-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/create-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/delete-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/destinations.tag.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-destinations.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-provider.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/get-providers.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/providers.tag.mdx delete mode 100644 docs/docs/api/v2/mgmt/update-destination.api.mdx delete mode 100644 docs/docs/api/v2/mgmt/update-provider.api.mdx delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml delete mode 100644 openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml create mode 100644 openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml diff --git a/apps/api/middleware/openapi.ts b/apps/api/middleware/openapi.ts index c7e5a96442..64abee7c7f 100644 --- a/apps/api/middleware/openapi.ts +++ b/apps/api/middleware/openapi.ts @@ -1,3 +1,4 @@ +import { logger } from '@supaglue/core/lib'; import type { NextFunction, Request, Response } from 'express'; import * as OpenApiValidator from 'express-openapi-validator'; import fs from 'fs'; @@ -39,6 +40,17 @@ export const openapiMiddleware = (specDir: string, version = 'v2') => { validateRequests: { removeAdditional: true, }, + validateResponses: { + onError: (error, body, req) => { + logger.error( + { + error, + originalUrl: req.originalUrl, + }, + 'API reference validation error' + ); + }, + }, }); }; diff --git a/apps/api/routes/mgmt/v2/customer/connection/index.ts b/apps/api/routes/mgmt/v2/customer/connection/index.ts index f91d1152d7..d026650346 100644 --- a/apps/api/routes/mgmt/v2/customer/connection/index.ts +++ b/apps/api/routes/mgmt/v2/customer/connection/index.ts @@ -107,12 +107,7 @@ export default function init(app: Router): void { req.supaglueApplication.id ); - // enrich with user_id, if we can. - // TODO remove this after users migrate to /_provider_user_id above - const [client] = await remoteService.getCrmRemoteClient(req.params.connection_id); - const { userId } = await client.getUserIdAndDetails(); - - return res.status(200).send(snakecaseKeys({ ...connection, userId })); + return res.status(200).send(snakecaseKeys(connection)); } ); diff --git a/apps/api/routes/mgmt/v2/destination/index.ts b/apps/api/routes/mgmt/v2/destination/index.ts deleted file mode 100644 index c8b5fb569c..0000000000 --- a/apps/api/routes/mgmt/v2/destination/index.ts +++ /dev/null @@ -1,78 +0,0 @@ -import { getDependencyContainer } from '@/dependency_container'; -import type { - CreateDestinationPathParams, - CreateDestinationRequest, - CreateDestinationResponse, - GetDestinationPathParams, - GetDestinationRequest, - GetDestinationResponse, - GetDestinationsPathParams, - GetDestinationsRequest, - GetDestinationsResponse, - UpdateDestinationPathParams, - UpdateDestinationRequest, - UpdateDestinationResponse, -} from '@supaglue/schemas/v2/mgmt'; -import { camelcaseKeys } from '@supaglue/utils/camelcase'; -import { snakecaseKeys } from '@supaglue/utils/snakecase'; -import type { Request, Response } from 'express'; -import { Router } from 'express'; - -const { destinationService } = getDependencyContainer(); - -export default function init(app: Router): void { - const destinationRouter = Router({ mergeParams: true }); - - destinationRouter.get( - '/', - async ( - req: Request, - res: Response - ) => { - const destinations = await destinationService.getDestinationsSafeByApplicationId(req.supaglueApplication.id); - return res.status(200).send(destinations.map(snakecaseKeys)); - } - ); - - destinationRouter.get( - '/:destination_id', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.getDestinationSafeById(req.params.destination_id); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - destinationRouter.post( - '/', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.createDestination({ - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - }); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - destinationRouter.put( - '/:destination_id', - async ( - req: Request, - res: Response - ) => { - const destination = await destinationService.updateDestination({ - id: req.params.destination_id, - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - }); - return res.status(200).send(snakecaseKeys(destination)); - } - ); - - app.use('/destinations', destinationRouter); -} diff --git a/apps/api/routes/mgmt/v2/entity/index.ts b/apps/api/routes/mgmt/v2/entity/index.ts index 4e5aa45811..ae9dfe47ae 100644 --- a/apps/api/routes/mgmt/v2/entity/index.ts +++ b/apps/api/routes/mgmt/v2/entity/index.ts @@ -23,6 +23,9 @@ import { Router } from 'express'; const { entityService } = getDependencyContainer(); +/** + * @deprecated + */ export default function init(app: Router): void { const entityRouter = Router({ mergeParams: true }); diff --git a/apps/api/routes/mgmt/v2/index.ts b/apps/api/routes/mgmt/v2/index.ts index b9984a9fa7..3a6293a44b 100644 --- a/apps/api/routes/mgmt/v2/index.ts +++ b/apps/api/routes/mgmt/v2/index.ts @@ -4,12 +4,10 @@ import { pinoAndSentryContextMiddleware } from '@/middleware/pino_context'; import { Router } from 'express'; import connectionSyncConfig from './connection_sync_config'; import customer from './customer'; -import destination from './destination'; import entity from './entity'; import entityMapping from './entity_mapping'; import fieldMapping from './field_mapping'; import magicLink from './magic_link'; -import provider from './provider'; import schema from './schema'; import sync from './sync'; import syncConfig from './sync_config'; @@ -23,8 +21,6 @@ export default function init(app: Router): void { v2Router.use(pinoAndSentryContextMiddleware); customer(v2Router); - destination(v2Router); - provider(v2Router); schema(v2Router); syncConfig(v2Router); sync(v2Router); diff --git a/apps/api/routes/mgmt/v2/provider/index.ts b/apps/api/routes/mgmt/v2/provider/index.ts deleted file mode 100644 index 57ad3d9d68..0000000000 --- a/apps/api/routes/mgmt/v2/provider/index.ts +++ /dev/null @@ -1,97 +0,0 @@ -import { getDependencyContainer } from '@/dependency_container'; -import { hideManagedOauthConfig } from '@supaglue/core/mappers/provider'; -import type { - CreateProviderPathParams, - CreateProviderRequest, - CreateProviderResponse, - DeleteProviderPathParams, - DeleteProviderRequest, - DeleteProviderResponse, - GetProviderPathParams, - GetProviderRequest, - GetProviderResponse, - GetProvidersPathParams, - GetProvidersRequest, - GetProvidersResponse, - UpdateProviderPathParams, - UpdateProviderRequest, - UpdateProviderResponse, -} from '@supaglue/schemas/v2/mgmt'; -import type { ProviderCreateParams, ProviderUpdateParams } from '@supaglue/types'; -import { camelcaseKeys } from '@supaglue/utils/camelcase'; -import { snakecaseKeys } from '@supaglue/utils/snakecase'; -import type { Request, Response } from 'express'; -import { Router } from 'express'; - -const { providerService } = getDependencyContainer(); - -export default function init(app: Router): void { - const providerRouter = Router(); - - providerRouter.get( - '/', - async ( - req: Request, - res: Response - ) => { - const providers = await providerService.list(req.supaglueApplication.id); - return res - .status(200) - .send(providers.map((provider) => snakecaseKeys(hideManagedOauthConfig(provider))) as GetProvidersResponse); - } - ); - - providerRouter.post( - '/', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.create({ - applicationId: req.supaglueApplication.id, - ...camelcaseKeys(req.body), - } as ProviderCreateParams); - return res.status(201).send(snakecaseKeys(hideManagedOauthConfig(provider)) as CreateProviderResponse); - } - ); - - providerRouter.get( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.getByIdAndApplicationId( - req.params.provider_id, - req.supaglueApplication.id - ); - return res.status(200).send(snakecaseKeys(hideManagedOauthConfig(provider)) as GetProviderResponse); - } - ); - - providerRouter.put( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - const provider = await providerService.update(req.params.provider_id, req.supaglueApplication.id, { - ...camelcaseKeys(req.body), - } as ProviderUpdateParams); - return res.status(200).send(snakecaseKeys(provider) as UpdateProviderResponse); - } - ); - - providerRouter.delete( - '/:provider_id', - async ( - req: Request, - res: Response - ) => { - await providerService.delete(req.params.provider_id, req.supaglueApplication.id); - return res.status(204).end(); - } - ); - - app.use('/providers', providerRouter); -} diff --git a/docs/docs/api/v2/actions/actions-api.info.mdx b/docs/docs/api/v2/actions/actions-api.info.mdx index 420deafee5..ce90714802 100644 --- a/docs/docs/api/v2/actions/actions-api.info.mdx +++ b/docs/docs/api/v2/actions/actions-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/actions/send-passthrough-request.api.mdx b/docs/docs/api/v2/actions/send-passthrough-request.api.mdx index 7e02877a58..a801583ede 100644 --- a/docs/docs/api/v2/actions/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/actions/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: eJytV9tu4zYQ/RVWfUmA2MpugQIxiqLZbNBNu+i6uaAPjoGlJdrmrkSqJGXHMPzvPUPqansvKWIDlkyOOGdmzly0jXQhDHdSq5s0GkVWqHTMrXVLo8vF8lb8WwrrorPI8YWNRpOosxlNzyCflEa6Dba20dOAF3LwWdC/6Q67qbCJkQWdjrPvcDYz4USWSiMSl22Y04yzwuiVTIWBokrgjU5xzNb/hSiwOVOKsyjRygnlaIsXRSYTjz3+ZEnFNrLJUuSc7tymEFCqZ5+gB+dCBSx1UljaLbhbdqSsM1Iton3E90vBSJJAkmeYw0JtAdZOUs2UdpCx1u+lOudSnUa7sygXbqnTYzqEKnNy5e/X9/g3/nDnLw/+9/L+6h2ub6/fX99fk4PFE8+LjJ4ncZy7FByOssdM7IN/FwQJZ8CnAW+tAEPwHNI8TSWJ8mzcc00f7g4qYa/ZfFvh3yQGXYbD9pfRPKtY0FdE3Dh+ODtJuGIzwcIZTBv2x92Hv1hAfArdWokPc8/W/bA46byf78KjXvXu7NDo4+gDO+szvNJwwpTsaFk8CdRr+NENcU3LKE5MHq9+igObbStdsYA+dKgttLLBd6/Pzw8d1UlWVktHL5ZDpcm+L4XmZZaxh9v3vfRZc8vWQIEARl2aL50r7CiOk9I6ncMRw0TnMQpLnHDQHnZbx13ZJQzyaeZrx1698XIs0SkgGJ1XGdohYqMV3ntOat17O4I/WfXUF1Q8n+tcbY4ytMPFyuDOikREF/2lmdaZ4Kq7xI3hG4CSTuQexZe5vHse9Q+rPfmITDrql/2cICo1gW0DMd01MfJwr9tMWfGsFA0LG9aAJ8NlOaML0eYgj2ruIOC9eD8N8BQC6gZohiKTucSdoGJOrh9dXHQChMiXmbM+RBmficyfYCFYZtwAzBXyy/CQMVlpeNZZ8wyuTe96cRIp1M09qk2pfOyqfG8rq1ftxUdAHjJFmIFMKbbk/GAZ2bufy20XajIu37RHvCJ4h4Gs99nNW4SSO1YqiTRG+0bXVk7OYYKPcSMoFdvo0rBOgYnO9ro5Uayxoh4BBpUbnm+H5aDJXJtEHDei1sAqDXtgpp0qW2g/9NTluOgMPTTzmFUdhEP22bLgC3BzKHWMeEO9jVevD4tTJcYuxzfRrjNJ3ZGloiJlM0+1KVzIPwXlcOO4WmbfZX19UMMg5cetLNNrloqVyIh+voXyJBHVDOMBwYHUDm7bYez62V2KAM21T1ZoCTDOh69+Hl50uu1lcJHXGjoTJc6oIUbtJ4o00pG8nerE/ta4GWmOvX4cepsHXPgRH3aDdNRp6bU/4vuPyCAsyBfeCS0s1K2kzMFyT+Jhs8UN1f6sQHcjMctsAnemdMK4YpodMhBvwwxXi6oHLblKM5ovrm4f3rJm+LZMq2pKCXOTMGByToI5io0cWCcKttbm8xzBs0OCPPlhclsqyrQx6JpzNT2pHWBKNSywpoiFs9I5ALerxWkrsV6vh0V4zFfK2mUx6bAFT0SzNCjKGXI41gjjSor1KSn3TnzDrecLNfdH9fHjx0f17VSoBCkuFYBuuGnKLnpjS/0G0gvith1ivvO9osofJ55cXGQo7ASgGmECoWk0673cLKkKYHm7ncHQB5PtdrRcjcMT3K64kXxGRJ5MmwHCF4ZUWtpAMsx5ZsVX4J/cVnXolL1kqT1qr68lBy2j6qWRHxX+N/D98vpVAPvVvgchCF0FRYN7OqeVOJhY2ycuUcQK91XZbpGv3rzqtp5jTsSq4WvqDfgdRY/40juDN96XZL9ObR/Nni9IPpxLBZOXvXdKZEAoy9VNZ6LDiNdB2S3hwRD67Y5tPfFfKOHQA35txMPOFx9oOkKQpkDQVPEfEweMgg== +api: {"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string","title":"String body"},{"type":"object","additionalProperties":true,"title":"JSON body"}]}},"required":["path","method"],"example":{"path":"/crm/v3/schemas","method":"GET"}}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://api.hubapi.com/crm/v3/schemas","status":200,"headers":{"x-hubspot-ratelimit-remaining":99},"body":{"results":[{"labels":{"singular":"Contract","plural":"Contracts"},"requiredProperties":["name","description"]}]}}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"/crm/v3/schemas","method":"GET"},"info":{"version":"0.16.9","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/actions/actions-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,19 +42,11 @@ Headers to pass to downstream Query parameters to pass to downstream -
body object
+
body object
Body to pass to downstream (can be string or JSON object) -
oneOf

String body

- -Body to pass to downstream (can be string or JSON object) - -

JSON body

- -Body to pass to downstream (can be string or JSON object) - -
+
oneOf
  • string
    • Passthrough response @@ -62,33 +54,9 @@ Passthrough response The response headers from the downstream -
    body object
    - -The body from the downstream - -
    anyOf

    MOD1

    - -The body from the downstream - -

    MOD2

    - -The body from the downstream - -

    MOD3

    - -The body from the downstream - -

    MOD4

    - -The body from the downstream - -

    MOD5

    - -The body from the downstream - -

    MOD6

    +
    body object
    The body from the downstream -
    +
    anyOf
  • string
  • number
  • integer
  • boolean
  • Array [
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/crm/create-account.api.mdx b/docs/docs/api/v2/crm/create-account.api.mdx index d4a1a325bf..3faf820991 100644 --- a/docs/docs/api/v2/crm/create-account.api.mdx +++ b/docs/docs/api/v2/crm/create-account.api.mdx @@ -5,7 +5,7 @@ description: "Create account" sidebar_label: "Create account" hide_title: true hide_table_of_contents: true -api: eJztWntv2zgS/yo8HRbXYiM/YzvO3t5dnEfhtmlydrptkQQuLVE2W0lUKMqPBv7uN0NKtiQnbd3uAvdH3CKJSc5w3vxRo3tLRExSxUXYd61Dy5GMKnbkOCIJlbVnKTqJrcNrKx2Jrds9K6KSBkwxiTP3VghfgHJhO0msRMCkzV2g5CEMThl1mYRvsTNlAbUO7y21jHB5rCQPJzDDFjSIfBwKlhsWdWu1Z7ksdiSPUDiYvpoyks2T/glRU6pIEvK7hPlLwl0WKu5xFsNEbiEPyVIkktAo8rmjFYVNJbtLuGSgsZIJW+3ltIikmAEzaeuRH9Ejpj6LPSEd9rAS2Q4k3aEkDFg4Zk4iuVpq+y5sGnH7M8NvtziL61msesJdoiBF8j3LEaECW+BUTunqpxgFuN/WQIw/MQd9DXJBLCgwoWHrCOl+e11Bv22zhInv0zHaxUi3MVMfxJyY0CNHl320FQ9d8Jtc7sYIiP8RI7nx4S6kQ/0HOU6jRTNJgjGTI+GNGMyJJTNqpjw5Cq0j4VGmjU67VqsBpzkbx1ztKNFUqSg+rFbjJKITP2EVRwRVlIu6rmRxXJCGSkmXGKOKBfG3XZWyGJlVD4Qw6I7JHkkeUImMA8p9Mycgq1DtMffTkXjKowj/vAXpHB2tu5k+JGeShg6PHYEK6gKzq+/fDo+QNhKxov7IEe6O5u7u12sd5AD0u7rq+MgQSsbUqL4bbavRIj3QPqRhjkljJyY4sVrl68d10cWpWzamLRoqUzqnQ04S9Op6q+ty8Gy8n/m+5NCcP8FJpZ0zu6/NjrbMm7Jgn7x5tM5QAxVX2o6brMAomIqQjUwC/0Sa5Nns5tVf6/v1Vr3R3G+1O2WBdsk6AVmGfvHoYp16t2VXF8R8aK+yB4t6FYV9UNa1SHmLF40MW4h5CBTc3THxvCbrdjzX3ndb8IN5jt1tdV17PGZjjzq1TtdrIXefe8xZOj4bQahMvi9DU4PGyRiPJmMeH05wXdDkZ6aA7i6hPsIFN53Qh3Z5UESRkAowhsmi7JSALWY0nDCfx2rjn42JyjKvMtoR8PbdB0MQApnjUUj9y1wwGoWKEMIcVmQTs0QJMmaAdGL4zlwDjKhkJBSKOGLGIGDIeGlwkQgCOG/NthVyoX8TABcxCYAvCahypgTc5CgAVcDYEElIskiELhhuA1/g3K1YG62LKmK0rmc0qBwlkYu/aAouy/GcAg6IczODG6bHXaNW34IaGSQlhrtr/WnIh0kpfqZ+uEzBsflQpG5jQQ9il+gNSQB1DKKFeBK8i2aXLBCKkcvU3hWCBEYJQkOX+GzGfCI8YjYkcziayQzyFZ29pipA0/sbCwvwjXW4X6vt3VhjwJDwBYaxECcx/H1j9L+xYDoVSY+mYbmEHQCWxGTO0giD79w9JNf3N/ixePwHDpgvhx71Y7ZnvmTczIz5teZ6k/9YoxEdi0SNQKLCOHEFbI27sgUknxlM2RuxC8wHF5eng6sPo5OL0+Gbq9Hp+/7wqkCDiLFAUto4W+cLB5T6wtxT3OT8L1JkdautrtPNT+9k2vbU6e43Wg0okbVxy95vuQ2bunXX7tKu12m36m7HbRhSyISJkEtN9cfR6/7J0VX/4s3odDC4GMAGsMRcZWLjdchF0MXGxJHCt6nvi7kNCaUvU+A6zUf70LD3bIdCANq5aDn58ObovH+czUOm6OGDWqvp1jvjrktZt93et4cv0zUiDCFrQDm9zvFFxtxkr+2zcKKmerLZrhemMJ+MQUrp/ZszpTJm6vdEefaBpsFao9eei3CP1OtkyCLSqDWapNE8bNUPGw3y4vxKLw2Zr1emERwn2iojT1Ijp/FzrVKrp+EgGZ4LIyUKIQDaI6d83AR0MdpESru2fwA3A72nYWEDi9zOLHQjAVeMNPgOs5xKpF/YKbsk0ApsWAETJq7nQ8XXlwXDuTpr/jv+/WwyT95fjC9+aZx9adPp25ev4sWnk9f0/dW7T0K8PFC92nz/l0YP/r+iif9iqBa1sxefw/qleCkuFo1X8uzc49Mvb1zv6I5/vuscB5Ox6wfzV72D6ecgarKrcfvgLprUa6/fn/mDCR/eDabjd+ed5YehJw6O3weXPSeL7tQoEymS6MctB6ccHGlZ8KSamxmosw7YFHBjrK2b3aP1YuBoA8ffm/VWE29ov8GJ6fiJy4bJ+ETATSeMf4PDjfmCupodllJNKSSfcAgiOHFYpOzTEGooFHS9aGHng9MWuribzAhFHHLPS5excCaWdhIhlqWBjVpwh9mKByZMu/Vs4WyJKsAc4gsWprpmX0ba+VtrwaaKoSwenyTmVv0AWRUy/BHSTCBdEvUxgAJDThl7Qj1KD4U8qfYFgLalHQlTqjh1a43qNBnjQwvlVo3acEAulnYbylj3oO202nZ3EU8bW+xmHNAW9e0p3BVMnq/FBY7gU2XniqPNd6yOGy5gIEBvAVc2XuglHGF2gBdbCBhAOcZ9dYiR2qN0EE3ZqkfXwAEOUaUjBR3cfXSh2dZfphy/ua7MOSVIHwz9gF20+TVRo1fv7TcP2s12o9Pq9tpH+8dNyL3G0Um9fdA7qDVPTo7rvdNOp7b9gRxf3ej7LPgbAHnw6J1nGwgN0+cdKRhClEJoHAuHI7gDbKOmGhTp6SKoOe8Ph/03L0aD0/++7Q9OT0Zn/dPXJ9YGgH5r/yMylpwhjlqPIqzabFdGXsgOV2SQ7TuQ19fhE1qtdFvLUOQTZnvCbE+Y7QmzPWG2J8z2hNmeMNtfg9nKkM3qHZ1oQHU6vDInUe5J37exzG3u6V/6OE0/0/u+luJDz5LLTwthzW35CaM7SnfA5huVaOu/4DHeN+Ht48BzlX8qupZwZT5bz3m1ToSue/EBU1OBTXpspaC4VE3hW5Vmvfm9tM6avjwcQLl+IqR2Zd1T5KLqyKA6a2xB4TUM1x3ZXCt6iOjXGCbXkN7YNuKvGBp33UfP1pQ76CXofdnHp8/4pFkDGcDgM6jm4Ab9WNtgHY3EtUBgJIQOg00H/DSDzPmOdXGPcqM532dOm8drucsN4Uf6wabHm2vxPtK3LbRt/++aaKV+2U+3iDadoO9r7zzQ3Sk2bcpdE50lPPQEOhkD3Ti4Vqm3K91cgXob6i4OOR6cpx7HAx+QIdJlnk4dhbe0wNy0XOHE/8k7EOaKWVSY3MrYv8OH9BGWu4lBofDvHfNhMct6KZloGPjPQL7ncKtwkgDAiA7QCvkgEuJAFCQx0Ex5rFcC8RyyUHMJEl9xDFKYla4dUazEWVMm1jdlHuq9UP3sdlFBWa7/4Gye9YDS+6wHt21YePss0xGtUCmEcQRnNywLqobSNpQx1pDnmu3frgdJiK/aXEJ8BjTcMJNJWAH4FIRYc8aJUqBiPJs836yYz+eVyJDpzbKdq3MhP8cRnHHrITtKxnCFqGJLawaa6M210Xs01hWCvB28vgk/fvx4E3698KWLsncHYPNcaGxV3offcVFsodA2XLPRgXKfFuVri+ZemEJohGP392OQ8630Vyschhom9Us9ewhbuWlhXuPRmRZL/RiAxzjhZtfysizrnpf1bJAej8/Jn/mq1IPK6uK/9cqXhgMwbuELVT8sePn1qK8KUH5bqyCCWXScYv0r80pEtmKrQ7ihMHeGr669zR3HlxfDK3wzJn0fKzDFWdI5vtsFPw+tG/in28n6oqHPKhy/t3waThJT+AxfLHA0wRDKH63mHE3/wKjIpsJlTsr8mWsUwZ+o1oPL/4n5Aof2v9bLzcyjBOsj3KzmGuetVv8DFqK35w== +api: {"operationId":"createAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/create-contact.api.mdx b/docs/docs/api/v2/crm/create-contact.api.mdx index 51b49bbc41..b83ed9f390 100644 --- a/docs/docs/api/v2/crm/create-contact.api.mdx +++ b/docs/docs/api/v2/crm/create-contact.api.mdx @@ -5,7 +5,7 @@ description: "Create contact" sidebar_label: "Create contact" hide_title: true hide_table_of_contents: true -api: eJztWntz2zYS/yo83nSmmZoS9bSkXu9O8iOjJI59ktMmZ3tUkAQlJCRBg6Bk1aPvfrsAKZG0nMRpOnN/WMnYFrBY7C728cPj3uQxFUQyHo09c2C6ghJJj3gkiSvNA1OSeWIOrsysJTFvDsyEuqlgcg3t9+adRWJmfaL47WYDvTERJKSSikT1R/AF+N5ZbppIHlJhMQ/4sggaF5R4VMC3xF3QkJiDe1OuYyRPpGDRHHroHQnjAJvC9Y5Fw9wcmB5NXMFiFB26LxfUyPuN8bEhF0QaacRuUxqsDebRSDKf0QQ6CoQsMtY8FQaJ44C5ygwwqaC3KRMU7CFFSjcHBS1iwZfATFiq5Vv0SEhAE58Ll+5XIp/ByGaoCHOjW2giR9xb41RlggPThaUCbbGroFb9Y4JT3D+UkTsfqVprmBl8QYKRNFuXC+/LdD4TiZxpAz3UO0qDgDiouBZuZ4eXlIu5skFAvonBeySA4cR1eRrJGfOeNr7b7hw2HN+32j1KrHa727f6PrEtShvEdojT6jme4u95giaJ1jZjT4Qga1x+ScPkyzbKWMw01R7viNIQoywWLCQCGYeEBbqPg8OibzksyFqSBYtj/PMGpHNVID5F7ymJjFNBIpclLkcFlfnEE7m8mw5xbMwTSYKZy70nrl6/3bAPkQOMl08cezTUAwWlctZ42thOs2OMQPuIRAUmzScxwY7NphiaV+UlzpZlZ9qyoXKlCzoUJMFV3U51VXWe3erna19Z0MJ6wiJVZs7tvjU72rJoypJ9iuZROkPykUwqO+6iAsVFd519h0ApMfp8Hl3QIOD/TtKYzIOU1lwePpDkCfG24uLTNthuqotbFmvvLNVVq2iyT9z90mpRiqauWhfDbsEjOgMtHFVnv9XcRTZPC6OfGu1Gp9FstTvdw6pAT0lzHNIaBoJP7h43f0nMfXNVjV/WqyzsXlm3IhXtXjYyTMFXEYx4ap3p+y3aP/Q9q+114Af1Xavf6XuW41DHJ6592Pc7qgwyn7prN6AziM3516XEzKBJ6iCM0OYJAI2oCiI+UQnjblMSIPTxsg4FQKqNPI65kICXdNrK8BGu2ZJEcxqwRO7WZ2eiqsybfOwMeAfeXhcER2aISEhwUXBGrVAZDh0pVsbOZw3JDYcCakvgO/U0yCOCGhGXhsuXFBzGcNYa4/Ew5JGhp60Z5+q3AUA1MULga4REugsDlsmVABCBsR4kIMhiHnlguB0UG16Ma+ZO67KK6K3bHgWfZ2ns4S83g9FVf86gVclri4CrCKlynJTBJGDHlrBIMwIAz2zazaZlN62GfWnbA/X/v2YJUGmUVAZJX4l88INyozmypN60VbWtrJLW0tC6e+Z3Q6BUCP5nsptHJSTOfXH0EHX7EFmGmtAIIcuCLxu+AN9DpxA05JIaF5k31AwcoJUwSOQZAV3SwOC+oSc0VoDUjCVkE3TF7ahS8bq/NrEeX5uDtm0fXJsOYHn4As1Yl9ME/r7W+l+b0J2JpFqzoFnDDFBIEmNFM/+H78wbGFf31/gxWfIrNugvA58ECT3QX3Juukf/2nK9Ln7M2Yw4PJUzkKjUbngcpsZZ6R2kBt2Ysddil5hPzi9OJpcfZsfnJ9O3l7OT9+PpZWkMOmtpSGXinC7gLij1B/VOcJKzv0iRzY2yukoGQbY3VrYnbr/d7DQhgdtOx2p3vKZFvIZn9UnfP+x2Gt6h19RDIRLmXKzVqF+Hb8bHw8vx+dvZyWRyPoEJgERvGhO96hCeoIuFgSN4YBHACisLAkptW2HpFB+1hpq9b7kEHNAqeMvxh7fDs/FR3g+Ropp7dqflNQ6dvkdov9ttW9NXGQ2PIogaUE7RuQHPmevotQIazeVCdba6jVIXxpM2SCW8f3YXRCRU/pJK3+qpMZgJFe0Zjw6MRsOY0tiAxNUymq1BpzFoNo2XZ5eKNKKBosw8OEmVVWa+IFpOvc52zW5k7iAoVq2Z5CUXAO2RU9FvQnI323lK1273bHuj5tQsLGBRmJlGXsxZJDPnG+QxlYqgNNNCyjgZ1OukBhPWwISp5wdQjxDe1TXn+rL1r+SX0/kqfX/unP/QPP2jSxbvXr1O7j4evyHvL3/7yPmrnhzZq/YPzRH8f03S4OVU3tmnLz9FjQv+ip/fNV+L0zOfLf546/nDW/bp9vAonDteEK5ej3qLT2HcopdOt3cbzxv2m/enwWTOpreThfPb2eH6w9TnvaP34cXIzb07M8pc8DT+dstBDYaCmztPprnugTzrgk1hG5Eo6+YnRooYOFrA8ZdWo9Pq2rb9M9RzN0g9Ok2dYw5YN0p+htJLA048xQ5TqRrJBZszcKIh+EUsrZMIcigkdEV0ZxWd0+IquevIiHgSMd/PyGi05GsrjXFrQ0ILtWAutSQLtZv2Gznhco0qQB+iHxpluuZfZmrxH9CCTSVFWXw2T/XB2p5hdYjwR4bmAqmUqMoACgwxpe0J+SgrCsWhai0AUq6tmOtUxYhnN+uL1MHjOenVtdpQIO/WVhfSWL/XdTtdq3+XLJoP2C0ZYEESWAvYOuo434oLHGFNpVVIjhZ7YnbccQEDAbYMmbQg2kAHmDPEcw5wGMBgevka4CP2o+PAm3KqR2kE7qAi5Sm4wP1HCfW0wTrj+EW6KudsQHZA9w12UeZXg5qjxqjd6nVb3eZhpz/qDttHLYi95vC40e2Nenbr+PioMTo5PLQffiDGN9fqeAPWG7YL4aM7sodAaJrtUDMwhCjFIEnCXYbgDrCNXChQpLrLoOZsPJ2O376cTU7+8248OTmenY5P3hybO3j8pfmHhiMYRRy1bUVYtZuuiryQHVLkkO0rkNfn4RNarbKXzFHkM2Z7xmzPmO0Zsz1jtmfM9ozZnjHbX4PZqpDNHA2PFaA6mV7qSlQ4h/wylrkpnE1mx2nqTO/rrnb3nXRXzzKB5qZ6/unNshmAdkUE2vovOMb7Irx9HHhuime2Wwk3m+zMs3K+qXQy3O2biJDKBcdzVLxZQ3GJXMC3upu/kTjI8qx+AQEFCO9/8rITs9r2FojxuivC+rL5AApvYfjwYqwuJfJ0PEX0qw1TeHqxs23MXlM07vbFQk5TfatQgd4XYzwbx3NwBWQAgy8hm8MyqEN3jXUUElcCgZEQOkx2LxFOnniQ/WePp0v38v93t6QPLkS/z41g5drvT9907S60vu6Was8lVfnuqXr5o8KJRT5Hb8CI0N5m1xrdWr+Qyd5F6jLKOJqcKQfTdwgYboPt45s8JHIrQZPH3aRqwXK4Ve+Hy17/d/gYY8TvXqrhKvz7jQZATPMroVw0jJAfQb4XsP1w0xBQiyqkNeMDTw0XnCtNYMyCJYoSBq8gXBWXMA0kg9jAXuFZMcGUnd8tJWpLzSI1F6qfb0NqKMvVr4yu8qusbOPrw7YcCG9+zHVEK9SKitZjKPJAFtb1SEuPTDDZvFBs/3Y1SSN8/XQBbh+SaMdMpFENcFYYYXJyUilBxWQ5f7GjWK1WtVgPU5PlM9fRTZMYiuG2yYpTB/YadbyZW4ImanJl9BFJVCox3k3eXEe///77dfT5DJkR5W9OYPKCazxI0aVl3iZHSe8k2oYpNspR7rPsfWW6hRduiKGw7f7eATnfiWCzwWZIdkK9cztAfMv0TewV1tgsq6rzApZgh5fv36uybC/HzB8nWR19YXzP12t7lVVV4sErPIUboN3EN27fLHj1xdpnBag+oCuJoImOsk3BpX5Kk1M8uErcjdCbi8/S3hTq9sX59BJfVGUP6EKd8wVZ4XM7+Dkwr+GfuhVXOxJV1LD9HmpXNE914tN8McGRFF2oWIN1wc3+QK/Iu6J1QcpicdaK4E9Uay/5PzBeoLr/c0uuex4dsK31mpopQLjZ/A8FpkiJ +api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"example":{"record":{"first_name":"George","last_activity_at":"2022-02-10T00:00:00Z","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/create-lead.api.mdx b/docs/docs/api/v2/crm/create-lead.api.mdx index b0341106fc..96fa33578c 100644 --- a/docs/docs/api/v2/crm/create-lead.api.mdx +++ b/docs/docs/api/v2/crm/create-lead.api.mdx @@ -5,7 +5,7 @@ description: "Create lead" sidebar_label: "Create lead" hide_title: true hide_table_of_contents: true -api: eJztWntz27gR/yosO525zJgS9ZZ8vbaSHxklcexKzl0ytkcHkqCEhCQYELSs8+i7dxcgJZKSkyjNTfuHZY9lAot9YbH7A8BHk8dUEMl4NPbMY9MVlEj6hhLPPDIlmSfm8Y2Jj4l5d2Qm1E0FkytofDQfLBIz6xPFp7s19MZEkJBKKhLVH8EDcHyw3DSRPKTCYsiURdC4AI5UwFPiLmhIzONHU65iJE+kYNEceugDCeMAm8LVlkXDXB+ZHk1cwWJUGrqvF9TI+43xqSEXRBppxD6nNFgZzKORZD6jCXQUCFlkrHgqDBLHAXOVA0CooJ9TJih4QoqUro8KVsSC3wMzYamW77EjIQFNfC5cut+IXIKRSagoc6dbaCJH3FuhqDLBkenySIK12FUwq/4xQRGPuzpy5yN1JUgCyRAFEpyk2bpceF+nc3kYk2i1z+goDQLioNVas60TpmlM5kGqXOAzkciZ9vAhPF5SLuaKQ0C+i8F7JMDhMH2zBMLAPZDB8GpsjAI+n8PkAx/JZLCXw3bECbfOeRp5egDMAwtmxPMETRLtzWwoEYKsMLwkDZOvz0GJ0Zc1WNAg4P9KMv/XYPZ2NJnp0Xu4RGmImSAWLCQC9Vty8Qm+OCwqYd6t18VwvamotVfK3bqg3M2OJfvU3a+tVgWXRzYNO94FST/A1Yf7CNXQfdpNR6bDgqwlWbA4xn/RD67KqQctIxIZ54JELktcjga6EFxSHMjl3XSIY2OeSBLMXO4duAwG7YbdQw4wXh449mSoBwpK5axx2NhOs2OMwPqIRAUmzYOYYEc1bEtTnE3L1rVlR+VGF2woaFKN7krIbmY/n/vKhBbmEyapIjn3+8bt6MuiK0v+KbpH2VxYKKUlwpcRFTPmHRgCfosOer5ntb0O/KG+aw06A89yHOr4xLV7A7+j4zO6h7VEvRlWKeLKgyURr90adEBI02n2QJLbspxWn1i2S+we6XWh2ylLIq7y4sGSmrRBu/1Gy7LbnYHV7vkdC4S7VstrtHquTRu+5ylJCkzMAFwE3t4EAv5lWIJJcFVIJVpcuf6fKFbGNuMYkhsOBZiSKFs0qiGCGhGXhsvBQmh0VhrU8DDkkaHF1oxL9W0AMkuMEPgaIZHuwgD7XAmICBjrQQLmPuaRB+7YYg+obDVzGyFlE9frQo9CirM09vALK6lZXU4ZkCithSK82ACILSoog4K80pcKva7eleJdqshbJYtVFz+oH9qcFYKmrRJPeSoQ7RraOs/8YaCKCsHFf1F9PCqhmuyL410g6UNkG0qgEcLyJnNoEhBdOO2ChlxS4yqb75qBA7QRBok8I6D3NDC4b2iBxhIqlnEP9QyDbTOqBCweb03MS7fmcdu2j25NB+ApPEAz5qc0gf9vtf23JnRnKqnWbFmsQALMfmIsaRbh8My8Y+Pm8RY/Jkt+xQb9cOyTIKFH+iHnpnv014brbfFjzmbE4amcgUaldsPjIBql0geWSN2Ysddql5hPLq/OJtcfZqeXZ9O317Oz9+PpdWkMhmlpSEVwThdwF4z6g3pnKOTiTzJkfae8rpZ7kG30lO+JO2g3O03I17bTsdodrwlZruFZAzLwe91Ow+t5TT0UVsKci5Ua9evwzfh0eD2+fDs7m0wuJyAASPQ+KNGzDmkXbLFw4QgeWARw3NKCBaV2YjB1io+aQ83et1wCAWgVouX0w9vhxfgk74eVopr7dgdycM8ZeIQOut22NX2V0fAoglUDxik6N+A5c716rYBGc7lQna1uo9SF60k7pLK8f3YXRCRU/pJK3+qrMZjrFO0Fj46MRsOY0tho2s2W0WwddxrHzabx8uJakUY0UJRZBCep8srMF0TrqefZrtmNLBwEjbmQM8lLIQDWI6di3ITkYbaNlK7d7tv2WsnULCxgUZBMIy/mLJJZ8B3nayoVQUnSQso4Oa7XSQ0E1sCFqecHUHEQetc15/p965/JL+fzZfr+0rn8W/P8jy5ZvHv1Onn4ePqGvL/+7SPnr/pyZC/bf2uO4Pc1SYOXU/lgn7/8FDWu+Ct++dB8Lc4vfLb4463nDz+zT597J+Hc8YJw+XrUX3wK4xa9drr9z/G8Yb95fx5M5mz6ebJwfrvorT5Mfd4/eR9ejdw8ujOnzAVP4+/3HFRZKKl58GSW6x7Isy74FOBUorybH4IoYuBoAcdfWo1Oq2vb9s9Qsd0g9eg0dU45bACi5GcorjTgxFPsMJWqkVywOYMgGkJcxNI6iyCHQkJXRA9WMTgtrpK7XhkRTyLm+xkZje75ykpjhHgktNAK5lJLslCH6aCRE96v0AToCyAz0CizNX+YqcnfoQWfSoq6+Gye6lOiPcPqsMKfGJorpFKiKgOoMKwp7U/IR1lRKA5VcwEIcmXFXKcqRjy7WV+kDp44Sa+uzYYC+bCyupDGBv2u2+lag4dk0dxhd8+ETElgLQBC63W+URc4wpxKq5AcLXZgdtxyAQfRgIVMWrDawAaQGeJ+DwIGUJaevgbEiP3kOIimnOpJGoG720hFCk7w4ElCLTZYZRy/SlflnA3Izpy+wy/K/WpQc9QYtVv9bqvb7HUGo+6wfdKCtdccnja6/VHfbp2enjRGZ72evfuBNb6+Vds8mG+A6+GTG/BdIJTDygwMIUoxSJJwlyG4A2wjFwoUqe4yqLkYT6fjty9nk7N/vxtPzk5n5+OzN6dfPOwpyx8ajmAUcdSmFWHVVlwVeSE7pMgh2zcgry/DJ/RaZRuao8hnzPaM2Z4x2zNme8Zsz5jtGbM9Y7Y/B7NVIZs5Gp4qQHU2vdaVqHBU93Usc1c4fcyO09SB3rfdVu47BK4eWALNXfWE05tlEoB2SQT6+k84xvsqvH0aeK6Lp7IbDdfr7MCzcs6sbDICfcEfUrngeO2P1wuoK5ELeKoH6sL/KMuw+jofSg/eyuUFJ2a1zd0c43VXhPX75g4I3gDw4dVYXdHliXiKuFe7pPAewdarMXtN0a2b6/ecpnrxXgHdV2M898YzbgVhAH3fQx6HCVAH6hrlKAyuFAL3IGiYbK/Vz/7n59R7Lod/zO1omeH/14XU9u7p2y6UnrpP+rZLoqfuiL7t4mf33ketMxb5HIMFF4wORrvW6NYGhVl+F+GLKJ5xMrlQ8acvF0B3HJcFTSHC1HRCk8fdpDrV5dVYvdQvL4q/wscYI7D3Uo1j4ec3GgAxzW+DctUwPH8C/V7AvsRNQ4AzqsLWjA88NVwIiTSBMQuWKEoYvITVrLiEaSAZLB3sFZ4VE8zl+bVSovbaLFKy0Px8f1JDXW5+ZXSZ32JlO2If9utAePdTbiN6oVY0tB5D9QeysK5HWnpkgrnohWL7l5tJGuGbPlcQrCGJtsxEGtUAgIUR5i4nlRJMTO7nL7YUy+WyFuthSlguuY7rKYmhSm6arDh1YBNSx0u5e7BECVdOH5FEZRrj3eTNbfT777/fRl9OoBlRfikPwguhUc7dpTneJE5JHyQ6hikeKkoes7R+Ywb5e1wIq7Dh8dEBDd+JYL3GZsiCQr3NdYSQl+nL0Rssu1m6VUcILMEOL9/SVxXZ3JeZP02y0vrC+JHvaO21VJWPnXfNFJSAdhPf5PpuxavvZX1RgeprYiUVNNFJtk+41m8Z5BQ7t4vbEXq/8UXau0I1v7qcXuPLJtlrYqHO0YIs8aUy+Hts3sIPvpaiNymq2mH7I9SvaJ7C5ghoNF9MbSTF+CkWZ12Js38wKvKuaFXQsli1tSH4F83aS/53XClQ9v+xIdc9Tw7YgABNzRRGXK//A6EN33k= +api: {"operationId":"createLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"example":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}},"responses":{"201":{"description":"Lead created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create lead","method":"post","path":"/leads","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create lead","description":{"type":"text/plain"},"url":{"path":["leads"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/create-opportunity.api.mdx b/docs/docs/api/v2/crm/create-opportunity.api.mdx index ae33bbb24c..bb6659249e 100644 --- a/docs/docs/api/v2/crm/create-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/create-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Create opportunity" sidebar_label: "Create opportunity" hide_title: true hide_table_of_contents: true -api: eJztWnlv2zoS/ypcPTygBSLfd7e7m6uF26bJ2um1SeBSEmWzlUSVpOK4gb/7zpCSLTtOr30F9o84gRORwxnOcI4fSd06ImWSai6SYeAMHF8yqtlpmgqps4TrhbPnaDpVzuDCWbdyppyrPUcxP5NIM7i4dW5cmnL3M8OnqyX0plTSmGkmlelP4AEE3Lh+prSImXR5AMx5Ao0zRgMm4Un5MxZTZ3Dr6EWK5EpLnkyhh93QOI2wKV6sWdSd5Z4TMOVLnqIO0H0+Y6ToJ8MjomdUE5j0l4xFC8IDlmgeggLQUSLkCVmITBKaphH3jT1AqGRfMi4ZGEbLjC33SlqkUlwDM+mall/RQ9GIqVBIn+1WopBAcglbk7myLUzpAxEsUNQmwZ7ji0SDtthVUqv6SaGI27tzFN4n5muQBJLBKcwqG7a+kMH36WgsMistp+MgfmrMkWRRRD3U2s5sZYR6DT+gvh8JxSYB+N4uo9073mnUGg231nDrtfNabWB+/3PHnD/D8B1NNPiGIJliBNRLiAK/8Bm6ELhNQPbPhgRWDdyHy8AFJ9fgVaipjSKF0q2X/IzY14wFigy3+CgIvZ2M1gMP0XABeQd6wgDq+7gIEx78nPhOq92te2HotnqMuq1Wp+/2Q1pzGavTmke9Zs8LkL+YJ0z+NPd+2GT9bhi4raANXyz03X67H7iex7yQ+rVuP2wj95SnLOLJD5gOPcaE7gTWJArULu+kQcDRkjQ6K/mpndtmtB0aVmTtzrj+HoNlVfAM1jU5hEpGEqGJL64ZRBnxFjaFiDgWCbFiK+TU/CWQBxWJgS+JqfZnBIzha8g/wNgOkpKpVCQBaLeOdPCtCiZcro3dNlVcLks9Jk1PshQjZiJK6Rqp1ongoojeq2VpQcoxXUStjcTNQMToamJ0Nbql6Nq23v8eMUXA7IqCVRCUPX3T0Z16re/3en7N7Xphy235Qc+loee7Xrse9lvNhg8+DIZZWtug2ZVNWY1aHf9s6lMqfsTaGevUX5RMmZRClt2VSkmxyHLN4p1uvDk+YJryaFeA3C0gIYQMMQJJzJQCK5JQgp+jA0oWC83IWe55FYIDrBKEJgGJ2DWLiAiJFUjmHHhdU7lAt1+N2shEt5dgpIBdOoMWONKl40FZggdohhXUmYL/L63+lw5051MyrXmALkBCBBWNzFkea/DMgwG5uL3Ej8PVW2ywD4OQRort2YeCm+2xf1ZcL8sfZzKhnsj0BGa00U4CAaJRKrvhStvGnL2d9gbz0enZ8ej8w+To9Hj8+nxy/H44Pt8Ygz69MWRLcEEXCR+U+sqCYxRy8psUWV4Zq5vEE+V4z9ie+v1Wo92AlFzz2m6rHTRcGtQDt0/7YbfTrgfdoGGHQiRMhVyYUW/3Xw2P9s+Hp68nx6PR6QgEAInFP8quOoQo6OJi4EgRuTSKxNyFgDIIDJbO8DFraNmHrk/BAd2Stxx9eL1/Mjws+iFSTHOv1m4G9a7XDyjrdzotd/wipxFJAlEDyhk6k8uKDoxeN2LJVM9MZ7NT3+jCeLIG2QrvJ/6MSsX000yHbs+MwfRoaE9EskfqdTJmKcFkSRrNQbs+aDTI85NzQ5qwyFDmHqwyY5VJKKmdp13nWqVWz91BMkw/Ey02XAC0R05lv4npzWTtKZ1aqwdIysi0LFxgUZLMkiAVkHZz5xsUMZXJaEPSTOtUDapVWgGBFTBhFoQR1L4KFLqq5Vy9bv5TPX02nWfvT73TPxvPvnbo7M2Ll+rm09Er+v783SchXvT0QW3e+rNxAL8vaRY9H+ub2rPnn5P6mXghTm8aL+Wzk5DPvr4Owv0v/POX7mE89YIonr886M0+x2mTnXud3pd0Wq+9ev8sGk35+Mto5r076S4+jEPRO3wfnx34hXfnRplKkaW/bjmo91DcC+fJNbc9kGd9sKmkiTLWLTY/hhg4usDxabPebnagjj6BAudHWcDGmXckYgpI4gmUeRYJGhh2mErNSCH5lIMT7YNfpNo9TiCHQkI3RDdu2TldYZK7jYxEKKiuYU7GkmuxcLMUJslo7KIW3Geu5rF10369ILxeoArQF0FmYEmua/EwMYt/hxZsqhnOJeTTzBbmHcOqEOH3DC0mZFKiKQM4YYgpa0/IR3lRKA81awEgceGmwqYqToNaozrLPNxp6qBq1YYCebNwO5DG+r2O3+64/Rs1a9xhd82hqNPInQlIiSbOV9MFjrCm2i0lR9ic/lx2XHMBAwGKjbl2EeRIKGFuDNWTg8MA3rPLZ9DWvePAmwqqe2mggINXGU/BBe7fS2jFRouc43fptjnnA/K95i/YxZjfDGoc1A9azV6n2Wl02/2Dzn7rsAmx19g/qnd6B71a8+josH5w3O3W7n4gxpeXZo8D6w37gHhiAdCPAKFxltIpAIscDCFKIVQp4XMEd4Bt9MyAItO9CWpOhuPx8PXzyej432+Go+OjybPh8asjZw3Fvyd/n3iSM8RRq1aEVWtx28gL2SFFAdl+AHl9Gz6h1cro/2KNIh8w2wNme8BsD5jtAbM9YLYHzPaA2X4PZtuGbM7B/pEBVMfjc1uJSmee38cyV6Vz0Pw4zZzr/dgtxa6z6+0zU6C52j5rDSa5BKCdU4m2/g3HeN+Ft/cDz2X5fHg1w+UyP/fcOvE2OhGxcc8XMz0TeJ6aQrjhlKmewVNVbNz77eUJ197qQSXCe6+i/qS8onKwXeGi6su4et24g4lXeHz/bIhlYHWROEYYbC1Uuk5cGznlL9lifVy8ptm+f9vC4GdDPJDHM2qDaACMX0Nah/Uw59YW9BhIbiYE1kIMMVrfrh3/ysn53Xup/7+T8x+69ylf+/zYXU75Kme9Mdq+sTF+yZNQoDXRo6xVapV6p9IvpYQ3uTUORydmgexhPGAxHJfrX7gU7otiu7cJhK/+tfJGQELQt+muG513YuQP+KBFpQgyi/vg5x2LgJgV9zhvSgv1COb3GHC8n8VQ/s0iVMgHkRGfJmaFYRWVoYTBc3B3wyXOIs3BtzbWuLgQUmZvyhMjC9Uv8HwF53LxlrN5cf+U7yDRW4Dw6lGhI1qhUla0mkK1BLK4ake6dqTCYH1s2P7tYpQleCN+BnkgpsmamcySCgCWOMHg9jKtQUV1PX28ppjP55XUDjPCCsnVuZCfVQpVZdXkppkHoL2K12nXoIkRbox+QJUJRfJm9Ooy+fjx42Xy7QyTE5n0aYWXXGNnrtt9P6zZjUb7cMPKOMttngYvHLH9+gOiEuy4vfVgwm9ktFxiM2QNaV6C2EPEyO2l5QVWrTw9mR04V9gRFDvi7QmtrpucR6O8Mj0mf+WrDTs1Nun2zisaphJDu4MvQPzyxLdfZ/jmBLbfrtiYgiU6zGH2OfJZU9y5nFuPsHD9m7RXpSp4djo+B2Ivf7siFgGOkXSO72LA98C5hB/Mjhbjm+qA7bdORJNpZnOv5YuZjmboR+ViZitX/g96RdGVLEqzLFc5qwh+o1o7yf+OgQNl8h8rcttz74BV0bTU3ECs5fK/gt1Ekg== +api: {"operationId":"createOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]},"example":{"record":{"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"109c88c0-7bf4-4cd8-afbc-b51f9432ca0b"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create opportunity","method":"post","path":"/opportunities","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/get-account.api.mdx b/docs/docs/api/v2/crm/get-account.api.mdx index 7b7c84cfaf..629b213945 100644 --- a/docs/docs/api/v2/crm/get-account.api.mdx +++ b/docs/docs/api/v2/crm/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: eJy1WG1v2zYQ/iuc9mEtFtmK48ROMAxLs60I1g1F0qzb0sClKMpmK4kqSdkxDP/33VGS9WI5i5M1LRKbPN49vJfnSK4cmXJFjZDJZeCcOVNuzhmTWWKcA8fQqXbObp1iRDt3B47mLFPCLGF85dy7NBXuZ47f7tYwm1JFY2640nY+gS+gVCQsygI+UXQxCaihoFokMP4l42oJXzSb8Zg6ZyvHLFNc4EsZcZrAFL+ncRrBmFEZXx84AddMiRTxgtz7GTczroiRpLBBwAZBGyTkBtQGJFQyJiBFjlRAAJ9ZklTJuQi46jnrgw3Ie5dl2siYK1cEJcIZpyDXBVEbJZJpHaETLysVh84W2HeAoZwnlz8DJmpIlgjwQrQkgCcxIhRcW7AbQZGQpcwUoWkaCWYDBUYV/5IJxYPSL7VdlJtz7chT9qFpxHUoFePdmygtkMLCTjA0z5tJ5c+UmtnWiseh8gbHY+azE/fEG3ju8Mij7ng45i6lIWU+DcIhBbyYhIrrVCaaa1Q48Dz809xFleJMJgYcjyI1D/c/aZRbbQOT/ifOcCE4AQrHiNwKDQKwWpgsRKlSFLNbGB7rR6uY5FIdnkiyGIsxVSKmtmxiKqJ8TmIVwF9fRMWInok0xY93EEJm63VbZZJFEfXL6qo7+5om5FdFEyY0k5gF1l9qTy031+e4NpXa0GjCZNC5sd3rT4eH3gg1wHqz59qL83yh4txMDvdbezw4Jq9g9wlQUKVksJcSnFiv66l+2wxxEZbKtU1HlZuu7aGGBKO6MXXbTp4q+mXsWwGtxROC1LJc+n3jdvRl3ZUN/9TdY/cMBWiEsX6sqqLNI/tE4xIqdJq3KHL+9hJ1AaE8xBWHg6MhSiUBsOi+SQsmvrOAI6rNhDIj5uDCCTWPUQOsGaOkAy2Iu0ZYfqx0D7zBwPUG7mD0zvPO7P9/0FTOl/sVKH4gF0WbsEqy2OdqIsMJhzm55A02EuhFSxI7lQ5GJ57ngSa5SEBRt5N3QwrGjPtHYeiO/VHoDkM6cv1xwIGlTweng/CE0ZNTSwczmfBJjvYZfFlXsx/Q7w+Hh8eYI8cnozagfehXAt1ifEN6v+Hgu3bNN2B22WqXcnNfTbCdWDeQ6qXXdDJmswg5W7KIT6Cqp4/LtmLLOvOxdPMNwLkssL1HfeYG1n3JaITHlqCYsIeH9qBMU6kMnHVywiuTFkzMaTLlkdCm8mC1iTZm2MaC+1rs2wtmxqT6rN/XWUqnUcZ7TMZ929UUhzoNvm5xZ2nw9Y0IPQl4BCfvetF2HKNDGmleklssAxulHdCeBKW75UHJNjuA5fAaRXfQbUGL3cRWI6k2o1RJsp31jZA3QtNwYYd/6m2tOD1WhWsJ6ZfSMytnTiHLWufC7S796vLNm8s/Xj+mSV/8tU+T3tWjyxZ98Bwo+50X/gvKXfuC0e72ebNHAqw39KJLdzXpTV4eerW8LHusc11wwI68KppgvQc6p0ejURgMAzcY4s2De757esSpOxqfeqMxhY/+cCsLn0blRU9Bt9S5Cfd0tFVrTWrZJbNhzF00mP+04/CaG0I31yS4089k8T6A0PEad+b0CwHdX1VXvTXGmKt56YRMRTXbNBW9jX0h+0zF/fnAaVsvo5Qf+GrPDtd4Icvrrfb4UJ0hUvEbX1bRrmTaF+HWhfDtJQEpfEigUSQXJOBzHuFxQ9sxxqBY7MXcArKHy1DaUgeRXIfXOzzpnToVT9wklj3IxdXvRSrjbROSFddtpyPH+xyyrWT6p3qMMNANJzYmtyL3LfwQKCMlg4zh2Af4955HIMxxM7iLEhru+wXge0nAahbDTdhWXo/8LTPCgAMyDWtmQltJWLyAIFgtcRYZgUdQmFWB23xY0WQhYDyxtnD7cK3mU6mWPcRy+6fgCwJwYqjx/IZNoNeg4N2Lco/ohV4jU9OIGmxJ/Xylm6/UmEIvrdpvbq+yBB9M3gI7xTSplKks6aUwlmDK+ZkxsEU9n76sJBaLRS/Nl1ljpeX+QqrPOqWMb4bcNPMjwfoSQj+HnVjj1umvqLYJQm6u3nxIPn78+CF5OO8LofKSDMZrqdGswO7rk+H3Bh0jrA6bJauiOm/LPoU0eVZ7ioFqmoExlFitfIB8o+CmisP5exwWbSA0HkqC4sCwZX7zbPL8J7iD7r3Yuu56OSx6q2NpYU6VyE9Pe4F+cVUcUV6SXfZLQkmWdZslrpo713iAL2jlySj+z7fBB9zZfuOsfHnwDODt98AHAbSfJxsQcqFzYNvU1Oa2XuYw9JuW9PqXdyBLM0z6eiPIWb/4gJHpDGm9Q+Tm8TeC6RT/AcsbWsyPG/F8ZueCTcMpExoTZr3+Fznr62k= +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"examples":{"Example":{"value":{"addresses":[{"address_type":"BILLING","city":"San Francisco","country":"CX","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null},{"address_type":"BILLING","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null}],"description":"Integration API","id":1234,"industry":"API's","last_activity_at":"2022-02-10T00:00:00Z","name":"Supaglue","number_of_employees":276000,"owner_id":"9377fd4d-d420-4e0b-93ea-789078a3eab4","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","website":"https://supaglue.com/"}}}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/get-contact.api.mdx b/docs/docs/api/v2/crm/get-contact.api.mdx index 4923dd3f5d..d3642c7b27 100644 --- a/docs/docs/api/v2/crm/get-contact.api.mdx +++ b/docs/docs/api/v2/crm/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: eJy1WHtv2zYQ/yqc9k+DRbb8iJMYw7C024qgG1AkzbotDVxKom22EqmSlB3D8HffHfWWlSBO2yRIYup497v3nbaOTJiihktxGTpTZ8HMKykMDYxz7Bi60M701slPtHN37GgWpIqbDZxvnXuXJtz9zPDT3Q6eJlTRmBmmtH0u4AMw5SKI0pDNFF3PQmoosOYCzr+kTG3ggw6WLKbOdOuYTYIXfCkjRgU8Yvc0TiI4Myplu2MnZDpQPEG8QPd+ycySKWIkyWUQkEFQBpkzA2xDMlcyJkBFRiokgM9sSKLkiodM9ZzdcQny3g1SbWTMlMvDAuGSUaDrgqiN4mJRR+jEm4rFwNkD+w4wFM/J5W+AiRqSCg5WiDYE8AjD55xpC7Yk5IJsZKoITZKIB9ZRIFSxLylXLCzsUtOiUM61J8/RQ9OI6blUAetWopBAcgkPggmyuJlV9kyoWe7deBoqb3hyFvjBxJ14Q88djzzqno3PmEvpnAY+DedjCngxCBXTiRSaaWQ49Dz809SiCnGECIZHkpqF+5800m33gUn/E7MXwQiQOIZnUmgQyFRYTTuUEGkUUb+I4rpS89A7Ox+OJ6537g/cMRv5Lp2AZqf0dDIajH0/yJwg14Kpg7kPR2wy9ubMnQy8E3dMBwPgPpq4I0on/iSYsNPJELnTMASb5QbL2VOlKOYmNyzWTzBAxmKWUXX4UaQxlpJE8ZjapI8pj7JnEnMY/vo8yk/0kicJ/nsH6AJbbQ7R+5oK8oeiIuA6kKigdY46kMvN9QXeTaQ2NJoFMuxU7OH75+OBd4oc4L458O6ri+yiYszMBofdPRmekJegvYACWjEZHsQEH+x29US9bbo4d0tl2qahCqVrOtSQoFdLUbft4Km8X/i+5dCaP8FJLcmF3Uuzoy3rpmzYp24eqzOUD8ONtWOVFQgXw3X2DRKlwejxirdkUSR/1WlCF1HKeoGM95AckG9rqT6XyXbXdm4TVqeUttdamnTB7UabQambum1dkDTnSptZ1kgOif7XTKqFrZnd1bKkPBmPBkMgiyjIgWbAVxBrM2qeIg6aY4yUDkwazDXctsFa3fWGQ9cbusPTd543tT//OYWow1X6BwmwEi2lYDNwrG/nq+dGYJ3NYUB+GowHJ4PhaHwyOW0DOqTyS6j0aLE5vX84Ihswu2S147GpVxNsJ9YSUj0Um0ZGp/E5CzZBxGZQUBZPc12usk59nDoyBWCgDW3bU5+ZgXtfUhrhvBfmD+zU1T6USSKVgSExq7X5UIhWXVGxYBHXprJgpUQbM7ZAxSBWw+8b4GkSfn8hXM9CFsGSUc/vjo1hTiPNiqyLZWjt+gC0Z0IpF5qOpINqxnGWpNHbWvrZCbndWKvhsTbpNSdvW87qk9p+S2rUzI66Vq8/7WKyH+aNiGl4tuGBDvPW4jBfAGAs3+32VonXzJCgHMRha1zKfANFeLgoTJ1+TqD722qZ2GG2MLUqtsxURdh+jEn0tN+HjbRXNiEu+4GK+6uh05Z+nZOQi7eXtgAUi+01jvxZpaytt1WxTfgbhslYLlwFTXvVasoDMQSocFWl0CdhSWUrFmFgaHsGg77OVj8LCONczCUKRj0zHl5vMOmdO5V9b4S1Onl19Ze9dlxafFouYYWiRcRgkMtAtxt104jtoaOpy4/wRS5hApNhGuDZB/h+zyIgZqgMalFAQ71fAL4jAlLTGHYtu2H1yL8yJQHMdamGO0uuLSVcXoMTLJc4jQyH/MOnKnSbq7smaw7nwspC9WFxYwupNj3Ecvs3Z2sIrjiWgmQ7HIEUR8K7F4WOaIVeXdF+ElGDlaCf3XSzmxpD6Miy/eH2KhW4kr+FiTOmomKmUtFL4ExgyPmpMaCiXi2OKor1et1LsmtWWCG5j9OQTmjAyiM3SX1YRfsSXL8CTaxwa/SXVNsAITdXf34QHz9+/CAej/ucqFhkQHgtNJoZ2PBxGe+G3Rs0DLc8bJRs8+y8LaIN68e0tuxDNi1BGFJstz5AvlGwTeBx9sYHkzbkGntBmNfpPfHlYv71L3mOu3Wxed31bmpFMV2mji0LK6p41rQOAv3iKi/wR+Qh+UVBEZu6zAJXzZw7nHTysvJsFN/y7dMj5my/RatsefwVwNtvnB4F0H4B1oCQEV1AtU1M7dneux90fdmSXv/+DntvikFfbwRZ1c//Qc90urTeITLx+BvBdJL/jOkNLeaXkjx78uCFsuEUAY0Bs9v9D4sodP4= +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/get-lead.api.mdx b/docs/docs/api/v2/crm/get-lead.api.mdx index 6a02f5dbb1..1098424ba3 100644 --- a/docs/docs/api/v2/crm/get-lead.api.mdx +++ b/docs/docs/api/v2/crm/get-lead.api.mdx @@ -5,7 +5,7 @@ description: "Get lead" sidebar_label: "Get lead" hide_title: true hide_table_of_contents: true -api: eJztWntv28gR/yos+0cT1LQkSqIkoyiapL3A6BUI8rhr6xjKcncp7YXiMrtLyYKh734zS1IiKdpn2k5bFHICW9rHvOc3s+TeujLlihghk0vmXrgLbn7khLlnriEL7V5cufhVu9dnruY0U8JsYfDWvfFIKryvHL9d72A2JYqsuOFK2/kEvgA5kdA4Y3yuyGbOiCFAVyQw/i3jagtfNF3yFXEvbl2zTXFDKGXMSQJT/Ias0hjGjMr47sxlXFMlUpQU1v285GbJlWOkU/BwgIeDPJyIGyDLnEjJlQOrnKFiDshntk6q5Fowrs7d3dleyBuPZtrIFVeeYKWES1CbqzYRtVEiWVQldFfbA4mBeyTsR5ChnHcu/woyEeNkiQArxFsH5EmMiATXVtj9QpE4W5kph6RpLKh1ETBV/FsmFGelXSpalMp5duQxemgScx1JRXm7EiUHp+BwpzDgQzY/GDMlZnm0/GEiTX3G/QkNvSCaUm/kT6ZeOJkOPRgfsNkg4IxRd4cRqLhOZaK5RoJ+v49/6ioUkU1lYsDkOF+xbe8XjYtuj6WS4S+cGtgI6kOyGJGzIIwBy4JfsZQoRTCuheEr/WAS83xVixmSbIU5mCqxIjZhVkTE+ZzE+Ie/oYiLEb0UaYofr8F51GbqMckki2MSlnlVtfQHkjg/KJJQoalE/1OZJUZ1pPLpwyvcm0ptSDynkrUqdvf+2WjQnyAF2G867n3zKt+oODfzQbe9Y3/svAbtEwCfAxG/ExGc2O2qcX5Vd3HhloNp64Yqla7oUJEEvbpnddUMnoP3S983HFrxJzipwbm0+97saMuqKWv2qZrH6gzZZ4SxdjxkhY2gVUqSrnGYpWQRZzwnkKwhXTibE2rFR1DpRG06pXQ0osSbkOHIG/Fp6IV9RrzxgA4J4cMRI1ErpxMAnADgBABPBIBa/e3ijUso0Yu8L3VevbtEWu2Zv98y8IcjXJUwaKC6Bi2w+IMVOCbaAAIYsQYTzol5CBlomFa40oXuk3tG2NboQNvv+77X9z1/8rHfv7D//42s8lapW4LiB+dN0SFaItkq5GouozmHObnlNTQSaEULEncS9SdBv98HSnKTAKGu8MqmlIfDKPKm4STyRhGZeOGUcW86mvkzPwooCWYWDpYy4fNc2ifgZZVMN0H/OBgNxhgj42DSFKgL/EqAW/RvRG72GHzdzPmamG28mqlc16subKuse5GqqVc3MkaziDjd0pjPIasXD4u2QmWdhZi6uQJx3jgDw6/cwL5vGYnxxMKKCXtuaA7KNJXKwDEnB7wyaIHFmiQLHgttDhY8KNGUGdTY8FCLrrVgaUyqL3o9XbQT59CM9GxVU5zYOv89kztL2fdnIvSc8RgO3dWkbTlBRyTWvAS3lWTWS3eI9ihR2ksepGy9AlgMr0B0C9wWsNgObBWQaiLKIUiOo77m8ppraiZssU+1rBVdYa1VxJMkSN+9KaWAkRM4yhJ/MPNGLKAAmHC8HbDxJBz7g9EsClo5PaCjfGSfHLH+dOaPAq8/CwfQJw9DjwR9bJsnwXAwCkOaPxR4XJnwhzwY9SPuBYP+2BuRwQCoDwMPWvAgDGjAJ4GP1E8t9amlPrXU97bUHMN1/gyJUiN0/0O4JY9j+ZdqJT2SpEO+baT6enfvVBerlUvTaw1N2sRtlzYXpWrqpnWBUyQUlIXu3fpbLlXev/zGyWU8Gg78/+zZw7LqrtI/ccGpmz9180/p5k/997P33xCv5Qu2lqQDNBPYf5P4XSX97BubZmE9NI+1Xrulia/2+E3QrGFma5N/wJ/jRv67tO9l/1xrqtkDu6Hf9smwzSenSv1/XakfXz7t21EtM3zP2vUxpfM6lotF/vDvcWexwOdj3o8mXsgpg7MY9+HT1Pem4YjDAZSzKfFPRf6/VeSLiU5HNOn9ALDN8qB47vJqoW3Q/77ltZXJ/0x5vefxVvmG845XlXc8LDoqQkVRrZbFKkjc++Arj5hnqZK219vhT/P2x1tunLJv5GYpi7tCKA7e7bhwezire7fFzY8d9pFcrcv7QJmKK89kSSrO96AvZI+qVW/tu02m5Zvg/A1Q5QrSB7yikcNL5SLSAaFS8XeOPtlfjSnXNC/F1PkhvMIqvFREoC5tHMbXPEYw03aMUnC7vaRjBbJvmyKJjFHPnEb/fBCcz9yDTT8l1tLOm/f/sNvO3MqzvELA/SvvovhhfEqqm4WxbsRmka/r8nv4cS4ToyTLKI59hn8/8xgWc1QGtShFQ71fgHwvHeCarTiIhzvOnX/JzKEkcTINe5ZC25WweQNOsFRWWWwEvpOCWcW8+iUr7WwEjCeWF6pPISQXUm3PUZarnwTfOCDOSiZOfufGgezEhdcvSh3RCue1J/hpTAwmcS/f6eU7NYbQS0v2d1fvswQvT72T2qxIciCmsuQ8hbEEQy7MjAEV9Xrx8rBis9mcp/k2y6zk3MPuQ6eE8v2Ql2ZhLGhPguvXoIllbo3+mmgbIM6n9z9+Tr58+fI5uT/ui0XlIz5gXgmNSuK1v0w1/MagVYQlYEPktkjKK5vQiBEX5YUsSKIl8MC529sQJP2k4t0Oh/MreZirTGhEb1Yg6xHj/f2pp9/CO2vXwqZz2+XBNcEsuXAtGqyJEnmZ6ST0i/cFlr907uJf4ogF9j3PUq7SljtsCQooebQIz3k38B5bNu84Hgx59gTBm/cB7xWgeT2xJkK+6BUgbGoqc0f389Dv+wL09m8f8SSaYaxXwT9H+uIDeqbVn9WqkLPH3yhM6/I/YUpDWfnzfnk+c+eGfZEpoxkDZrf7FalavMo= +api: {"operationId":"getLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}}}},"description":"Get lead","method":"get","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/get-opportunity.api.mdx b/docs/docs/api/v2/crm/get-opportunity.api.mdx index 3058ff7247..3d0948dd82 100644 --- a/docs/docs/api/v2/crm/get-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/get-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Get opportunity" sidebar_label: "Get opportunity" hide_title: true hide_table_of_contents: true -api: eJy1V/tv2zYQ/lc47ZcGiGxZdvzCMKzriqHY1hZps2BLg5QSzwlbSVRJyo5h+H/fHSXZkh9p065OkAd1vPvu7ruHVp7KQXMrVfZCeFPvFuyrPFfaFpm0S+/Us/zWeNMrb3sqwXjXp56BuNAkM71aefc+z6X/Eei/6zU+zbnmKVjQxj3P8B/ULrM4KQTcaL64Edxy1C8zPP9UgCZjJr6DlHvTlWeXOV2IlEqAZ/gI7nmaJ3hmdQHrU0+AibXMCTjKXd6BvQPNrGKVDYY2GNlgM7CoVrCZVilDKdbXgiE+u2S5VnMpQHe89ekG5L0fF8aqFLQvRY3wDjjKHYJorJbZbROhly63KnreHti3iKF+zl78hpi4ZRhZjEKyZIgns3KGUXZgN4IyY0tVaMbzPJGxyxga1fCpkBpEHZeGF7Vzvjv5Gj8MT8DMlI7hsBO1BVZZOApGbSl1s41pzu3d3q0vQxZPZmfjYNz3eX8U+INRdOZzEYT+ZNIbBsDDoD8KvTURUYPJVWaQs6gwDAL61fakzfdYZRYTQGKNSHc/GJJd7YNT0QeILV7EYGAlueqgu3GsisyStwccyYok4VHN5qZjMxGMJ+Fg6AeTqOcPoB/5fBhwf8RHw35vEEVxmQyekvqGbomwb11mjyrvBfTBy3GiDFABwpeAQwKkHE15dMG30qV6izgMwr6PoQ9Hb4Ng6r7/3aPLY0JwyTNrqJILAwxjmjGDvI+BSgTLQrCnr18wBIXlIbXwy0p27pd9zJD1w3HfGDkb9HshiiXc2BseWzknanL7HeNRlsJjAvESQJgHvVSLDPSjOSbGMUT92cwfR6OZP5jxkR+NBfjjwSSchLNhzIcT0p7LHBKZfQFqFDY4KB7p3zOioWCXSJBSgS3M4zS8ev38Jd2NNWAuxPdNYJGL729EmhsBCQ5O8fAUnPHEQE3gVAlXGUegfR5KuA9l3WzMV81+tmk+7Rp3NXegoirmN8hak2WT8wbVWrlsxbwVmwOOY6+30iY744ZiWrnquPW8dnvlzXlSQKNX059USh7vh5PgrC/8aDYe+oNoHPrj/tnQn8B4MuJ8JPBCsweXfbXdVg8neG9t+eZWV3a6XtgfHGpmx1BUY/kzDaZKGQpO+lEQhzhkwyEfY0QmoR8N4MwPzsRoOICo1+tN2qk7arpZRcdkql7SahDlZzeAv4NlqjW/cem8U9UmS8SiHWPqdVVzfe2u2gvJmmyCntfbaqETWpWszc2028XNtmOKnN8iXTpSdWOddufhXi7fVCKUM2/dWJDf0MpQsq+xJm/KFE/+gOU2KVuZ3ZWtbY+ogVLEHp4kCpddmENCO4hjFHIUTLlCOkDUW7KZcsRHkVJH0OkNO5S5unIuKt49O//LXSv3IeQU3asA1o5SE0m5pFAJFZtfNjGKVUqJbgWx9XAvjT/ih73IrFaiiOnsHX5dQoLCQM6QFxeNkniC+E4YWi1S3NUcXTvsH1WwmGeulpDTxkni5QUmwWlJi8RKLP4W4+sd1rCFxPPM2SL3cfGDW6WXHcJy9beEBUM4qcIadTugq0sUvH5S+0hR6DQd7eYJt9R9u+VNv7xpiEInTu0PV+dFRqv9a2VsyrOtMl1knRzPMqJcVFiLLpr57clWYrFYdPLymjNWW+4ulP5och7D5sjPiwhX2a7C1M/RE2fcBf1XbhxB2MX5n++y9+/fv8se5n0l5PaD0niDGvvleHgLtHBvKTjS6XFMWVWleuW1ShVVTHfeHrC07tAyia5WEeK/0Ml6TcflayRVsJCGhrGoBuUejs2W/+1vjqeHnXJFfuiFtxo7nusRc65luTU8CvST82o0n7Bj9uvuki2bNmtcOyFdX+ONqs98NZL/87X2gZDuvp5v43n6DcB3X2UfBLD7Zt2CUAo9xfab28azvZdJSv9mWP3+/C3tVQVVQHMylGOg+oMyczCtzZFRmqefBOag+E9U7zhzft6Il0+OXthMoJrURJj1+j8pyyNL +api: {"operationId":"getOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"responses":{"200":{"description":"Opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"},"examples":{"Example":{"value":{"account":{"id":"a329053d-bf86-4b82-8356-9e897aa7dacc"},"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","id":1234,"last_activity_at":"2023-02-27T00:00:00Z","name":"Needs third-party integrations","owner":"93b0c2b5-26a8-4b92-b4e5-05d764eb1119","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","stage":"Closed Won"}}}}}}},"description":"Get opportunity","method":"get","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/get-user.api.mdx b/docs/docs/api/v2/crm/get-user.api.mdx index 4495af9911..fd2c066c2a 100644 --- a/docs/docs/api/v2/crm/get-user.api.mdx +++ b/docs/docs/api/v2/crm/get-user.api.mdx @@ -5,7 +5,7 @@ description: "The common schema User maps to the following 3rd-party provider ob sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: eJztVm1P40YQ/itb9wtIOAmBozSqqtJeRdG1KuLlri2gsLEnyd7Zu759SXCD/3tn1nbivOqOa781QkB2n5155n1mgcpAcyuUvIiDXjACe2tABwdBDCbSIqMbPL8ZA4tUmirJTDSGlDOCsZRnhlnFLF4PVZKoqZAjdqTjMOPa5izTaiJiBKrBe4is6d3Le/nMLutj9syuIFUWKgC7eE1nhAnrD2v83zgjzC9uYDJlGb15e8R+n0qSWX9KzOtc8lREhr6f/e00sOvcWEhLA0rMhbSg0TyPiVMhWfPzfC/RH5aPTNC7C+iZCR4OAgOR08LmeDgLnkKeifAD0LeHAm/Rfp6CJSzdIwdANwoZJS6GvubTfswtR7mC3PvRgc7xS+nboDcLbJ7Rg4FSCXDSD088zRI8s9pBsRqfd2PAGGiKRaWDoQ5GOtgQLIqN2VCjhRQpjA9bjk8rKA7mJJ/CyBmrUtChiGuGY+Cxz4s1isZqDHqTYZDmCxGHwRpZn0zVPUXcjrllTgr0QpIz5COtGAownuwciFHJldOMZ1kiIp+yqFTDRyc0xLVfGlbUxoX+5CV2GJ6AGSodwWYj5uldadhKxmHS9BfOzLgdr8E/jVKn++o0GkQn4Umn2wmPjzo8PD0+hZDzIY8GPB4ecyRLGagBa0MaMCSw2+nQn2UTqkqPFKa/tHTf8G37vSHQbJ1VWar4EM3H5mFFqQLN28X81fHRYRe9WHpkHShdkvBBneBNk89B6RGwPwiHApCMSD5PwshL+MG4jI8SBy0sdZIkTJ9HVkxgY8Eti0N4pIFbiPvcfop2TJuUkAHWIIRW+ARZUOp2ut2w0w2739x0Oj3/8xdxcln83ytBw2NIsDvFu1vNkCeGLE+4sf1UxVSV26i9iErRLIK7wFdIVUtlmJtBWorAkqeWLNpAF6vBCpvUlYh6C1KN/XmsqqlH6UxV2QvaBDHtWVWzBfUK0JO6kzudUBuxNjO9dhu7fmueVkK1I522J9218XldQdjZ5UVQNIbHNRVXWT+NETL3Lp68gbx2Sq+BWW1ny/pQDUMUjQNOU5nFMIGEqtWPax5FYMr26glRSsihIsVkZymj0zo8aX0bLFx3K71D2U9Xv/lnZefA4NC7imBt6DyAmA8qMsuld7DixNW6XLbla/zQhNYqdhGd0Q7xDhIEQ7171NTI7j3kt89Qq0uxq/le1mJ/KsciLhkGFR8I45H4eIpB8FJSl1iBqUq3a+uLYVOB59LrIvOxRcJI6bxFXO7eCpiubEdYDQR82KttJC+0moa2s4RbKpp2+TIsXxpKoX0v9qu7Kydp7F0qY1MuF8K0k60MzySl3MBZiyaayWh/gZhOp62sfOaV1ZrbU6U/mIxHMD8KMzfApt9WGPoJWuKVe6f/yI1PEHZ79eu9fHx8vJe7874CUQwr5Y3UOAfL3IbdcrYYQP+vmXXhW3iylCHCO9OXy6xqUHe+hxnE9uq1AhvKGP1Nd7PZAKN2q5OioONysaS+FQtDkyOuuvqOIHzxLrnFCt/aNq3AE04doxf4zjjhWpQj7rNI711Vc2SfbdNf91SZN3XWvGpfFg8Irdrqiyn8mxvuDl+ubuoLRx58AfHVrXYngdUle4lCCTrDaZPZxt3alklxnw/j859vEMsd5XpzEJZTr/qHIrMxns0JWaqn30RmI/w7am84Yr+fw8ubrQ/mA7fOZkqYovgH/Cok0w== +api: {"operationId":"getUser","description":"The common schema User maps to the following 3rd-party provider objects:\n\n| Provider | Remote object ID | \n| --------- | ----------------- | \n| Hubspot | V3 Owner | \n| Dynamics | Azure System User | \n| Intercom | Admin |\n","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get user","description":{"content":"The common schema User maps to the following 3rd-party provider objects:\n\n| Provider | Remote object ID | \n| --------- | ----------------- | \n| Hubspot | V3 Owner | \n| Dynamics | Azure System User | \n| Intercom | Admin |\n","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/list-accounts.api.mdx b/docs/docs/api/v2/crm/list-accounts.api.mdx index 7a1ede6058..e6b5da2bf7 100644 --- a/docs/docs/api/v2/crm/list-accounts.api.mdx +++ b/docs/docs/api/v2/crm/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "List accounts" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: eJztWOtX2zoS/1e0uR9u6ZInr8LZ7lkKvXfTS9JCoRygnKDYcqJgS64kJxgO//vOyHGsOCk09PbbtqUkesz85qmZeajImClquBRtv7JXCbk2+54nE2F0Zb1i6EBX9q4qs6Xr9YpmXqK4SWH9oXJXpTGv3jL8dv0IuzFVNGKGKW33BXwBslx4YeKznqKTnk8NBdJcwPq3hKkUvmhvyCJa2XuomDTGC30pQ0YFbLE7GsUhrBmVsMf1is+0p3iMiOHc+ZCZIVPESDLlQYAHQR4kYAbI+iRQMiJwimwonwA+k5JYyTH3mapVHtdnIBWjfg8P9zwKF38FRmSR4fmcxHQQJux3TTpU0AHgPGTacGFtQSwCIotLPlfMM2FaSDOTgXwV+Pf16+7H0/evX++Rm5IkbxHWDdD5lgAVTVKZIN1EM0soh7IUCBU+0SwE3uTqQEYRLH3sj+Crvn41NCbWe/W6Lz1d01MqNU9G9TikJpAqqnv2SjXTna7LMVNjzia/eVIEfJBknreGaPqM6FR4zK99Fa5VIunzgDO/RwPwqmeNoo3iYgA7yJ4aWAFfYFXDI+YaqtJqtDaqjVa1tXHaaOzZf7VGo3FZWTBfO8hV7a+TCQ9DIgXYQTGTKEFkpgySwyQWJuiVa/RCZhk74oCSWE/z++fdayZJAbrZ2ljE102iPnCUAUDSSQhYrM9YdBDbBDnWyKsOvdsjTRBxzYUDoazlClotsHiHjbRz2L47Ot3Hn9Zf9/v3H0677zqj47DTeN/spJuNzv3xfWd0EXZu25POwdn98en+ZFGAU3RmOpi5voVExhScyYV6V/USbWTEVJX7OeIheLr1ih+BHKUFieZyHPk+aR+CDakhieCgFbA32F8YNLG2QTM7yAXGkyI0jkPuWRGA6TTW/DwlOFLkcVu1Ky+RQ9OQafBvj31HmVMOZMqhBOYaV3QshWYaGbUaDfw1T+dTZhBwaOc5gKg1oAU87YhbH2m88rCIPQsOuAiIwBUNzxgWxn7+rGB3Zpk2RBKGtJ/nXFc7LP0QXx60t9uj47R76m1djrz7o9NBExzTdA/PNjoHja2L0cXG0fmX0UV0vNE5/DDqRu277kFbt8WH0I++pF7rjH+MLof9/3bD4PjtW9RzrNiYy0S/FM270eXhMLqILm+Pzs+2uhGieT+5BDSXo+O7o3MIkdFZ82LkR90/25vdtIRGnKT++ZddRGKkoWHPWsUBI2wecB0Fov3x0TX/VaZORxbwBcNNOM1MuVXsJU8q3xWWKkUxOXDDIv284ajvg5dNXeynSPSyU0siAkRGoWLFI2oTV0R5mO1JfHLhdx8SdraihzyO8eM1iOfZAmYVQ36mgvyhqPC49iRqyOpfrUjl7PO+9SWpMxP6SwX7/v3dzWZjBynAfbPi3YP97KJizPSaq93dam2RdyC9oMIh0lqJCG6U/XHOxFOzFKqdV1QutCODgwStOmN1VXaewvq57UsGdewJRipxzvU+Uzvq0lXlnH5c9ViZnSAroqKcuVexRhvS8CCrncj+pzbSgifxqTcDKodNPCV8eLdWdVpg8bsFHFJtetQzfAwq7NEfSszP12EtW4ftzOowW4Nlz+VqAYofyMH0YbZEbErsyaDHYE+mbC4bcdSiTRLfJdra2YaKCSjJiQBCy5X8fUj+G4/1N4Kg+qa/E1Q3A7pT7b/xWfXN5m5rtxVse3TbJvR4KAXrZWh/Il+6ZFYD+s/mZnMLfWRre6cMaJX0KyHdon0DejfLwdflmJ+DuYxXOZTn5ZoHuxTrDJIbevNKRm/mAfNSL4R6HPrcH/O2qcg66WPoZgJAE+jbt0fdQrkvBt8SGtpeYLphy7XyooxjqQxUl1nCy50WWIypGDDswwsNFkKUMYMYE9bXfNW3IG/d5ro2+6pB72iw2/qVwZ3E/q9nwnXPh8bVMDdol/TsAQ01y5Nb0W0uhfYiKMufPIYFtfsC2BzupOgl6XaaFpcnNidJlTNK4SSLXj9n8jnTzKlwiX7cZy3rEUDWcqwXRWVRU0JGsAfnO44jcHlCi2YjYmYocSY1YDbVUTOEL3XnhGZqnA+aEhU6bk1jXgwkuKx7KqqPW5Uyy9nkwz6izmzrM3YyWVJ1JlxFXo75XyzNzbHnnCm3c/P8gA2BU9ig0zCUE+KzMQsxhdumHUQDx7DtpQVkH+xAImOUM6PRqDW3a7uVQvdnIhs8HJx07LWsTQO3se1TBjAXFL0Va2T0YOnp/7jhj8afU+Lc5oK5foM/BAoRJf3EwzWcQZ2zEA4zFAalyKGh3K8A3xoBrkkELaR1iRq5kAnxoA7LRlFc25NweQJGsFSiJDQcn3XYVX51fnqnyYTDurC8UHzoR9lAqrSGWK6+cDYh2QCKZK0pgfjFgy8ZXYELrVmy/7g6SQS2/Z+gQoyoKIipRNRiWBPocv3EGBBRjwdrxYnJZFKLs2uWWc65PpHqVsfUY7Olapz0ocOejcwsc6v0d1RbByFnJ0dfxc3NzVfxtN9PD+WNBzB3XKMcdsuLUgN9I6qGWyrWTx6mIXlVoc50eAgMcO3hoQ8wzxRU/LicTZYwUH2uMbn708S7wHA2Y/j52e76cvQ2lpeNpLOR017FTp1ehPP/890fm+8+aZnFOfwLDfM3TG6fBLowmn4hztUnuE/CckfML0T01Ej2Sd6zeXLB+Bq/KJ5VdFdY209fx9WywauTaVmxRv7OQe0TspQHzi/UZQl4eTj7JIDyrHgOQnZoH4qG2Dh7C5NZtMCsmPrz/SmcpQlmbreeyYqX6Qe0TL4lUoe2W+hk7PF/BLP0+L/wlYJK6d+z48VUf+mFWd2U52gAD6Xi/wCICNay +api: {"operationId":"listAccounts","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Paginated Accounts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}},"required":["pagination","records"]}}}}},"description":"List accounts","method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"List accounts","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/list-contacts.api.mdx b/docs/docs/api/v2/crm/list-contacts.api.mdx index 56b94a2948..74a489843d 100644 --- a/docs/docs/api/v2/crm/list-contacts.api.mdx +++ b/docs/docs/api/v2/crm/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: "List contacts" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: eJztWVtXGzkS/itaz8OGDL4bs3A2e5ZANusMdgKBsEA4Ru6WbZluqSOpbQyH/z5VavfVDsSe5G2TELAuVV9dVVU8lmTAFDVcio5b2i95XJtDKQx1jC5tlwwd6dL+dSlZutkuaeaEips5rD+W7ss04OU7hp9unmA3oIr6zDCl7b6AD0CWC8cLXdZXdNZ3qaFAmgtY/xYyNYcP2hkzn5b2H0tmHuCFgZQeowK22D31Aw/WjArZ03bJZdpRPEDEcO5izMyYKWIkWfAgwIMgDzJkBsi6ZKikT+AUaSqXAD4zJ4GSU+4yVSk9bScgFaNuHw/3HQoXfwVGZBHh+RwGdOSF7O+adKmgI8B5xLThwtqCWAREppdcrphjvHkqTSID+Srw7+vXvY9n716/3ie3BUneIKxboPMtBCqazGWIdEPNLKEYykogVLhEMw94k+tD6fuw9HEwgY/65tXYmEDvV6uudHRFL6hUHOlXA4+aoVR+1bFXypHudFVOmZpyNvvNkWLIR2HkeVuIZsCInguHuZWvImsVX7p8yJnbp0PwqheNoo3iYgQ7yJ4aWAFfYGXDfZY1VKlRazTLtUa50Tyr1fbtv0qtVrsqLZmvM4xV7W6TGfc8IgXYQTETKkFkpAwSwyQWJuiVa/RCZhlnxAElsb7mDy+7VyJJCrreaC7j64X+ADjKIUDSoQdYrM9YdBDbBDlWyKsuvd8ndRBxKwsHQlnLNbSaYnGOavPuUef++OwAvxp/PBw8fDjrve1OTrxu7V29O2/Vug8nD93Jpde968y6h+cPJ2cHs2UBztCZ6ShxfQuJTCk4UxbqfdkJtZE+U2XuxojH4OnWK34Esj9PSdRX44j3SecIbEgNCQUHrYC9wf7CoIm1DZrkIBcYT4rQIPC4Y0UApotYc+OUkJEijtuyXdlEDk09psG/HfYdZS44kAWHApgbXNGBFJppZNSo1fBbns6nyCDg0JnnAKLWgBbwdEbc6kTjlcdl7FFwwEVABK5oeMQwNfbLZwW7N6u0IULPo4M452a1w+YfgqvDTrszOZn3zpydq4nzcHw2qoNjmt7RebN7WNu5nFw2jy++TC79k2b36MOk53fue4cd3REfPNf/Mnca5/yjfzUe/LfnDU/evEE9B4pNuQz1pmjeTq6Oxv6lf3V3fHG+0/MRzbvZFaC5mpzcH19AiEzO65cT1++977R68wIacTp3L77sIRIjDfX6jgxFVjXC5oGso0C0Pz1lzX8dqTMjC/iC4cZbZKbYKvaSI5WbFZYqRTE5cMN8/bLhqGMB9iFW11LY0K39Y6/Rapdre4N6ucWagzJt12h5l+62m/XWYOBEbi9ngqm1qTearN2qDVm5Xa/tlFu0XgfqzXa5SWl70HbabLfdQOrUdSFGFgGyoQIiEv3o1Ip4BoOhSQLFfWrTrk+5F+1JLBjg+wCem2hFj3kQ4I83gM6x5dc6cn+mgvxHUeFw7UgU0BpHrUnl/POBjQSpIwd0Vwr2/ft7rXptFynAfbPm3cOD6KJizPTr693daeyQtyC9oCJDpLEWEdwoRlPOxAuzpKrNKyoWOiNDBglaNWF1XXSe1Pqx7QsGzdgTjFTgHOs9UTvqMqvKnH6y6rEyZ1JEGhUIF921/xMCJUfo+ZdvzDxP/jtbai4hWSPeZlLdJcF2UzRuHtZKLkWrFSRZBXc12ghKVtVF7QKnIVfa9KM6Yh3vf8+kGtmcuTpbJid3Ws16A455FPjAk8+n4Gt9+kPv78vldsOW27tJuW1LbctqfZH+hwcwE42lYP3o5fsLHpglsx6Q3+ut+g6U5a2d9m4R0DqZX0KmR40N6f33PTIHcxWvoj/m5cqDXYk1gZR1xbyS0Wh8yJy540EjY6C5+CGNLUTW4QCrzEgA6J5d++ypO+iTxOhbSD3bRC02bJ1bXJRBIJWBsjzKtYsyHLU6pWLEcICRajAVoogZn0Bokw02lr/SwcPA/fVMuO670KMblo3vFeOJIfU0i6MubaxXQtsQSjLhWRF0kM041pfU+5QJP9uTFB/WtHjMVHr5Xsems2yltvwk5XLmiryWzT/FZLLs5jmPyVk2Z4EV6s34oRN1U6WnpeBOy++0+oYUYA/me7Nj8HHipG2Zz8xY4vRuxGxuo2YMH6qZE5qpaTySC5WHT9NidkMDno5uuKw6yq9OG6Uiy2RGdPCpY5NDPAX8jD1flEUzs8A0EQf8D4aBmrS/8Zli45vnB2wInMJRBoU3dEZcNmUeOo0db4B/gIVtI24BYQyIoUTGKGdEo1aptyt7pVT35yIa0Ryedu217cQa+0l/HgsaexMGgHR08RHPK7FYkORl+Q3+kA5UZ9INHVzDad0F8+AwQ2FQihgayv0K8G0R4Br60Gxbl6iQSxkSB2q+aGjHtT0Jl2dgBEvFDz3DITZxV7nl/JxTkxmHdWF5ofjQubORVPMKYrn+wtmMRKM6EjXxBMIfD24y5AMX2rJk/3Z9GgockHyCatSnIiWmQlEJYE2gyw1CY0BEPR1tpSdms1kliK5ZZjHnKlZKOqAOS5bKQTjwuJMMFy1zq/S3VFsHIeenx1/F7e3tV/G83y8OxU0OMM+4RjHsclZOPN5Ah42q4ZaK9ZPHRUhel5zMHH0MDHDt8XEAMM8VdBe4HM3gMFBdrvFtcBd5e4lhMo3561Pw7dXobSyvGt5Hw7n9kp3PbYTz/5PwH5uEP2uZ5d9YbGiYnzDjfhbo0hB/Q5zrz7qfhZUdxm+I6Lnh9bO8k8l7yvgGPygeFYTXWMwvXsf1ssGr00VZsUV+5kj7GVmKo/kNdVkAXhxjPwugOFXPQYgOHUDREJjM3tIMGy2QFFPv351heRli5s7WM1HxsvgBLRNviXmGdrbQidjj/whm5fF/4isFldK/kuPp7z9WXkjqpjhHA3goFf8ETss96g== +api: {"operationId":"listContacts","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Paginated Contacts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}},"required":["pagination","records"]}}}}},"description":"List contacts","method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"List contacts","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/list-list-memberships.api.mdx b/docs/docs/api/v2/crm/list-list-memberships.api.mdx index 650f4fb2dd..e23bac9882 100644 --- a/docs/docs/api/v2/crm/list-list-memberships.api.mdx +++ b/docs/docs/api/v2/crm/list-list-memberships.api.mdx @@ -5,7 +5,7 @@ description: "Support:" sidebar_label: "List list memberships" hide_title: true hide_table_of_contents: true -api: eJztXHtT20gS/ypz3j8uqY1sWX5C3V4dj+zGWeyEVzhIKBhLYyyiV6QRxhC++3XPSPZIFo5Nwu1WSlQeRpqZfkz3r7tHct9X/ICFlNu+17MqmxXHjvge/O0zd8jCaGwHUeVVxWKRGdoBjoIxh3EQ+CHf/OR98r6S96F/Y1ssJIR8Je+G18zkZKWfr2THd13fI4fmmLmURHJZuD7wOYu+PR+pa7Mfov7yzZ/HRq+6iqT+Jh5Ggc+lNJem73Fq8suVZD8tlPArOaATYlFOSchgaS9iZBT6LvnQIFvve1nZD6nDopEfmkyl/opcUtP0Y098dBi18H9f6Db2bD69fAL1Vqeqk4PXh0eCC6AORsHpVVTZ/FhBc4kq568qETPjEAjAxfvKrUYDW/vM8LfzB7gb0JC6jINRifse/AK2FNArdhHZdwwWtNG4vsQsnMIvkTCKyuZ9hU8DHBnx0Pau4A67pW7g4KW6rlce8tY5iNFyiT9CGWKHR4T78JHHoUfA1AlSrJIXfXq7SWCBl7DCjBvgP/LDp7Bi7urT/m7vdu9oC/8af95t3b09Gmz3r/edvv663p829f7d/l3/+tTpf+5N+jvHd/tHW5NF/o/GDHm0PeGURLJEbqgTM5VVX3jaheBodX692MUtS2wFriSmAp8UC4Hf0G5wTxUJkzmFDAMk0CvgkJjSpSV3BOmj+keMm2NCCaILAYutAoWQfYntkAHo8DBmimS3mhlH3HdZqNlWKtsY+GHhipvhTudL1IsZTu+T3i7hY8oJCA76c6YEsMzj9sgGD+HqQNsjUz8OCQ0CxzbF5iyXIkiAURNXniJHNHPwR8wkhd6EwqPMoN4v5soMKB8vDF+NJcPQWafeoppuDk2taRmW1m0aumZaHWNjVDdG+kaz8oD+niJIhAsa4KnwX1YEBA7izgIN0EEbA+3jUEXNtesIx98vMijNDCaCJsC3uS2pzd3n22M9dsuLRPZix6FDlFkqZ64CNn0bnO302r3r/engyGydXZt3e0dXdXB1Ptg9bvR39Nbp9Wlj7+TD9am73+jvvr0euL3bwU4v6nlvHcv9MDWNY/udezYevhk4o/3ffsP9DUJ2Y/tx9FRutq/PdsfuqXv2ee/kuDVwkZvXkzPg5ux6/3bvBEDn+rh+em25gz96zcE0x413MLVOPmwgJ9zn1LmQwDBnxhPAqloDwOfDg2pHH6U6FVnAELjNnQTq010Rk0w/tFRhaRhShB6bM1dc9z32biSCxfItTDAMDXwt1Y0svbthNNuavjGsa03WGGq0rVOtQzvtRr05HJrS8fyJx8K1VzcarN3UR0xr1/WW1qT1OqzeaGsNStvDttlmnbaBq1PLAldJ/OQxVXxDAXIJGQyWwH4Q2i4VIcKltiPv+QByuKlD20muoC8G+PEcuDNFPF9H7kPqkd9D6pl2ZPoooNiccM1Vjg+3hE/4kTRFq1Cwx+dvNOt6B1eA+XzNuTtbcmLIGL+orze3ZbTINkjvUU9ZxFhrEbyR96vMFifbMldtVlGp0IoMCie4qzNSH/PGM9/9dO9zG6rsJ2xSjnKq95naUZeqKjP6UdUjZFbAYu4VyC6a68UPcJTMQssD3Zg5jv+fKMlrqpDXLHCyhr9N/PDzzNnO85ubZauQSn7XcpIUsVvMrWRFVXVeu0BpZIeQMMjkYR3r/4P54ZXAzGK0nI1sNRt1A4Y5FOhAVmnfgK1d0JUiMSRELo6sQKHCNG6L1EfBXd0wNN3QjM6Rrm+KP2eVlNT6Iv0XByASjSEcXcgY+B0WqC6zHiO/1pv1Vt1oNFvtTp6hdZDfB6RHjY3o7eMWmWGziFbeHrNyZZkt5HXGkmqKWSXjptkjZk5NB2pEKDdX27pE5Ahqc0g2pQCinMGwF35mHOZ9iamDOb6V3BCZdv5itiJKCwHU6g31rhgm1XMNzoXI84whMGRgq9bzGngcWM9PxI4uLOZAGa/699D3QWWeusCIOhFLvc71LaHXR1h7IishnVzgWUWR0wGa2ZhpUue94n6iKsoH1nnyqGR62WpLwJmaqS2GpAxmFuCaij95MFk084zFZHY2swMF6lXscF6wr5g/lilomYKWKWhxCpo5uVhnN3oeZ1fygB3PTlfIjTBs4ijPgoizrtECiX9Glf9vZrV+UnUoPpCdNKTiIjI58EcXDO75U5ZBIxu1KEDi0UWNTlvX9SeX61bXZMPGaKR1h52R1hzRjjbsWkzrNjeMDWPUNml7o8wDyzzwu/LACRtG9rqxYMx5EG3WampxVyuzymfJKotDHss/A00SwhlEFyZ8Sa5XBGyZTDOfDKZG8kxpYfrEp0wLy7SwTAu/My0EKA6ot64dJkAuF/BuwF3QS5/4FKPbNc1m08THFo2m1mTdoTbULaq16maDUtZoWnRUSGll7y0BoASAEgDKurCsC8u6sKwLy7qwrAt/7rpQSRWTZwjrJ6UmYGSn09WoUd/QmlbbBMDsmlrdanWGLaPe3Bi1CymtkFGWb/uUKXWZUv+8KXX5tk/5ts93Zw7l2z5lNl++7fPT5N/l2z6rv+2jJNXWitnQt/ekUbQnZaT+qSP108MnQupF5Mf4zaV1jynJtuNfXcnDv6fVYm2DtZg+6mhDZlpQizEDPnUNrTtsMihAmdWlRhnk/6ogn9xYq0Tztd8Bti1pFD86vApoq+vPG14LifxtwuuS4630CecjjyofOSxaCEJJUFXDogoSSw++pMX8kCgpcr0V3nx45jMm6uYewK7wHKOu6/I5hun4EXvu0P7k51on1JNfuY4jRkCnHpFbjF+wxQ0RXyAHpggf26GlBTTkU2LPH4ZFf3k9WaiP9WPhgDErWirlMz+QsgMoWrwVuJbnZivWW3NQRjO0yInvpQdv63519d3714NnA/TnrpcKifxtAV0F7AR8Couexx9XKPicVi3Jnium9kMwWi3EHzKVNs6Zf10chXQZp49VhVlI/wakVHR9e9cTEHvw5rBh9LfeVJZ95V6LAmYC92bSOGDeNiBM0S0S7Q6qwtOVZg1LUrqitgwFpxPnS/BoLtABM4EjZ/rBZhNm7cilF5u5oFAWu2EOKks0EsDWGVn2wTWYsxo1IsmRpfTEegVqWlbjL64Spr1KRIsSrvZDyC297IRAEQLiPgfJhjHP1LLYpgClQoMOQQ2VWsTCG9tkUQ3J126wOUotkpxGtXR4rcCiQEbRZafQ2AayV8MSTe6m+5QburDFeD8KqMneh2xk38oD91eVQ8njkZRrZ2ZtvejQ/+LsYKbHbQUFd6Qz78rDfQl6Lc1oHxnGptHabILcuv4rilGZDd6eJhK2Egk7G6NBu7fVgyF74PX9xOlXW1SdsWzlw2kExRqMBExyg9XWlVqTfEj94NUDNmIh80z1zkMeT+XxUaYDy+woCF1FMeVFAEsQK2/S/eQGoUM/5sKeQ+b6XDFr0T7lBtiuLiC80lxh3ltBwUcoBx8SwBz7qMYrJjASO4GARePKUe0+6RPygOAONp726pFmn75vQAO7OjvQsP2aGbq1G2NBnllLGPF2k9IeSLR7kh6mNAmaV9+B/SebphrdVMbkW6hk6WFeCaMw9aSO40/mqCbSUUBUKGmEWgVD4k2qkY+EUU65hl6tt6sblfmWHSdJ685BX0x7VVGeUycMzl7nTA52MFT7ZpQ/9MkqMX+AlZXlF/ghPY+HvhWbeA1bbZ0wBwaLfjooxbGST78A/l4SoBq7AAjCDKrk1I+JST2RiAswxJEweQKbIFZxY4fb+L6VmqSmxhaRiQ3XPUELxTfBHa78cFpFXj6i86TNfmRbFgG6MPD8RSojaqGaeTslcCjHfKYmZ2pyZoQm9FIs+4+PB7GHrXbe+xF3qTdfLIy9agDXPDQ5gGgOIkY3Vy/nIyaTSTWQ0wSxlHINT9YEGs4uaUE8dGyz5t8gkrOJIC6Uvk0jYSDk+GDvk3d5efnJW273yaD08TUQV0xDdLhxsm1uFkLi/bztTdlarWytJlqrSSjk7Jajz9jCvASA3CeQ/VFEE7SlzbS5E0DsGCwQ793fD8GOj0OIXHhZNgZDJLfsCMscKylBllji2m3UHuFagHumzZtsZbZZEecwqzO0rC/aUtqzpm5PJPziIImzL8kTW50tYS6bRMw5PMdfQlvWpGttnMLuY6TTSCuO9WY0U5ZSe3rAOiMJtk9m4Uf2WluixnzPuB+z1fn+aksZyLd7y7AgB21BDhJw5d5CkzPc91mK9sfrIyxdYvR3NT2SuVDyQWmPld1PNW+S5PFf5ewzO/xfiD6QeP17NnzecrBwwiwNk6NRGZhk/g+2nR7t +api: {"operationId":"listListMemberships","description":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","tags":["Lists"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page. (Max: 100)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"list_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List membership","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"},{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"}],"title":"list_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata","description":"Metadata about the remote provider list view."}},"required":["pagination","records","metadata"]}}}}},"method":"get","path":"/lists/{list_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"List list memberships","description":{"content":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","type":"text/plain"},"url":{"path":["lists",":list_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 100)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/list-lists.api.mdx b/docs/docs/api/v2/crm/list-lists.api.mdx index 94ba373d2f..e63b07cd62 100644 --- a/docs/docs/api/v2/crm/list-lists.api.mdx +++ b/docs/docs/api/v2/crm/list-lists.api.mdx @@ -5,7 +5,7 @@ description: "List lists" sidebar_label: "List lists" hide_title: true hide_table_of_contents: true -api: eJytWPtT2zgQ/ld0vl9gjjwIhU4z15uDpHM1TXIQEhigDBW2QhRsy5XkJIbJ/367Uuw4j0spUzo8Iq12v319WvXFETGTVHMRub5TdwKudAu+lbPnaPqonPqtYz/f7TmKeYnkOoXFF2daojEvPTH8dDeD3ZhKGjLNpDL7EXwAhTF9ZPeKPzNQyCNY+J4wmcIH5Q1ZSJ36i6PTGCWVljx6hB02pWEc4NJ+terM9hyfKU/yGEHCYicJH5gkYkAkU0mgFdEC/tSJjAj4QtBimey06bROQMEuaMjRAH4l5FugeM1q2m6601bvGL9rX56Pn097nZP26DxoVz/tt9N31fbz+XN7dB20n9xJu9F/Pu8dT9bx94YMMfLIRJ1YSGRMg4QVoYqHEfP0vUH0erxREmLKPBFp6mlYoZ4nkgj/EnEspE4iTOCeEzDqY04LHs7PbAR8kQBkQEg8EYaA2qIjaB/DP2DaGxJKsHzIQMgyWJDse8Ilg6rSMmEFz6YlL1FahEyWuJ/5NgQ8TL4yGWG6ULG/GXC2T9wm0UOqCTgO8QtSwn0WaT7gDAqnKMgjkopEEhrHAfdMcrZ7EUsxBmWyZFbe4oeiAVMQLo/9T5nMLZC5hRUwd7iiYhEpptBQDdoFfi3rwe4lWUtjjsF7lCq4WRkpFH1Zx2zTDAcBCfSW5tbQonx/LBuxqd4UhSgJAvqAYUBfilFh6Wl803CP3NF52ul5hzcj77nVe9yHVtOdZv+g3ageXo+uD1pXl6Pr8Pyg3TwddUJ32mm4yo1OAz+8TL1an/8b3gwfPneCwfnHjxjfWLIxF4l6K5qT0U1zGF6HN0+tq/5hJ0Q0nyY3gOZmdD5tXUHTj/r71yM/7PzjvuukK2iibupfXX5AJFpoGtzbxlyAiQyxFQsE6Gs2K6b91oaz4AvUgOY6mFNtlhVzyBPSLzpLpaTY+lyzUP04cdCbW4u3Wj1pRlX86n6+OKi1jz8722q4pGLmQdt5805c9KFExoBe5MrwRxnRF9nvJ3nOMNsy3d2BRtu22xzqMg8QBeklZxPmN6xqtdEpn41ZgMEynYl30TJ8qCUWvM4asebIVntG34YwSTq596ne2LLrWkCaoDQZSBEa8ssJZkU1xNP3OR6lwVmhKlaaA1hEg2cPiWbFgkK2Qa9ATSIhDE5FMTnmHlMVNF8ZH74vVyvKIlWVTLyyoaLARzOXbCy2jmXiLZFsZnlaEV1LMe6rmHrsTLIBnzp1JIQ958Ji7Fm/Gnm1uepCfA8aIoyh3wq00ZCMauY34QfI16q1g1L1sFQ76tVq9dph/R34Xa3+gW44ufBJOvfwcO7h+w+DzpF77IJIiyrdFj52ySuVFk9s03yRKqABkFQakvk6vTZqFoeND6522YBJFnnFndkqbZmLfnmkmd9ptlUKpVxgNCzGe5gpqdlYU1ogvAXf3c1mRnDDLRjMb0HQOBQYmUdmaI/qIRZpto3Fmk2xtn6HWseqXqnAxFtW80mozEXFk2FlXFvrtXxYOj5znVlhcL7A+9W2SmF8XhB0zL+wNAtNvSCzOlws2wMzBKRwEKNBICYLejKzMVAjU3bYMYBmqG0g0DD6aXVUy/tH5Q/OIvb9yNQQaXTb5theTrb1fAbKHEViCynHUPnCU3/nMYJpMSeBLIhLm2uJ+h2+iBtpKfzEw7Wv8O+KBSBsJk30IoOGfu8Avl0CVpMQOtsUQ5lci4R4NCKJYpbVUBIOTyAJRksI7wYOFIa70i/B00WnORkqMuGwHhlb6D5MSexRyLSMWG6xC7Ix2A5Mhj1B8G4n8xGjUC46WokDqkEsrNiTJXtSYQntGrW/3XaTCIfQM6F0SKOFMplE5RjWIiw54FoNLqrx4+5CYjKZlGN7zBjLLFcmQj4ZWsuXSnHyAHNfRYyRktnEGDdBP6HKFAjpd1tfo2/fvn2Nttf9XMiMVtZ4oTSWGm4pxXm5axhlMC7cqDBF8jJvxlsnyB6dQ1CNCy8vDwCwL4FbcNm+hbBFfa5wcoN+HtBAsTVr+cz78y/Hvc1QTdcuvWzt663umAfc6wFtewputZ2/Y99oeKc7p9Fd8sbX3RZwyzS/QHiHHyS3Y/YtzmRzPvu5LK5g/1UPvS0OrT5Yf03QVx93WwGsvjWXIFihY6D5WBf21l54mIH87vvnUw/HvATbrXgD2etm/gdmJtuK0oLu4tVkzeNPBLNR/E/kFbjb/srFF//fsfFAftNZaQwGXuz/AQ6mV3w= +api: {"operationId":"listLists","tags":["Lists"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page. (Max: 100)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List Lists","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata"}}},"required":["pagination","records"]}}}}},"description":"List lists","method":"get","path":"/lists","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"List lists","description":{"type":"text/plain"},"url":{"path":["lists"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 100)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/search-contacts.api.mdx b/docs/docs/api/v2/crm/search-contacts.api.mdx index 8aecd4ec8f..1e8fa71185 100644 --- a/docs/docs/api/v2/crm/search-contacts.api.mdx +++ b/docs/docs/api/v2/crm/search-contacts.api.mdx @@ -5,7 +5,7 @@ description: "Search contacts by a filter." sidebar_label: "Search contacts" hide_title: true hide_table_of_contents: true -api: eJzlWel327gR/1dQ9ov9Gt2yXPt1++oju6uspfiM6+spEAlZUEiCAUDJtOP/vTMAKZGU7ETe7Kcqhy1igPnNiZnhkyMiJqnmIux6zq6jGJXu+ECEmrpaOe8cjylX8ggJYPnMLBM3XSfDhFAy4r5msnobnsVRJKTevQ1vw2/kWIop95gk8PlG0p37CbGfb0hSWXxI4Zt9giS/x0MVCW33kPcB5T5ZfAzJGfWZGgnpshdJjnnEPMmnzJyy0YcDU7DM27QkvTNymIQ04K5aTQLK0PReObs3zlw/d+9AY24suU7g+ZPzUKERr3xh+O3uGVYjKmnAQD3KrMP5DNTIQ9ePPTaQdDbwqKZwNEf1fo2ZTOCLcscsoM7uk6OTCDcMhfAZRQjsgQaRD8+0jNlz2T6XY6bHoHItSMqDAA+CPMiIaTjWIyMpAgJUpCU9Avh0QqLUVFXn+d0cZETv2UDxR/ZddEpLHt7nwTmNZstZQtePgyGAEyMimYp98B/AKZmOZUjACwlyrJKNHn3YJY16vb6ZhwNaVkK+BYt7WE96h92Ho/M9/Nf843Hv8cN5f783OfF79feNXtKu9x5PHnuTK7/3pTvrHVw8npzvzZYFOAetAUgemoAhFhKZUj9meagPFTdWWgRMVriXIR4zChr+QchBsjiisRpHtk66h2BNqkkcctCKnxCwZKj5iDNlzDwn5CFJRCwJjSKfu0YEYCrZ15hL5mUelZMic4uKefIWOdQ8NF9QZpYjUg4lMHf2CVN6X3gJsioSvHMwE4G0uJQTqzZRyOJpGaMYTpirgRNwBpfToCRctSns+3QmslcIHMYB5gWGuQeTwrKksBO93eZXIsIq+RiCrT6bLZ8JV0Rl2YaAwgj1/bl2FMalY91sBfdlZoa0yK5gljHzffGf9HvVFYHz/JxX/o0RNGN5V15MtQXP7Qok6FBZBTXrdfxRhHRsQwYky10sP8lyi3D8Pm3IHvQqBYax79NhllTzimLJh+j6oNvpTk6S/rm7dT1xH4/O7xuQOnT/8KLVO6hvXU2uWkeXnyZXwUmrd/hh0g+6D/2DruqGH3wv+JS4zQv+MbgeD3/v+6OTX35BW0aSTbmI1VvR7E+uD8fBVXD95ejyYqsfIJr3s2tAcz05eTi6hCQ2uWhcTbyg/1u33U9KaMLTxLv8tINItNDUH7giDvOqCU2mzvsM5OOyGxh15mQBv9dc++ndkVnFbHKF9PLCUikpOhjXLFDfNxx1DcABZNO1FDby6v/cabY7lfrOsFFps9awQjt1Wtmm251Woz0cujYxiVnI5NqnN1us066PWKXTqG9V2rTRgNNbnUqL0s6w43bYdqeJp1PPgxhJA+SNCrBHDCzVywkokjyg5mLEtGLXBFYE8HPI/fSJGvMowl/vAJ1rapd15D6jIflV0tDlyhUooDGOXPOUi7M9EwlCWQf0Vgr28v6ddqO+jSfAfr3m3oM9u1EypgeN9fZuNbfIPkgf0jB3SHOtQ3ChHE0FE6dmWai2qKhM6JwMOSRo1Tmrm7LzLKyf2b5k0Jw9wUglzpne52pHXeZVWdBPXj1G5lyKWEQFwkV3HfyEQCkc9HptYi9BuHXpPdxy9hYsIVkj3mZCfpkH29KNWYS1kkvZaiVJVsFdjdZCyau6rF3gNOJS6YGt9Nbx/t+YkPcmZ67OlnPKrXar0QQynwIfuPL5FHxtQH/o/oX6J0BKB/oWVtHclIa5vFtvNiv1ZqW5fV6v75q/107Gan2R/osEmInGImQDe/P9CQ/MH7MekH802o0taJzaW53tMqB1Mr+ATI8aG9GHlz2yAHMVr7I/FuUqgl2JdQ4p74pFJaPR+Ii5ietDqwnd9Y+ZLhVZxUOsMq0A0B575tqTX5iGfV9j6mMP5KULphMpPxSm4obGyebatFFCrU5peM98rvRCgwshypjxCpQMC9y/1sHjyPvrmXA18JjPNMvH94r5w4j6imVRFwjP6PUFaG+EMh+PrAg6yGYc60vqH+fCz3SN5Yt1UTzmKr1i22TSWb5SW76SCjlzRV7L559yMll284LHFCxbsMAK9eb8MB3DOc9Lwb0ovxfVt2nXgDBgeixw1of3OkKlegzfatlQrzawXSMGDZPTbHQVSx9vIa0jtVur0YhX53cRFzVXBrVpc3lemJKQveOuyQPZtOwM2zubMHMzs0XOjfgfpgOdzyIymvIUosgP2GSdNjTQYkY8NmU++oeZNYErgDHNVMQAAm1gv3m6mDG8z5wyPxMw2NLmft6Hv9BE83AkcA/qzWKqVxud6o6zMNtFaIxJDk57Bsa7uSF358OXTHGZI2LsCFeV7/+iUcq1TFE3f4cP6UJhJ7zYxWc4pr1kPhCbWQFqJYOGetwAfJsEuMYB9OnGm6rkSsTEhXIxVrBnzJWhhM0zMKo5JYh9zUEhuCq9SnG+qMiMw/PQ8ELxoeln90ImVcRy84mzGQE4gQiJ7f/NKAQI7zYyGVEL1bygtcinGhNMze6s2J0KXXLTHPu3m9M4xOnXMTh8QMPFYTIOqxE8C9GFh7HWIKKa3m8uKGazWTWy2wyzjHMNiywVUZfNH1WieOhztybA9FOQxDA3St+nyjgcuTg9ug0/f/58G74eRylR1h8B87xrFGfw5Rh4WkxW/u/H9TaZaPag0Uu4UagJmac06904OTVmeQ/S1BhTI6w+PQ3BdhcSujV8bKfOmA09rvCu9dJ78BUb/OmR/Aty2KS04k1Clp/MRPrHca4/nH8VWP7twRsRvTZtf5X3/FXBgvEdfpHc1kc3WNumN8h6xtw4TW/ZTfIzZ/CvyFJ+l/BGXZaAl+furwIovwYoQLBEB5ZR5dwOLzKKpcHuYsceXMWRfpX2LlerHH88O8cZVvoaILCzCPB6x5SJ8Pst/DElPZ5gCgvz/AkqqPA+Nq2FY8/Fa5rGGP75esMWF+kv6BXZUpjkUOYLESsI/o9irST/F2Z9qGT+PSdfvCxauWFe12ThDWoAwP8DaZERqg== +api: {"operationId":"searchContacts","description":"Search contacts by a filter.\nSupport:\n\n| Provider | Search By |\n| ----------- | --------------- |\n| Hubspot | Email |\n| Salesforce | Email |\n| Pipedrive | (Not Supported) |\n| MS Dynamics | (Not Supported) |\n","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filter":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to search on. Only `email` is supported for all providers."},"value":{"type":"string","description":"The value to search on.","example":"hello@example.com"}},"required":["key","value"]}},"required":["filter"]}}}},"responses":{"200":{"description":"Paginated Contacts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"post","path":"/contacts/_search","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"filter":{"key":"email","value":"hello@example.com"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Search contacts","description":{"content":"Search contacts by a filter.\nSupport:\n\n| Provider | Search By |\n| ----------- | --------------- |\n| Hubspot | Email |\n| Salesforce | Email |\n| Pipedrive | (Not Supported) |\n| MS Dynamics | (Not Supported) |\n","type":"text/plain"},"url":{"path":["contacts","_search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/search-leads.api.mdx b/docs/docs/api/v2/crm/search-leads.api.mdx index 5080f37555..d67c78b228 100644 --- a/docs/docs/api/v2/crm/search-leads.api.mdx +++ b/docs/docs/api/v2/crm/search-leads.api.mdx @@ -5,7 +5,7 @@ description: "Search leads by a filter." sidebar_label: "Search leads" hide_title: true hide_table_of_contents: true -api: eJztWnl327gR/yqo+kfj11CWqNN+3b76yO4qazk+4/p6CkhCEhSSYEDQsuz4u3cAkOIhWrYcp+1rrWQ3EjHA/ObAzACc+woLCMeCMr/nVDYrIcHcHu8R7ISV9xWHhDangRyFsWM1hlw5iKwZwmhIXUF49co/joKAcbF55V/539EBZzfUIRzB5zuKp23PkP58lyRG+kG5X/qJJPk9ssKACT0HffAwdVH6USTH2CXhkHGbPEpyQAPicHpD1Crv9mHBGCxx1jRJ/xjtznzsUTssJwFNCDwKK5uXFa2Z6/egKDviVMzg4X3l1sABNb4S+ev6AUYDzLFHQDehGofFCSiQ+rYbOWTA8XTgYIFhXSoV+y0ifAY/QntMPFzZvK+IWSAnWIyBtiV/cou9wIVngkfkoWiZszERY9C3YCjmgYAHkjzQkAhY1kFDzjwEVKjBHQT4xAwFsZ2qlYf3c5ABHpFBSO/Ik+hCwak/yoKr1M1GZQHdfuRZAI4NESdh5IpQ4uRERNxH4HxIcqyid318u4nqtVptLQsHtBwy/hIs9m5t1t/t3e6dbMn/zD/utu4+nuxv9yeHbr/2od6fNWv9u8O7/uTc7X/tTfs7p3eHJ1vTRQFOQGsAkvpqnyANCd1gNyJZqLeGHYWCeYQb1EkQj8FhCH8mZG+WLlEvx5GMo94uWBMLFPkUtOLOEFjSF3RISajMPCekPpqxiCMcBC61lQjAlJNvEeXESTwqI0XiFoZ68hI5wvm+fESZSYCIORTAXOsnJBTbzJlJVnmC9xWb+QKklUMZsdYnoWRxv4iRWRNiC+AEnMHlBChJjur49TSd2tklAvuRJ4MCkYFHBoVFSWGm9HYdVhHzq+iTD7b6oqZ8QTREYRJqECgMYdedayeU+7Ki3ayE+yIzRZpnlzPLmLgu+0f8u2ozr/LwkFX+pRI0YXldHIy1Bc/1CERnP9QKMms1+U8e0oHeMiBZkk9eyWzpXnya1ie3okx7fuS62EoialZLZPYxuNjptXuTw9n+id26mNh3eyejOsQNsb972ujv1Frnk/PG3tnnybl32Ojvfpzse73b/Z1e2PM/uo73eWabp/STdzG2ft93h4e//CINGXByQ1kUvhTN9uRid+ydexdf985OW/ueRPNhegFoLiaHt3tnEMEmp/XziePt/9Zr7s8KaPyjmXP2eUMiEUxgd2CzyM+qxldhOuswEIyLPqDUmZEFnF5Q4caJI7GKmmQz7mSFxZxj6V1UEC982nDYccDFYv/6oSUGmurx/Rtw6mGVV+Su1GNMJlT416Ju/CQc0yCQX69BPFul/lUMeYx99CvHvk1Dm0kNKf3zFVc5Pd5SvsRCbUKnVLDH528067WOXAHmixXn7mzpiZwQMaivNrdlttA2SO9jP7OIudIicqDojzkTx2ZJVZtXVCJ0RoYMEmnVOavLovOk1k9sXzBoxp5gpALnRO9ztUtdZlWZ009WPUrmzCZLd4XyIC/A/qp+GMFG1ZWLjMc3ROaeAbYV/AEULiut1u3adrNpY6ODG02jSbqWYdUcbLTqdgNj0mg6eFjK6S0AvAWAtwDwgwEgV2+tYo0e1GEjfexHWwc9uVb5zk9rAbPRlFS+A+eKVZ0WWPxFAXZxKCACCHoDKhzgZ1VmUBZ7krICx1liCKpODOnaZs00jZppmJ2TWm1T/b2QrPRxZrUNKr+gnfjgpBZRNdGADQcExtiM5KIRlVpUQeLRRc1OG060sBKb+rDQquHV6drEagyHRtfqDI3mEHcMq+sQo9vcMDfMYdvGbVXRBWPmk4FG+wPxMrvMakD/Wm/WW9JHWu1OEdAq4ZdBuJX2HeLbeQxeOIjkYJbxKm7lvFx5sKVY55CyWy+vZOnNdEjsme2SAezq0fO8LRY5jCy5dbUA8kZN5R7+lQiY9y3CrjzIO/GAOk4XHzJ1bITTvw54idMCixvsj4hLQ5FqMBWiiBnEmBIrpKvmgrEQQbi5vh7G5YQ8Tq6rrMYJVnn+Z27uKHB+PhMaDhziEkGym7bkSm6I3ZAkwc1jjrLSI9BeBKU85ZHiDa2K4ZkQXRJu47BYHtgyQaoYUVInWfT6nMlzpsmpsEQ/2bQWV4W5UlFeFwD61YtSG2Jkp9M1sFnfMJpO24aA2bWNutPqWC2z3twYtks5PaOifGGdPHRq3Q2z2TZqG1Yd6uSGZeB2TZbNnXaj3rQsW9+VvSxNmA3SbtaGxGjXay2jiet1WL3RNqAEb1ttu006bVOu/lZSv5XUbyX10pJaXcwOXmGj5BZafl2u72WzmXQByQr7bcr418drpzysUi5FqxUkKYNbjlZDyaq6qF3gNKQc0sLq1fpvhHFdvzxxcmk1G3Xz33v2UKxWF+mfkuCtmn+r5n+kmn+rv1+9/gZ/Td7Yl2w6iGZU1t/YPchsP/Uis5hY0+IxV2uXFPHZGr8YNHMxs7TIT+PPYiH/U8r3pH7OFdXOM6uhp23SKLPJW6b+n87UL0+fMqQOQhbJ9oNVrynRtstGI33597KzWNskLVIbdgyL2A6cxYgJ37qm0bWaBA6gxOli8y3J/6eSfDyw0hGNGb9C2Ha0U7x2elWhrV77uem1lMl/TXpdcr2VvOF85FXlI5dFC0koTqrZtJgNEksvvrTHvEqWVLXew8LWSPsm0rYJ1WQDhB4RYyYbM+XRV6LDYgy/1lUT5vpAN/rIopLwm6TbMOJu5oIWB7Q6zwCUrdvcW78xKwvNnTGJfh2UaXA8lk05OtZk2hzTcBXQP1TT0Lx9LKEpNo7l+clYGzdHYUhSU+SQG+LKyKbaA8HI4AOqkU0BAlXILqGjtC3sQ+JV2TYuhS3ux5q3Tj3S90T9IZNzpN40plq13q5uVFKDnfrKjGjnqK9gvK9kLgpjgefv0+PMKp2f2WEx6+aNUqwg8rr5M3xQzxecOZEtn8m22jPiArFq75JaSaBJPb4DfGsIuEYeAXhyRhWdswjZ2EdRCHPGNFSUMHkKRlWreJErqHzhBaPcMfItoSGaUnjuK15SfBv8fcT4rCqxXH6mZIoAjsd8pLu2VPcaEF6/S2SUWqjmXg8ELhYyQqzrmYaeGUqXXFPL/unyKPJlw+IBeLuH/XQxHvnVAJ750oWtSAgQMbwZraUU0+m0GuhpilnCeV2WNmGAbTJ/ZASR5VJ7nYHpb0ASxVwpfRuHyuHQ6dHelf/ly5crf/k+iomS+0NgnnWNTMN0cQPcp81w/9+N1TqMCHIrpH9QpUq1We7jYHdZSRSYhDuITmMZDmHo/t4Ck51y9+FBPtb9wTIIOjSUOdKJ89cS7f9w8/QjQuhYVNLznYQl1Tv8fJyrt1EvBZbt834homV90Ut5z5u6U8bX8genuq65lNVgnDhWM+a7ozizrqHX7JZeIkux6/uFuiwAL3ZILwVQbNjOQdBEO5qRcaLv9BOKhS7cdMYWZOBALKW9ztQnB5+OT4DYihu2PX1FD15fUbcn8P0K/qibLrmCqifU83somfxRpG7cKnpdmZ1xJPd+tszQNUX8RXpFMuTPMiiz9YcWRP5filVK/jcZ7KGA+fucPG3rL50wL2eS7Q1qAMD/AtQZXd0= +api: {"operationId":"searchLeads","description":"Search leads by a filter.\nSupport:\n\n| Provider | Search By |\n| ----------- | --------------- |\n| Hubspot | Email |\n| Salesforce | Email |\n| Pipedrive | (Not Supported) |\n| MS Dynamics | (Not Supported) |\n","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"filter":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to search on. Only `email` is supported for all providers."},"value":{"type":"string","description":"The value to search on.","example":"hello@example.com"}},"required":["key","value"]}},"required":["filter"]}}}},"responses":{"200":{"description":"Paginated Leads","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}},"required":["pagination","records"]}}}}},"method":"post","path":"/leads/_search","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"filter":{"key":"email","value":"hello@example.com"}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Search leads","description":{"content":"Search leads by a filter.\nSupport:\n\n| Provider | Search By |\n| ----------- | --------------- |\n| Hubspot | Email |\n| Salesforce | Email |\n| Pipedrive | (Not Supported) |\n| MS Dynamics | (Not Supported) |\n","type":"text/plain"},"url":{"path":["leads","_search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/send-passthrough-request.api.mdx b/docs/docs/api/v2/crm/send-passthrough-request.api.mdx index e0b80c3796..b203c6f68e 100644 --- a/docs/docs/api/v2/crm/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/crm/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: eJytV9tuGzcQ/RV2+2IBluTkIUCMoqjjGI3btHZluUUhCwi1S0tMdsktyZUsCPr3niH3Kil2HNgGdCFnZ87MnLloEyUiNyLmTiTRqTOFOI50Lgx3UqtLHEVWqOSaW+sWRhfzxUj8VwjrouPI8bmNTidR6zKaHkM+Lox0a1xtooc+z2X/i6Bv0y1uE2FjI3PSDt030M1M0MgSCRwuXTOnGWe50UuZCANDpcA7nUDNxn+FaA031soJ5eiK53kqY499+NmSiU1k44XIOH1y61zAqJ59hh3ohQl46qSwdJtzt2hJWWekmke7iMcLwUiSQFJkmMNB5QHOjhLNlHaQsdbfJTrjUvWi7XGUCbfQySEbQhUZhfLXizG+XV/d+Ldb/3o2Pv+A9/cXHy/GFxRg8cCzPKXnSRx6F4IjUPaQi13wH4Ig4Qz4NOCtFGAInkGaJ4kkUZ5ed0LThbuFSfhr1k8b/IvEYMtw+P4ylmclC7qGiBuHlbOjmCs2EyzoYNqw326u/mQBcQ+2tRJX956tO9aO9907jJN4uJ0Suoabk0CoOuu4DgI218oG716fnOy70ionVklHL8bywqTfRvL7Ik3Z7ehjh+ArbtkKKBDiqE3EhXO5PR0O48I6ncUmG8Q6G6L0hzEHMeG3ddwV7ZSC8TNf3TsdwcuxWCeAYHRW1lCLKrVVRO855B97P0I8WfnUV0w8n41crZ/iUOlw60Qio/Pu0UzrVHDVPuLG8DVASScyj+IRDj6XsodiRC4djMsuv4lKdWKbREy3dY483IsqX5toydNC1Cx8ijUNaZDpTqIf+iUhbT+VmURRvH1TJ2PiK80XW9N4fGoUvsDsQz8YFKYvEwoseR60k83dQmqadE33bN2oeEXs3o9idc8u3yOO3LFCSUDGdMNQU07eIws+wLWgVGytC8Na1R0d7ww7ym/tRTUh+/7ke/ywHDm61yYWh52oLLDSwg6YaTPSolz7nSAM0WiYt3YCWgnMskpCN/VI9sAWOZ+DGAOphyDBcPl6vyuUIuzs+jLatpaMG/JSlKSoV42mdnL5u6DiqYNWyeyGq2sPZhik/CaSpnrFErEUKVWPny48jkU53j0gBI/68KjZU1qkL0NSh78OWRj2Da1bY7Umc9NHgPde+yKCdEB5Mnj1ZvCWNjHpfD5vFfEqYeejPzywMDV47KdGGYIqlEQEbCaUjETH9pc6C6hB3HXT1Lnco8qP+GOXyhmdFDGd3eH/H5FCWFC4KE4VNIrsEfD10FniIkMpeKYP2L+6YDSpC3Rnt5DWS+LhFdLstWRF6iRiSrcm6aO23bpmKMaSxLnytsh9Wmjn2qwHhGXytxQrzJQs04qFwmCgPQlOjyofKQqDtqPDPOUOYtkwPNkPT1oiac+r/WEyKhQV7jXYn3HVKDOFGuQ4U0TqWeEcXLTLea+RWK1Wgzw85o1Vlocrbb7YnMeiPurnxQwtYaiR+iU88cZ90N9x6ylIg/pOffr06U49XlmlEOWwNN6mBu2zeWf9qHb9TsI3zTLyjRt8WY5OPDiKqvQAylUk1AetS52fEQtqKDjebGZw8tak2y0dlxUywcclN5LPiPiTab0I+B6TSEsXKLJ7nlrxCPyjUdnSeuwlu/ZBf31r2ps+5UyM/Mj/buC7nfpRALuDowMhCJ0HQ/0x6Wkk9jbP5okz9MTcPSrbnhflb5xqf8qw7+HU8BWNGbyeRnf4p+3cO+87vD/fRClX84LPST7opf7Li86vN7A/dPnyQ2szw6rWQtmeCMERem2vXx3xn6jYMFJ+rsXDzVcfqAdMkKZE0H7yPwKLXo4= +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customcrm.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -46,19 +46,11 @@ Headers to pass to downstream Query parameters to pass to downstream -
    body object
    +
    body object
    Body to pass to downstream (can be string or JSON object) -
    oneOf

    MOD1

    - -Body to pass to downstream (can be string or JSON object) - -

    MOD2

    - -Body to pass to downstream (can be string or JSON object) - -
    +
    oneOf
  • string
    • Passthrough response @@ -66,33 +58,9 @@ Passthrough response The response headers from the downstream -
    body object
    - -The body from the downstream - -
    anyOf

    MOD1

    - -The body from the downstream - -

    MOD2

    - -The body from the downstream - -

    MOD3

    - -The body from the downstream - -

    MOD4

    - -The body from the downstream - -

    MOD5

    - -The body from the downstream - -

    MOD6

    +
    body object
    The body from the downstream -
    +
    anyOf
  • string
  • number
  • integer
  • boolean
  • Array [
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/crm/unified-crm-api.info.mdx b/docs/docs/api/v2/crm/unified-crm-api.info.mdx index 680da932c2..76dd75bcac 100644 --- a/docs/docs/api/v2/crm/unified-crm-api.info.mdx +++ b/docs/docs/api/v2/crm/unified-crm-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/crm/update-account.api.mdx b/docs/docs/api/v2/crm/update-account.api.mdx index 60584c3c45..40c3fd5afc 100644 --- a/docs/docs/api/v2/crm/update-account.api.mdx +++ b/docs/docs/api/v2/crm/update-account.api.mdx @@ -5,7 +5,7 @@ description: "Update account" sidebar_label: "Update account" hide_title: true hide_table_of_contents: true -api: eJztWntz27gR/yosOze9TE2JektOr63lR6okjl3JziVje3QgCUpISIIGQcmKR9+9uwApkbScxLm7mf5h2WOLxGKxb/zA5b3JYyqIZDwaeea+mcYekfTAdXkaSXPPlGSWmPtXZnYnMW/2zIS6qWByBffvzTuLxMz6TPHqZg2jMREkpJKKRI1HcAF87yw3TSQPqbCYB3xZBDfnlHhUwFXizmlIzP17U65iJE+kYNEMRugdCeMAb4WrLYuGud4zPZq4gsUoOgxfzKmRjxujI0POiTTSiN2mNFgZzKORZD6jCQwUCFlkrHgqDBLHAXOVGWBRQW9TJijYQ4qUrvcKWsSCL4CZsNSdH9EjIQFNfC5culuJfAUjW+FRYYh2yXRrz5jI+YMZ3yeV3ez0XcftWl27aVvtlk2sfrtPLUJ84jrE89sE5EX/IneayCH3VsiyupjLIwm2xqGCUeufElTw/qEs3PlEXYw00BsiUYKLNFuXC+/bdCX7PVQwSoOAOKihlm6r8AjEnOnANw7OR+gLFnkQF2L1NEYw+W8JTtduecrUifpiHGbRqJikoUPFlPtTCmN8RbWaGU+GQqtIe5Rps9e1bRs4LamTMPlEieZSxsl+vZ6kMZkFKa25PKyjXMTzBE2SkjRECLLC2JM0TL7tqozFVFPtCEbQHUtNLFhIBDIOCQv0GIesRbUdFmR3kjmLY/x6A9K5qho9zfSRcSJI5LLE5aigyqWn+v5ycoBzY55IEkxd7j3R3IN2w+4hB5j/VFcdHuiJglI5bTxtbqfZMYagfUSiApPmk5jgwHpdrDZXZRdnbtmatmyoXOmCDgVJ0Kubpa6qwbP1fu77ikML/gQnVVbO7b4xO9qyaMqSfYrmUTpDDZRMKjtuswKjYM4jOtUJ/DvSpMjmaV79e6Pd6DSarXan26sK9JSs45Bl6Bef3G1S76bq6pKYu9aqerCsV1nYnbJuRCpavGxkWIIvI5jBvCcmnt+ig57vWW2vA3+o71qDzsCzHIc6sOHZvYHfQe4B86m7cgM6hVCZfV+GZgZNUge3Jm2eABCCKmjiM5Uw7zYlAcIRLxtQoKB6k8cxFxIwjM6ifJeAJRYkmtGAJXLrn62JqjKv87lT4B14O0MQApnhVkiC80IwaoXKEEVvVsY2Zg3JDYcCkkrgmnoaeBFBjYhLw+ULCgFjOCuNu3gYwn6rl60ZZ+q/AeAxMULga4REunMD3ORKAG3AWE8SkGQxjzww3BYewb5bM7dal1XEaN2MCApZPtXIdpqhJrMazxnggDjXI7hgtt01bfsB1MgBsaHZeuYfhnyoEPz31A+PStg2d0XqQ6zpQ+waakEjhDoG0WL4AryLZhc05JIa55m9awZO0EoYJPKMgC5oYHDf0AsaS9iajQXkKzp7M6sEMu+vTSzA1+Z+27b3rk0HMCRcwG0sxGkC36+1/tcmDGciqbtZWK5gBYAlibGkWYTBNfP2jav7a/yYLHmPN/TFvk+ChO7pi5ybHtH/Nlyvix9zOiUOT+UUJCrdNzwOS+Oq9A6ST9/M2GuxS8zHZ+fH44uP06Oz48m7i+nxh9HkojQHEWNpSmXhnC7gLij1hXrHuMjpn6TI+kZZXaVbkJ0Ile2JO2g3O00okbbTsdodr2kRr+FZAzLwe91Ow+t5TT0VMmHGxUrNen/wdnR0cDE6ezc9Ho/PxrAAkOijUqK9DrkIuliYOIIHFgkCvrQgXdVhDVyn+Cgfava+5RIIQKsQLUcf3x2cjg7zccgUdbtvd1peo+cMPEIH3W7bmrzOaHgUQdaAcorODXjOXGevFdBoJudqsNVtlIYwn7RBKun90p0TkVD5Syp9q6/mYFFQtKc82jMaDWNCY6NpN1tGs7Xfaew3m8ar0wtFGtFAUWYRnKTKKlNfEC2n9rNdsxtZOAiK+8JU8lIIgPbIqRg3IbmbbiOla7f7cDJQa2oWFrAorEwjL+ZwxMiCbz/PqVQEpZXyQwKpwYI1MGHq+QFUfHVY0Jzri9a/kl9OZsv0w5lz9lPz5EuXzC9fv0nuPh29JR8ufv3E+eu+HNrL9k/NIfy+IWnwaiLv7JNXn6PGOX/Nz+6ab8TJqc/mX955/sEt+3zbOwxnjheEyzfD/vxzGLfohdPt38azhv32w0kwnrHJ7Xju/HraW32c+Lx/+CE8H7p5dGdGmQmexj9uOdjlYEvLgyfTXI9AnXXBpoAbE2Xd/DmJIgaOFnD8pdXotPCE9hJ2TDdIPTpJnSMOJ50oeQmbGw048RQ7LKVqJhdsxiCIYMehsbSOI6ihUNAV0Z1VDE6Lq+KuMyPiScR8PyOj0YKvrDRGLEtCC7VgLrUkC3WYDho54WKFKsAY4gsaZbrmF1Pl/Ae0YFNJURafzVJ9qt4xrQ4Z/sjUXCBVEtU2gAJDTml7Qj3KNoXiVOULAG0rK+a6VDHi2c36PHXwoZT06lpt2CDvVlYXytig33U7XWtwl8ybD9gtGKAtElhzOCvoPN+ICxzBp9IqFEeLPbE6brmAgQC9hUxaeKAXsIVZIR5sIWAA5Wj3NSBG7EfnQTTlVI/SwAYOUaUiBR08eJRQLxusMo7fpKtyziZkD4Z+wC7K/GpSc9gYtlv9bqvb7HUGw+5B+7AFudc8OGp0+8O+3To6OmwMj3s9++EHcnx9rc6z4G8A5OGjZ56HQGiSPe/IwBCiFIMkCXcZgjvANnKuQJEaLoOa09FkMnr3ajo+/u/laHx8ND0ZHb89MrcA9FvrHxiOYBRx1OYuwqrtclXkheyQIods34G8vg6f0GqV01qOIp8x2zNme8Zsz5jtGbM9Y7ZnzPaM2f4czFaFbObw4EgBquPJhd6JCk/6vo1lbgpP/7LHadgQIwL1/xMerX0Tcj4OBtfFJ5UbCdf6U0WKl+pZo0E23fmQyjn3dOfXxdav6gDvm/WMJKnfb7vEa3zOrCqh7szDFlHo+EHy1TZdP8brrgjri+YDsLoByqpnWngZYIL4VJup8ErA1tIxe0PR1JtOek5T7aFXwPH5CJ8P47NgBTUAJS+g3oJT1INnjUYUVlYCgclwcx9ve9THOagt9pTLa1RbwcVOcNbe3chdbdk+0rHVXdhCE/aRzmqpsfp/1+aqdLR+dxNn26v5vgbMjv5Lua1S7WuonGGRz9HJGOjawXat0a0NCiXkMlJ9FuNwfJp5HLdkwG44L/d05ig8R4X6LORxN/l30YEwVs6i0uCD/P0rfIwRAmcv1TgRfn6lARDTvNuRi4aB/zPI9wJwv5uGABdUgNaMjzw1XIiCNIE5c5YoSpi8hCxUXMI0kAyDFEaFZ8UEa2XeNknUWZZFai1UP8f/NZTl6j2jy7xLk504fTgPA+HNz7mOaIVaKYxj2F2BLKzrmZaemWANeaHY/uVqnEb4ss05xGdIoi0zkUY1ADhhhDXHSaUEFZPF7MWWYrlc1mI9TS2Wr1xfcvE5iWEX2tyy4tQBkF/HptMCNFGLK6MPSaIqhHE5fnsd/fbbb9fR1wtfRpR392HxQmg8qMO730KR9E6ibZhiowLlPqvQV/nbO1ha9gtv8kCWIJRBivt7B6S+FMF6jbehogn1ktUewkymW454UmcJfvfyk3NVmE1byvx5nPW7XhiYC7uEzKt1hHVZ7a9wBV9VMS++caT22Kxm/7AUf+Q7WzvV0WJX3z3b6IUvU/2w4NX3tL4qQPW1sZIImugwOxRc6HcncooHrcTtDH24+CrtTQEjnB9cHP4H36HJ3twK9SYhyBLfGYO/++Y1/KjGszqSqD0T79+bAYlmqS7AmjEWWpJiKBe3eL2fZ18wLHbGU3Hv15rgX9RrJ/k/MG8BPPxzQ65HHp2wgRKamilEuF7/D1X77hE= +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/update-contact.api.mdx b/docs/docs/api/v2/crm/update-contact.api.mdx index f1167a7422..bb005ef444 100644 --- a/docs/docs/api/v2/crm/update-contact.api.mdx +++ b/docs/docs/api/v2/crm/update-contact.api.mdx @@ -5,7 +5,7 @@ description: "Update contact" sidebar_label: "Update contact" hide_title: true hide_table_of_contents: true -api: eJztWntz2zYS/yo83nSmmZoSqbfU691JfuSUxLFPsttkbI8KkqCEhCRoEpSsevTdbxcgJZKWk9hNZ+4POxlbAhaLfeOHx73OIxoTwXg4dvWBnkYuEfSQh4I4Qj/QBZkn+uBKz1oS/eZAT6iTxkysof1evzNIxIzPFL/dbKA3IjEJqKBxIvtD+AJ87wwnTQQPaGwwF/iyEBoXlLg0hm+Js6AB0Qf3ulhHSJ6ImIVz6KF3JIh8bArWOxaWvjnQXZo4MYtQdOi+WFAt79fGR5pYEKGlIbtNqb/WmEtDwTxGE+goELJQW/M01kgU+cyRZoBJY3qbspiCPUSc0s1BQYso5ktgFhuy5Tl6JMSnicdjh+5XIp9By2Z4VBhHuWS2s2dExOLBiG+Tymy0e47tdIyO2TCNVtMkRq/VowYhHnFs4notAvKif5E7TcSIu2tkWZ0MpQJbY1fBqPVPCSp4/1AWbn+iMtJAb4hEAS5SbB0eu1+n81iciJmyyEP9wtT3iY0KKuF2+r6mPJ5LD/jkWQw+IAEMJ47D01B64UnjO61217I9zwArE6PV6vSNvkdMg1KLmDaxmz3blfxdN6ZJorTN2JM4Jmt0uqBB8nUbZSxmimpPFIRpgDkexSwgMTIOCPNVH4d0wci2mZ+1JAsWRfjxBqRzZBl4it5TEmonMQkdljgcFZTmi5/I5XI6xLERTwTxZw53n+i9fssyu8gBxosnjj0cqoExpWJmPW1su9HWRqB9SMICk8aTmGDHZlNM86uyizO37ExbNlSudEGHgiTo1e1UV9Xg2Xk/933FoQV/gpMqM+d235odbVk0Zck+RfNInaH4CCakHXdZgeJiuM6+Q6KUGH25Xi6o7/N/J2lE5n5Kaw4PHkjyhHxb8fjzNtluqs4ti7V3lqrXKprsE3e/tEqUoqmr1sW0W/CQzkALW67yzzV3kc3T0ugnq2W1rUaz1e50qwI9pcxxKGuYCB65e9z8JTH3zVU1flmvsrB7Zd2KVLR72cgwBV+FMOKp60zfa9J+13ONltuGX9RzjH677xq2TW1Y2s1u32vLZZB51Fk7Pp1Bbs6/rSRmBk1SG0GMMo8PWEiuIPFnKmDcbUp8BF5u1iHhT7WRRxGPBaA1VbYydIY+W5JwTn2WiJ1/diaqyrzJx86At+/uDUEIZIaIhPjnhWBUCpXB2KFkpe1iVhNcsylgxgS+U1dBTBJTLeRCc/iSQsBo9lohTB4EPNTUtDXtTP7VACYnWgB8tYAIZ6GBmxwB8BQYq0ExJFnEQxcMtwOCw/NxTd9pXVYRo3XbE1MoqzOF4WcZPtSr8ZxBq0LUSkMd5yFzry8JFIkyCivirBw8lbCTAkRlPKSbDjXbbcsyiGs7RstqtQxitvpGp9O0nC4lTdtsgXzyB4VE3bMK3jBN/FNxiVJJUxq6+neDmzSO+Z8pZS4VUCX3Jc1DgO9BGmlyQi2AkgqBq3kxBBpGQEwDLqh2nrm+puEApYRGQlfz6ZL6Gvc0NaG2AlimLaF0YNxtR5VWqvtrHRffa33QMs2Da90G4A5foBkX4TSBz9dK/2sdujORZGuWIWtNBkSirWgW7PCduQPt6v4af3SW/IoN6svAI35CD9SXnJvqUX+2XK+LP/psRmyeihlIVGrXXA5T46z0DuqAaszYK7FLzCdn58eTi4+zo7Pj6fuL2fGH8fSiNAbDtTSkMnFO53MHlPqDusc4yelfpMjmRlpdZr6fbcOl7YnTbzXaDajWpt02Wm23AUlkuUaf9L1up225XbehhkImzHm8lqN+Hb4bHw0vxmfvZ8eTydkEJgAStT9NlNchQUEXAxMn5r5BABisDKgccocMrpN8pA8Ve89wCASgUYiWo4/vh6fjw7wfMkU298x207W6dt8ltN/ptIzpm4yGhyFkDSgn6Ryf58xV9ho+DediITubHavUhfmkDFJJ75+dBYkTKn5JhWf05BgsCpL2lIcHmmVpUxppDbPR1BrNQdsaNBra69MLSRpSX1JmEZyk0iozLyZKTuVns2ZaWTjEFJeomeClEADtkVMxbgJyN9tFSsds9UxzI+dULAxgUZiZhm7EWSiy4BvkOZXGfmmmhRBRMqjXSQ0mrIEJU9fzYfFBLFdXnOvL5r+SX07mq/TDmX32Q+Pkjw5ZXL55m9x9OnpHPlz89onzNz0xMletHxoj+P+WpP7rqbgzT15/Dq1z/oaf3TXexienHlv88d71hrfs8233MJjbrh+s3o56i89B1KQXdqd3G80t892HE38yZ9PbycL+7bS7/jj1eO/wQ3A+cvLozowyj3kaPd9ysODC6poHT6a56oE664BNYc+QSOvmh1OSGDgawPGXptVudkzT/BkWb8dPXTpN7SMOwDZMfoZ1lvqcuJIdllI5ksdsziCIhhAXkTCOQ6ihUNAl0Z1RDE6Dy+KuMiPkScg8LyOj4ZKvjTTCfQwJDNSCOdQQLFBh2rdywuUaVYA+hDo0zHTNv8yk8x/Qgk0FRVk8Nk/VGd6eYXXI8EeG5gLJkiiXARQYckrZE+pRtigUh0pfAH5cGxFXpYoR12zUF6mNJ4HCrSu1YYG8WxsdKGP9Xsdpd4z+XbJoPGC3ZAD8iG8sYJ+o8nwrLnAEnwqjUBwN9sTquOMCBgIgGTBhQLaBDjBngIcaEDAAuJT7LIgR89FxEE051aM0MW6XQhkp6OD+o4RqWn+dcfwqXZVzNiA7jXuGXaT55aDGyBq1mr1Os9PotvujzrB12ITcawyPrE5v1DObR0eH1ui42zUf/kCOb67lWQb4G/YGwaPbr4dAaJptRzMwhChFI0nCHYbgDrCNWEhQJLvLoOZ0PJ2O37+eTY7/ezmeHB/NTsbH7470HRb+2vxDzY4ZRRy1bUVYtZuuiryQHVLkkO0bkNeX4RNarbJxzFHkC2Z7wWwvmO0Fs71gthfM9oLZXjDbX4PZqpBNHw2PJKA6nl6olahw6Ph1LHNTOIjMjtOgZUVi1P8vOFr7KuR8HAxuioemWwm355BlpHgpzxo1Z/skIqBiwV113e7gfbu8dh/o9Ywkqd/vruY3eOQtK6F6DgFLBF7H5AtDxGrbSxnG604c1JeNB2B1C5SH52N5R5AXzCniU2WmwjuMnaUj9paiqbfPF3Ka6sOFCjg+H+NRNR5LS6gBKHkJ9RacIs/AFRqRWFkKBCbDxX2yexhQOEv+s0fI33RPXrom/7+7tHxwP/l9Lugqt3B/+uJpd7/0bZdGe+6MyldB1bsYmVws9Li8YwChVbSZNatT6xdqzWUo74a0w8mpDLCD/KkLjstCJU+J3ErQ5HInqVqwnG7V69py1P8dfrQxImw3VYAS/v1GfSCm+Q1NLhpmyI8g3yvYIDhpALhCLnU17SNPNQeCK01gzIIlkhIGryBdJZcg9QWD3MDe2DUigkU1v+pJ5KaXhXIuVD/fKNRQlqtfGV3lN0vZ1tSDjTMQ3vyY64hWqBUVrUewDANZUFcjDTUywWLzSrL929UkDfEp1DmEfUDCHbM4DWuAhIIQi5OdCgEqJsv5qx3FarWqRWqYnCyfuY5hmkSwXG2bjCi1YTdQx4uyJWgiJ5dGH5FElhLtcvLuOvz999+vwy9XyIwofwICkxdC40HBLrl5WxwFvRNoGybZyEC5z0r5VR5weNs+KLyzgixBzIMU9/c2SH0Z+5sNNkPpi+UTuAPEo0xdk+KWniX42c232FVhtvdX+o+T7I7ulYa5sE/IvKyHWMCzSzodPsqqX3wPJhfjrLg/W4rv+aJurzpK7OrLwK1e+NTt2YJXX9F9UYDqo76SCIroMNs9XKgHNjnFgzvH3Qi1C/ki7U0BTJwPLw7/gw+tsnd1gVp7YrLCF33we6Bfwz95WS73LnJxxfZ7WEPDeaoKsGKMhZakGMpFLKAW/uwDhsXeeCqCBKUJ/ka99pL/A/MWUMY/t+Sq59EBW8yhqJmEjpvN/wA56HpS +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"first_name":"George","last_name":"Xing","account_id":"0ce05511-adbc-4144-a049-6631c7ea3b04"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/update-lead.api.mdx b/docs/docs/api/v2/crm/update-lead.api.mdx index 4937edd5bb..251d3a9e90 100644 --- a/docs/docs/api/v2/crm/update-lead.api.mdx +++ b/docs/docs/api/v2/crm/update-lead.api.mdx @@ -5,7 +5,7 @@ description: "Update lead" sidebar_label: "Update lead" hide_title: true hide_table_of_contents: true -api: eJztWntz27gR/yosOzdzmTElinr7em0lP1IlcexK9l0ytkcHkqCEhCQYEJSsePTduwuQEinLSZzmpv3DSsYSgcW+sNj9AeC9yRMqiGQ8HvnmoZklPpH0DSW+eWBKMkvNw2sTH1Pz9sBMqZcJJlfQeG/eWSRh1keKT7dr6E2IIBGVVKSqP4YH4HhneVkqeUSFxZApi6FxDhypgKfUm9OImIf3plwlSJ5KweIZ9NA7EiUhNkWrLYuGuT4wfZp6giWoNHRfzqlR9BujY0POiTSymH3KaLgymE9jyQJGU+goEbLYWPFMGCRJQuYpB4BQQT9lTFDwhBQZXR+UrEgEXwAzYamW77EjJSFNAy48ut+IQoKRS3hUmRCkTrfOTIicPyD/NpV6jk+drudanaDnWS2n27Pcbq9pQXvD7zc61Pc9c42Ti9xpKofcXyHLXWEejyU4GrtKHq1/SNG6+4e6cPcD9SToAkZDAEqYH83W48L/Op3Ho4TEq33GxVkYEhet05ptjZ1kCZmFmfJ+wEQqp9qfT+HxknIxUxxC8l0M3iEBDsc5TCECvScyGFyMjGHIZzOIO+AjmQz3ctiOOOLWKc9iXw+AeWDhlPi+oGmqvZkPJUKQFQaVpFH69TmoMPqyBnMahvyfae7/GszeA02mevQeLnEWYRJKBIuIQP2WXHyELw7rWZi363U59K931Nor5XZdUu76gSX71N2vrVYFl0c+DQ+8C5J+gKuf7iNUQ/dpNx2YLgvzlnTOkgR/oh88lc6ftIxIbJwKEnss9Tga6EFwSfFELleTAY5NeCpJOPW4/8Rl0G817C5ygPHyiWOPBnqgoFROG08b23baxhCsj0lcYuI8iQl27IZtZYrzadm6tuqowuiSDSVNdqN7J2Q3s1/M/c6EluYTJmlHcuH3jdvRl2VXVvxTdo+yubRQKkuEL2MqsKI9LQSCJu13A99q+W34QwPP6rf7vuW61A2IZ3f7QVvHZ7yAtUT9KVYp4sknSyJ+q9lvgxDHdbogyWtabrNHLNsjdpd0O9DtViURT3nxyZIc2qCdXqNp2a1232p1g7YFwj2r6TeaXc+mjcD3lSSFY6aAa0J/bwIB/zIswSS8KKUSLa4KPY4UK2ObcQzJDZcCQkqVLRpQEUGNmEvD42AhNLorjad4FPHY0GJrxrn6NgAUpkYEfI2ISG9ugH2eBDAGjPUgAXOf8NgHd2xhD1S2mrmNkKqJ63WpR1AIvqnGqlOspObucsqBRGktKC+dFI6+NxcEoUAFc2xQxRYqVJFCUf4r1V+X9J2KXinTW83LpVh/UG10RV4fHNvGr+oMIf42tLW++cOwFhWCi/+iKPlUQpHZF94PoW0AAW8ogUYEq57MoElA0GE0CBpxSY2LPAxqBg7QRhgk9o2QLmho8MDQAo0lFDJjAWUOY3AzqoI37m9MTFc35mHLtg9uTBdQKzxAM6atLIXfN9r+GxO6c5VUa75aVoaKj9RY0jzw4Zn5h8b1/Q1+TJb+hg364TAgYUoP9EPBTfforw3Xm/LHnE6JyzM5BY0q7YbPQTRKpXcslboxZ6/VrjAfn1+cjC/fT4/PTyZvL6cn70aTy8oYDNTKkB3BBV3IPTDqM/VPUMjZn2TI+lZ5XWWBMN96Kt8Tr99y2g6kcdttW62270Dya/hWn/SDbqfd8Lu+o4fCSphxsVKjfhu8GR0PLkfnb6cn4/H5GAQAid6ZpXrWIRuDLRYuHMFDiwC8W1qQRdTeEKZO8VFzqNkHlkcgAK1StBy/fzs4Gx0V/bBSVHPPbkNq7rp9n9B+p9OyJq9yGh7HsGrAOEXnhbxgrlevFdJ4Jueqs9lpVLpwPWmH7CzvX7w5ESmVv2YysHpqDCYFRXvG4wOj0TAmNDEc22kaTvOw3Th0HOPl2aUijWmoKPMITjPllWkgiNZTz7Ndsxt5OAiacCGnkldCAKxHTuW4icjddBspHbvVs+21kqlZWMCiJJnGfsJZLPPgOyzWVCbCiqS5lEl6WK+TGgisgQszPwihECEir2vO9UXzH+mvp7Nl9u7cPf/JOf3cIfOrV6/Tuw/Hb8i7y98/cP6qJ4f2svWTM4T/r0kWvpzIO/v05ce4ccFf8fM757U4PQvY/PNbPxh8Yh8/dY+imeuH0fL1sDf/GCVNeul2ep+SWcN+8+40HM/Y5NN47v5+1l29nwS8d/Quuhh6RXTnTpkJniXf7zkovlBpi+DJLdc9kGc98CmgrFR5tziWUcTA0QKOvzYb7WbHtu1foJB7YebTSeYec9gXxOkvUHNpyImv2GEqVSO5YDMGQTSAuEikdRJDDoWErojurHJwWlwld70yYp7GLAhyMhov+MrKEkR+JLLQCuZRS7JIh2m/URAuVmgC9IWQGWic21o8TNXkP6AFn0qKugRslulzqz3D6rDCHxlaKKRSoioDqDCsKe1PyEd5USgPVXMBwHJlJVynKkZ826nPMxfPwKRf12ZDgbxbWR1IY/1ex2t3rP5dOncesFswITMSWnNA1nqdb9QFjjCn0iolR4s9MTtuuYCDaMgiJi1YbWADyIxwGwgBA+BLT18DYsR+dBxEU0H1KI3ATW+sIgUnuP8ooRYbrnKOX6Xb5ZwPyI+ivsMvyv1qkDNsDFvNXqfZcbrt/rAzaB01Ye05g+NGpzfs2c3j46PG8KTbtR9+YI2vb9TuD+YbUHz06L78IRAqgGUOhhClGCRNuccQ3AG2kXMFilR3FdScjSaT0duX0/HJv69G45Pj6eno5M3xF8+AqvIHhisYRRy1aUVYtRW3i7yQHVIUkO0bkNeX4RN6bWd3WqDIZ8z2jNmeMdszZnvGbM+Y7RmzPWO2Pwez7UI2czg4VoDqZHKpK1HpsO7rWOa2dCiZH6dBy5IItP9POFr7KuR8HAyuyweoGw03h5BVpHilzhqNUL8GEFE5576+aPbwplldOB+adexP6/f5dfQaz/tVAtT3/1AZ8C6tqAcJq21u1BiveyKqL5wHGHWDjwcXI3WxVuTJCcJS7Z3SiwdbByfsNUUPb+7rC5rdm/odTHwxwtNqPJlWCAPA8QLSLMyFOgbXIERBZKUQeApr+nh7GV46Uf4fHSTvudL9MXeaVYb/X9dI2xujb7sGeuwW6Nuudh672fm265qHtzVqybE44OoiAmJNB6Nda3Rq/dIsX8X45opvHI3PVPzps3/QHcflQVOKMDWd0ORzL92d6upq3L2Kry6Kv8LHGCHu9jMNM+Hf7zQEYlrc4RSqYXj+DPq9gG2Dl0WANlQBrBnveWZ4EBJZCmPmLFWUMHgJq1lxibJQMlg62Ct8KyGYaovLoFRthVmsZKH5xfahhrpc/8bosrh7yjesAWyngfD258JG9EKtbGg9geIMZFFdj7T0yBRz0QvF9i/X4yzGV4MuIFgjEm+ZiSyuAT6KYsxdbiYlmJguZi+2FMvlspboYUpYIbmO6ylNoIhtmqwkc2GPUMertAVYooQrpw9JqjKNcTV+cxP/8ccfN/GXE2hOVFylg/BSaFTTeGWON4lT0juJjmGKh4qS+zzBX6tMhO9QHBZvHMHKQwCEfff3Lih7JcL1GpshIQr1JtgBglOmbzdxf89S/O0X++1dNTaXWebP4/z+7oWBS2CfekWyjzGt5xd4JvxUtWDzWpQqy3m+/24VfuRbZXtt0Trvvh23MQpf9/puxXffJPuiArsvtlVU0ERH+T7iUr+cUFA8uH3cjtD7kS/S3paQxcXg8uhf+JJK/npZpKuEIEt8sQ3+Hpo38A9fZ9G7GFVvsf0eKmg8y2D3BDSaMSZXkmEEl+GBxgL5DwyLvcFUxg3aEvyLdu0l/xuuVQAef9+Q655HB2xgiKZmCkSu1/8BFEQYOQ== +api: {"operationId":"updateLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}}}},"responses":{"200":{"description":"Lead updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update lead","method":"patch","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/update-opportunity.api.mdx b/docs/docs/api/v2/crm/update-opportunity.api.mdx index ac03b0ccbf..077b881e22 100644 --- a/docs/docs/api/v2/crm/update-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/update-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Update opportunity" sidebar_label: "Update opportunity" hide_title: true hide_table_of_contents: true -api: eJztWnlz27oR/yooO28mmTEl6j7StPWZpyQ+Ktk5ansUkAQlJCRBg6BlxaPv3l2AlChZztWX/yx7bBFY7GIXe/zI5b0lEiap4iIe+FbfyhKfKnaaJEKqLOZqbu1Yik5Sq39prUY5S63rHStlXiaRpn95b93ZNOH2F4ZX1wuYTaikEVNMpno+hgsQcGd7WapExKTNfWDOYxicMuozCVepN2URtfr3lponSJ4qyeMJzLA7GiUhDkXzFYuatdixfJZ6kieoA0yfTxkp5snggKgpVQQ2fZOxcE64z2LFA1AAJkqEPCZzkUlCkyTknrYHCJXsJuOSgWGUzNhip6RFIsUtMJO2HvkVPVIasjQQ0mPblSgkkFzCo5sRq9Mar2yaUDV9sOrHdub1glbX6TZs2ug4drPjtmzqO3W716u1HUbrTqNTtxZ4xsidpWpP+HNkuSnME7ECe+NUybDVzykqef9wL8L9zDwFewHdwS21n2m2npD+9+loJDIjLafjIH6iDyTOwpC6qJ3Z2VLZmoMfOAAvFCkbo/dvM86j6626U6/bYJyac+44ff373wcH+jMM39NYgXcKkqWMgHoxScEzPYZODI7rk92zAQG/AQfm0rchzBT4NWpq4jhF6cY1fkbsCWN+SgYbfFII/q2MVgv30XA+eQ96wgLqeXgI6Ig/Jb7dbHVqbhDYzS6jdrPZ7tm9gDo2YzXquNRtdF0f+YtZzORPc+8FDdbrBL7d9FvwhwWe3Wv1fNt1mRtQz+mAxyP3hCcs5PEPmA49RiePMZxJ6KfbvJP6PkdL0vCs5Kdmb+vxvq9ZkZU74/m7DI41hWuwrs5iVDISC0U8ccsgyog7N0lMRJGIiRFbIaf6P4FMnJII+JKIKm9KwBieggwIjM0iKVmaiNgH7Va5BnyrgimfK5MJ1lRcLEozkkGojE29GJdSkKZaJYLLInqvFwszg0JTE7B1x8F/67YoFR9i2GNO+4tSCZNSyPJhUSkpFjmuWLT1ENfX+0xRHm5zj4cJPACHIVogiViaQiCRQMIpo/kli4Ri5Cy3e4XgAqMEobFPQnbLQiICYgSSGQdet1TO8dCXq9bi8P4KjOSzK6vfdJydK8uFpAwXMAxBrLIUvl8Z/a8smM63pEdz95yDhBDyOZmx3NPgmvt9cnl/hR+Lp+9wwFz0AxqmbMdcFNzMjPm35HpV/ljjMXVFpsawo7Vx4gsQjVLZHU+VGczZm22vMR+enh0Ozz+OD04PRyfn48MPg9H52hpMgWtLNgQXdKHwQKmvzD9EIce/SZHFtba6Drswx1va9tTrNeutOiQkB+pss+XXodjWfLtHe0Gn3ar5Hb9ulkIkTISc61Xvdt8ODnbPB6cn48Ph8HQIAoDE4I/UnDpkYtDFxsCRIrRpGIqZDWGrERAcneajz9CwD2yPggPaJW85+HiyezzYL+YhUvRw12k1/FrH7fmU9drtpj16ndOIOIaoAeU0nS6pxQRGrx2yeKKmerLRrq1NYTwZg2yE9wtvSmXK1MtMBXZXr8GkoGmPRbxDajUyYgmBQtwg9Ua/VevX6+TV8bkmjVmoKXMPTjNtlXEgqdmnOWen4tRyd5AM089YiTUXAO2RU9lvIno3XnlK22l2AUdomYaFDSxKklnsJwLKdO58/SKmMhmuSZoqlaT9apVWQGAFTJj5QQiZvwJpvmo4V28b/0pfHk1m2YdT9/SP+tHXNp1evH6T3n0+eEs/nL//LMTrrtpzZs0/6nvw+4Zm4auRunOOXn2Ja2fitTi9q7+RR8cBn3498YPdG/7lprMfTVw/jGZv9rrTL1HSYOduu3uTTGrO2w9H4XDCRzfDqfv+uDP/OApEd/9DdLbnFd6dG2UiRZb8uuWg2kFpK5wn19zMQJ71wKaSxqm2bnHzoYmBow0cXzZqrUYb8NwLqJxemPlslLkHIqJQR19AkWOhoL5mh6lUrxSSTzg40S74RaLswxhyKCR0TXRnl53TFjq5m8iIRQpoLMjJWHwr5naWwCYZjWzUgnvMVjwybtqrFYS3c1QB5kLIDCzOdS0uxvrwH9CCTRXDvQR8khlwtmVZFSL8kaXFhnRK1GUANwwxZewJ+SgvCuWl+iwAIs3tRJhUxfEuoDrNXLzTU37VqA0F8m5utyGN9bptr9W2e3fptP6A3S2Hok5DeyogJeo4X24XOMKZKruUHOHm8Oey44oLGAgwXMSVjaBYQgmzI6ieHBwG0I45Po36H10H3lRQPUoDBRy8SnsKHnDvUUIjNpznHL9Lt8k5X5Dfaf2CXbT59aL6Xm2v2ei2G+16p9Xba+829xsQe/Xdg1q7u9d1GgcH+7W9w07HefiBGF9caYQP5w0oOBobAPQjQGiUJXQCwCIHQ4hSCE1T4XEEd4Bt1FSDIj29DmqOB6PR4OTVeHj4n4vB8PBgfDQ4fHtgrYDo9+TvEldyhjhqOYqwaiVuE3khO6QoINsPIK9vwye02qJEfrlCkU+Y7QmzPWG2J8z2hNmeMNsTZnvCbL8Hs21CNmtv90ADqsPRualEpSd+38cy16WngPnjNBiZUYn6/4ZHa9+FnI+DwUX5ieVyhwvz2USKF/pZIxFrva+IqanwTTvFw36Kbqv0raooN8Oq9+s9mAW2gHRaNL0vqBfYHSqqRMIraQ6JK1xUPRlVb+sPkOsSNe+eDTBZL9ttIwSrxmalptvK7Al/w3Dvy15VQbPZpdpAymcDfGiMD4g17gDIfAvJF05IP4020EQDZ70hsB9W+uGqA3RYINxyx6boyZg+y3qbZXvvZHNf/38/ZGmKLT2OZYuj3MdYb2P8WG+i3Jr4sX5Dud2wun3Z7CpoT+VxINCa6FHGKk6l1q70SoF7kVtjf3isD8g8MgfEhOty/QuXwruXyNyB+MJL/730RsArMLfurmuTD6Lm7/BBi0rhZwadwc97FgIxK3oNF6WDegb7ew5o28siKNL6ECrko8iIR2N9wnCKqaaExTNwd80lykLFwbfWzrhoWqT6DpLHWhaqX6DuCu7l8h1ns6JHkt/nobcA4fWzQke0QqWsaDWBmgZkUdWstM3KFIP1uWb7t8thFmPf+AyKY0TjFTOZxRWAFVGMwe1mSoGK6e3k+YpiNptVErNMCyskV2dCfkkTyP3LITvJXIDWVWz53IImWrg2+h5NdSiSi+Hbq/jTp09X8bczTE6kE6oRXnKNrdlvew9TsTuF9uGalXaW+zwvXlpreRFY9De605DHEE0g6f29CypcyHCxwGHII1K/PLCDSI+bVhveLPMUv/vFzevmrpadIevZMG87PScYGNt2W+TIGNXTJQ6u4KtOoZuddF3q8mz5yzv5K99H2KqS2frmexVL3fBFgV/e+OY7CN/cwOYrEWtbMET7OTY/Rz4rigcdvdUKg/G/SXtdKtNnu+f7fwK1m7+REAkfF0k6w3ch4G/fuoIfzNbmzkBXKxy/t0IaTzJTCwxjzLw0Q78uF1dTSfMv6BZbfapcdY0m+Bf12kr+DwxkKNv/XJKbmUcXLIu4oeYamC0W/wNsmi4b +api: {"operationId":"updateOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update opportunity","method":"patch","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/upsert-account.api.mdx b/docs/docs/api/v2/crm/upsert-account.api.mdx index e86d6826c5..8b608bc113 100644 --- a/docs/docs/api/v2/crm/upsert-account.api.mdx +++ b/docs/docs/api/v2/crm/upsert-account.api.mdx @@ -5,7 +5,7 @@ description: "Upsert an account. If the account does not exist, it will be creat sidebar_label: "Upsert account" hide_title: true hide_table_of_contents: true -api: eJztWgtz27gR/isoOze9TE09Lcny9dpafqRK4tiV7LtkbI8MkaCEhCRoEJSs8+i/dxcgJZKSkjjXm2lnLHtskVgs9o0PjydLRExSxUXYd61DK4liJtWR44gkVNae5bLYkTzCdmi91q2EhoQaigrpe0RNWfZMXMFiEgpF2COP1R7hisy575MxI45kVDF3e5dN8iRyNflteBH6CxInUSQkvCCekGRIfRbDFwfYhC75VzKOI6GAFkRWdBJbhzdWqkRs3e1ZEZU0YIpJbHmyQngAdR5tJ4mVCJi0uQs9Oeo4ZdRlEp5iZ8oCah0+WWoRIXmsJA8n0MIeaRD5+CpYrFnUrWXZXlegZtZO+iegNlUkCflDwkAl7rJQcY+D+ipPyEOyEIkkNIp87mjfwKCSPSRcMnCSkglb7uW0iKSYATNp6zffo0e8sud2JbIRSDpCSRiwcMycRHK10PZ9tGnE7c8Mn+6wFelZrHrCXaAgxe57liNCBbbAppzS1U8xCvC0qYEYf2IOhifIBeGrwISGrSOk+3W6gn6bZgkT36djtIuRbm2mPog5MdlCji77aCseuuA3uXgeI+j8lxi7Gx8+p+tQfyHHabRoJkkwZnIkvBGDNrFgRs2UJ0ehdSTsZNrotGu1GnCas3HM1TMlmioVxYfVKqQonfgJqzgiqKJc1HUli+OCNFRKusAYVSyIv+6qlMXIUG0JYdAdkz2SPKASGQeU+6ZNQFah2mOoKOZNPOVRhF/vQDpHR+vzTB+SM0lDh8eOQAV1gXmu76+HR9g3ErGi/sgR7jPN3d2v1zrIAfo/11XHR6ajZEyN6s/r22q0SA+0D2mYY9J4FhNsWC7z9eOm6OLULWvTFg2VKZ3TIScJenU11E05eNbez3xfcmjOn+Ck0siZ3VdmR1vmTVmwT948WmeogYorbcd1VmAUTEXIRiaBf0ea5Nk8z6t/re/XW/VGc7/V7pQFek7WCcgy9ItHH1epd1d2dUHMbWOVPVjUqyjsVllXIuUtXjQyDCHmIfTg7jMTz2uybsdz7X23BX+Y59jdVte1x2M29qhT63S9FnL3ucecheOzEYTK5NsyNDVoDEAGpiZjHh9mcF3Q5GemoN9DQn2EC27aoCft8kuhYRJgDJNF2SwBQ8xoOGE+wKy1f9YmKsu8zPqOgLfvbg1BCGSOUyH1L3PBaBQqQggzWZF1zBIlEOPxEPEkYDoNjKhkGjo6YsYgYMh4YXCRCAKYb82wFXKh/xMAFzEJgC8JqHKmACCpowBUAWPTSUKSRSJ0wXBr+ALzbsVaa11UEaN11aLB6siA0FEKVdEqBiCPCshhR1Jq/LM7eVwBUxWWimzSvduGvIAJ6mSGJSIEAyAcvk873RMe78TGe2Q+hawkY3A3uTfj3WvAvO6ORi/2z8A0ajujMJ9vq0ubghrSkqwA9QMBI4B/wYNhSoUypy5x15gf/EdoTCjxxQQQoE8uBlsYZKsGYOHBlzR0dAyweA99H+L6hEkJqmRrCTWVkPKVLfV0K6Y3lkIYAzFRKmHo1JVdNgpcikDzYQI0hgqjMcVCjVp9A4dm65XUfMy1/mu4WBvjd8wuLlMAqrZZbTMMPKhsqfUDmOWglhBPQu5jUkoWCMXIZZqNFYIdjBI6Kn02Yz4RHjEDGvfNoJpjKVj1Kjjr6dbC6fnWOtyv1fZurTGsMOABXuM0ncTw/dbof2tBcyqSfpsWrUUWuXOW1h945u4huXm6xY/F41/whXk49Kgfsz3zkHEzLebfiutt/mONRnQsEjUCiQrvSwtm8zJlb8QuMB9cXJ4Orj6OTi5Oh++vRqcf+sOrQh9cTxS6lAbO6HwBGcZ/Y+4pDnL+BymyvNNW18XYTzcZtO2p091vtBowgdbGLXu/5TZs6tZdu0u7Xqfdqrsdt2G6QvmdCLnQvX45etc/ObrqX7wfnQ4GFwMYAEjMQjc2XofyALrYmDhS+Db1fTG3oZjrpTa4TvPRPjTsPduhEIB2LlpOPr4/Ou8fZ+2QKfr1Qa3VdOudcdelrNtu79vDNymNCEPIGlBO0zm+yJib7LV9Fk7UVDc22/VCE+aTMUgpvX9yplTGTP2cKM8+0H1wJtK05yLcI/U6GbKINGqNJmk0D1v1w0aDvD6/0qQh8zVlGsFxoq0y8iQ1cho/1yq1ehoOkuEEMFKiEAKgPXLKx01AH0frSGnX9g9g3ajHNCxsYJEbmYVuJGABmgbfYZZTifQLI2VLSFqBAStgwsT1fJia9FLScK7Omv+Ifz6bzJMPF+OLHxpnv7Xp9PrN2/jx08k7+uHq109CvDlQvdp8/4dGD37f0sR/PVSPtbPXn8P6pXgjLh4bb+XZucenv713vaMH/vmhcxxMxq4fzN/2Dqafg6jJrsbtg4doUq+9+3DmDyZ8+DCYjn897yw+Dj1xcPwhuOw5WXSnRplIkUTfbzko9wB4suBJNTctUGcdsCmsKmJt3WyXRRMDRxs4/tyst5q4fv8J8JTjJy4bJuMTPYXFP8E8y3xBXc0OS6nuKSSfcAgimHJYpOzTEGooFHRN9Gjng9MWuribzAhFHHLPS8lYOBMLG2YrWOnQwEYtuMNsxQMTpt16RjhboArQhuiThamu2cNIO3+DFmyqGMri8Uli9ly2dKtChu/omgmkS6KeBlBgyCljT6hH6aSQ76p9AZB+YUfClCpO3VqjOk3GuKWl3KpRGybIx4XdhjLWPWg7rbbdfYynjQ12Mw5YnPr2FFaSJs9X4k4NzLJzxdHmz6yOay5gIMD2AVc2bvdImMLsALc9IGAAAxv31SFGajv7QTRlVDtpYAKHqNKRgg7u7iQ0w/qLlONX6cqc0w7ptuF32EWbX3dq9Oq9/eZBu9ludFrdXvto/7gJudc4Oqm3D3oHtebJyXG9d9rp1DY/kOPLW73bAf6G5Vqwc0W8CYSG6W5YCoYQpQC8jYXDcVsbsA1gcgRFurkIas77w2H//evR4PTf1/3B6cnorH/67sRaL0++Nv4RGUvOEEet3iKsWg9XRl7IDikyyPYNyOvL8AmtVlrLZyjyBbO9YLYXzPaC2V4w2wtme8FsL5jtj8FsZchm9Y5ONKA6HV6ZmSi3D/x1LHOX2xtOt9P0pt63HThvO2kobx0CzV15/9kdpSPg0SyVaOs/YBvvq/B2N/Bc5vfMVxIuzWcPwJaaCrxWgidpKA9VU3iqppu4cXVkNjvxMEMXVHM9A2aa3LEy5HBldbTMRdWRQXXW2MC8K7ytD+ZzNxKGCHONBXL3EtZGjPhbvae7uk6R0ZQvUpQw9mU/25zXiAXA9gzKNthbb4IbUKMhtxYIrIEYYbC+CHGaYeP8xYXiGOX7BvnrBukdgpXc5XsBO64FmKP+3En/juP7wun9/9xZaunY9HefFK4PBL/tlG/LIV/x7K58eLYsHx3pIFyfAWUHLTfF4wd9wMBDT2AXzA8TF7VKvV3p5grYdajPAMnx4DwNFAQEgByxXxYgqX9xFReYlZgrnPifeb/jyUUh+QqNG1eD/gwf0kfY7iYGpcLPr8wHYpadxGWiYb78CPK9glWHkwQAVnRcV8hHkRAHgieJ8aCGx5oSOs8heTWXIPEVx9iGVunaEcVKnR3pxXolzUM9FqqfrT4qKMvNL5zNsxPEdL2LZ1xAePdjpiNaoVKI/gjmdiALqqanbXrGWHpeabZ/uhkkIV7UuoSwDmi4ZiaTsALwKgixVI0TpUDFeDZ5taaYz+eVyHTTg2UjV+dCfo4jmANXr+woGcMSo4oHojPQRA+ujd6jsS4s5Hrw7ja8v7+/Db9cL1Oi7OYJDJ4Ljexe3/Zrf0/rc6j/kxuAJsEVe1ToSq611nH9lE5BN1Y2BQF5NglBHUDMh61PT2Mw8LX0l0t8DTVb6rtsmKiSm5P7G8QE6eSg9zd4jA1utt+w24g/DtJ5/xX5b94Q3Kq2qTPlm4663MB7C+8Rfrfg5VuBXxSgfEmxIIIhOk4XMVfmJlBGsXH0ue5hFkNfpL3LwZDLi+EVXghLryEGZjKSdI5XGuHvoXULP/oWhV5B6bkZ3z9ZPg0niSn0hi9WZppgMOWhhMEN6ReMiqwpXOSkzGMMowj+RbW2kv8NEx1Ayt9X5KZlZ4cVZDHUXAPY5fI/+loDWA== +api: {"operationId":"upsertAccount","description":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["domain","website"],"description":"The key to upsert on. Only `website` is supported for Salesforce, while both `domain` and `website` are supported for Hubspot."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"mydomain.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Account upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"method":"post","path":"/accounts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"domain","values":["mydomain.com"]}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert account","description":{"content":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","type":"text/plain"},"url":{"path":["accounts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/upsert-contact.api.mdx b/docs/docs/api/v2/crm/upsert-contact.api.mdx index 051ce06b98..b6349f06ff 100644 --- a/docs/docs/api/v2/crm/upsert-contact.api.mdx +++ b/docs/docs/api/v2/crm/upsert-contact.api.mdx @@ -5,7 +5,7 @@ description: "Upsert a contact. If the contact does not exist, it will be create sidebar_label: "Upsert contact" hide_title: true hide_table_of_contents: true -api: eJztWglz27gV/iusOjuzmZq6D8vbbeszVRLHrmTvJmN7FJAEJSQkQQOgjnj03/seQEokJSdxNjvTztjJJCbw3gPeiQ/HQ4XHVBDFeDTwKgeVJJZUqGMeKeKqyl7Fo9IVLMZ+6L3WvRaxXENQtQa+paY0+7Y8TqUVcWXRBZNqz2LKmrMgsBwgEZQo6u1m2SZPYk+T30YXUbC0ZBLHXECD5XNhjUhAJfzi0j3r34kjYw7MJPKsSxZTT7AZBT6YvSITWTm4qaT6yMrdXkVSNxFMLaH9obKwSczsTxS/7lbQGxNBQqqokLo/gg/Qe2G7iVQ8pMJmHshlaIwpJR4V8CXdKQ1J5eChopYxkkslWDSBHrogYRxgU7jciGhUVmXDXqFB0n5rcAIGIspKInafUFCeeTRSzGdgKJUnZJG15ImwSBwHzNVOhEEFvU+YoOBNJRK62stpEQs+A2HC1i3fo4dcW363EtkIVjpCaTJ3poVKdcS9JQ5VJNirYFiAttiVU6v2UeIQD9tz5M5HqiMVRoZIVmAkI9blwvs6nc+EVGNjoG29oyQIiIOKm8lt7PCScjHRNgjIdwl4hwTATlyXJ5EaM+9p/N12p9dwfN9u71Nit9vdvt33Sd2mtEHqDnFa+46n5XueoFIabVPxRAiyRPcrGsqv2ygVMTZUO6IjSkLMsliwkAgUHBIWmD4OAYux5UBamxY5ZXGMv97B7FydiE/Re0Qi60yQyGXS5aigNp94opTr0SHyxlwqEoxd7j3Re/12o95DCcCvnsh7fGgYBaVq3Hgab6fZsY5A+4hEOSHNJwnBjtUqn5o3RRenbtmYtmioTOmcDrmZoFfXQ92Ug2fj/cz3JYfm/AlOKo2c2X1tdrRl3pQF++TNo3WG4qOY0nbcZAVOF8N1/AMSpSDoy3V0SoOA/wtWNTIJElp1ebg1kyfk25yLT+tkuys7tzitnaOUvVbSZNd0d8/WTCVv6rJ1Me2mPKJj0MLR6+z3mjsv5mlp9LdGu9FpNFvtTrdXntBTyhyHsoaJ4JPF4+YvTHPXWGXjF/UqTnbnXNdTytu9aGQYgs8j4HjqOtP3W7Tf8z277XXgH+q7dr/T92zHoY5P3Hqv73f0Msh86i7dgI4hNyffVhJTg0pAcAAjjHkCQCN6BRGfqAK++4QECH28tEMDkHIj1+AQ8JIpWyk+Qp/NSDShAYDLjX82JirPeZXxjkF24O0MQQhkhoiEBJe5YDQKFeHQsRZlbWLWUhyRLYsQRAOS1SCPCKoBs8tnFALGcpYpOg5DHllm2Kp1of+3AKhKKwS5VkiUOwXYDKgWACIINkwCkizmkQeG20Cxw8tBtbLRuqgiRuu6R0P0sYHe4xSgo1XMrmBsINiXk1Jj6ceTR1cD9ME2dAROVMSMZfEItEbk/0GzfLCYLG0CCGwUMh1lFac5I1CcdhWU7cEMaWk82JmEHPwBjgHTRykVjpyO4222KLh1IRK2QgGfAEgNrIvhDgEpukMRPvyS+lw7j8o9dFoE+xaLCgEKZVsfNRWQq9UdhfDRhST9NutIuQChS9bG2SpPKVLOOxloDBXGUroiNusaqpRCPN3DGVbqVX4YftcW+QNrg0cVBtoO023Hgg91KXVBCGsUVALLF5C5mFKChlxR6zKNs6qFDEYJveEM6IwGFvctM6Dx4QxqMSbymqvgsYfbCqKZ28pBu17fu604sBOCD2hGVJNI+P3W6H9bge50Sro1LTnLLHznNK0e8M28A+vm4RZ/Kkz+hg3m48AngaR75iOTZnrMf2upt/mfynhMHJ6oMcyo0F7a5JvGVLyZdkH48OLydHj1fnxycTp6ezU+fTcYXRV4cO9UYCkNnNEFHNKMfabeKQ5y/icpsrrTVtelNEjPRbTtidtvNztNWP7qTsdud7ymTbyGZ/dJ3+91Ow2v5zUNKxTPCRdLzfXb4ZvByeHV4OLt+HQ4vBjCAEBittzSeB1qBOhiY+IIHthQ1vjchlKsN/3gOi1H+9CI922XQADauWg5ef/28HxwnPVDpujm/Xqn5TV6Tt8jtN/ttu3Rq5SGRxFkDSin6dyAZ8JN9toBjSZqqjtb3UahC/PJGKSU3r+4UyIkVb8myrf3NQ+uI5r2nEd7VqNhjWhsNevNltVsHXQaB82m9fL8SpNGNNCUaQTLRFtl7Ati5mn8XK/WG2k4CIprwVjxQgiA9igpHzchWYw3kdKtt/fr9ZUe04iwQURuZBp5MWeRSoPvIMupRASFkaZKxfKgViNVGLAKJkw8P4DVHGtwzUiuzVr/lL+eTebJuwvn4qfm2ecumV6/ei0XH0/ekHdXv3/k/NW+OqrP2z81j+Dva5IEL0dqUT97+SlqXPJX/GLRfC3Ozn02/fzW8w/v2af73nE4cbwgnL8+2p9+CuMWvXK6+/fxpFF/8+4sGE7Y6H44dX4/7y3fj3y+f/wuvDxys+hOjTIRPIm/33JQ7gGuZMGTam56oM66YFPYhElt3ey8TRODRBsk/tpqdFrder3+C6AhN0g8OkqcEw4LfSR/gcWWBpx4WhyWUs3JBZswCKJDiItY2acR1FAo6JpoYeeD0+a6uJvMiLiMmO+nZDSa8aUNqxVsDElooxbMpbZioQnTfiMjnC1RBehD7EijVNfsY6ydv0ULNlUU5+KzSWIOVXew1SDDH2HNJqRLol4GcMKQU8aeUI/SRSHPqn0BgHxpx9yUKka8erM2TRw83FRezagNC+RiaXehjPX3u26na/cXctrcEjdjgKRJYE9h423yfD3dqTlqtXPF0WZPrI4bKWAgQOYhUzZkG+gAY4Z4SgQBAwjWuK8BMVJ/lA+iKaN6lEYgfIx0pKCD+48SmmGDZSrxq3RlySlDerz5HXbR5tdMzaPGUbu13211m71O/6h72D5uQe41D08a3f2j/Xrr5OS4cXTa69W3fyDHV7f6cAj8DZut8NH97DYQGqX7+xQMIUoBjCu5y/AoHrCNmmpQpLuLoOZ8MBoN3r4cD0//cz0Ynp6Mzwanb04qm83F18Y/tBzBKOKodSvCqs1wZeSF4pAig2zfgLy+DJ/QaqWdeIYinzHbM2Z7xmzPmO0Zsz1jtmfM9ozZ/hzMVoZslaPDEw2oTkdXZiXKneJ+Hcvc5U520+M0faj3bRfju+4JykeHQHNXPj32xukIQDsnAm39JxzjfRXePg48V/kT7/UMV+ZnD8CWmnJ8CYMXjzgfoqbwVUtPw2VtbA478SpCF1TzUARWGjyMzdaXmFXXl2WM11wR1mbNLcy7xtuHlwN9d5PV3RHCXGOB3AuVjRFj9lqf6a4fdmQ05ScdJYx9OchO2TViAbA9g7IN9tYn4QbUaMitJwTWQIww3DzYOM2wcf6BRf4JRfYuovAswrx1KD51+Lb3C4XnC/9zl8lb98Y/5uK0dDv6hy8EN/d+33aZt+Mur3hFV74jW5VviHS0plc9m1uZmx13Ffo2gkU+RzZMJhOo9WqjW+3nqt11pK/7rOPhuY5Nc8+At1MH6+dNWTZlBoYmj7uybPxippZv4IsJ81f4sQaI8b3EQFr48zsNgJhml27Z1DC5fob5vYAtipuEgGz0Ylu13vPEciEuE4lXO0xqSmCeQ6ZrKWESKAYWwV7h2THBsr6+2dLbbhbpsVD9bKtSxbnc/MboPLssTDfHeDcGhHc/ZzqiFap5RWsxAAEgC2uG0zacEuvUCy32LzfDJML3ZZeQMSGJNsJEElUBi4UR1jUnUQpUlLPJiw3FfD6vxoZND5aNXMMIlzEsmOsmO04c2I/U8O5zBprowbXRj4jUVci6Hr65jT58+HAbfbm4pkTZqx4YPBca6btFd/ezxofNpdX/3wtHk++KLhR6lWkD6BB/SJeumyxV8OlHtnhBWUCsiL0PDw7Y+loEqxU2Q60X+jUkJq5g5r7+BrFEuqjocxEmscPLziket+fPwxQvvLB+5BvHnWqbslN+q6nLD7RX8CXkd0+8/K7xixMoP7MsTMEQHaebnyvz4Cqj2Loy3XCYTdQXae9y8OXyYnSF7+7SZ5ahWfIEmeOjTPj3oHILf/TbCb3z0ms6tj/A0h1NElP3jVws0iTBYMpDEIM30l8wKrKuaJmbZR6bGEXwX1RrJ/nfMecB3PxjTW56HmVYQx1DzTTwXa3+CxXDU8Y= +api: {"operationId":"upsertContact","description":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported for all providers."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Contact upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"method":"post","path":"/contacts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert contact","description":{"content":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","type":"text/plain"},"url":{"path":["contacts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/crm/upsert-lead.api.mdx b/docs/docs/api/v2/crm/upsert-lead.api.mdx index e756c51dd4..2f1b5b9885 100644 --- a/docs/docs/api/v2/crm/upsert-lead.api.mdx +++ b/docs/docs/api/v2/crm/upsert-lead.api.mdx @@ -5,7 +5,7 @@ description: "Upsert a lead. If the lead does not exist, it will be created. If sidebar_label: "Upsert lead" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zgS/is6LRbYApEt27Edp7d3F+elcNs0OTvZbZEELi1RNltJVEkqjhv4v98MKdmS7KRNrwvsh7hFEpPDGc4Lhw85vLd5QgVRjMcD396300RSod5S4ts7tk+lJ1iCndB1qbssYoXQW7MGgaVmVH+xfE6lFXNl0Tsm1Y7FlDVnYWhNqOUJShTdRr9Jmya+pr2Oz+JwYck0SbiABivgwhqRkEr4w6PQD5NTZCrt/Ssb5yrtmx1bUi8VTC2g8d6+c0jCnM8Uv90soTchgkRUUSF1fwxfQKc7x0ul4hEVDkONGSo6A45UwDfpzWhE7P17Wy0SJJdKsHgKPfSOREmITdFizaJhL6tGuwCV835rcAQmIMpKY/YlpaAh82msWMDAGqpIyGJrwVNhkSQJmae9A0IF/ZIyQcFNSqR0uVPQIhH8FpgJR7f8iB5yZd7tSuQSrExCZTI3poVK1ef+AkWVCXZsj8cKtMWuglr1TxJF3G/OkU8+UU+BJJAMIarASIatx4X/bTqPRwmJF9uUjtMwJBPU2sxsbYRRmpBpmGoTBExINTYWfgqPV5SLqeYQkh9i8B4JcDi4bywhDLwnMjg4H1j9kE+n4Hzgo5gKt3JYjzjkzglPY98MAD+wcEx8X1ApjTWzoUQIssDwUjSS3/ZBidHjM5jRMOT/kZn9a+C9jZmMzegtXOI0wkyQCBYRgfObc/EZfnFYVMK+WS6L4XpVmdZWKTfLwuSuNjTZNt3tszVTweWRuWHDuiDpJ5j66TbCaZg+Y6YdewJp2LTIGUsS/BPt4Omc+qRlRGLrRJDYY9LjqKAHwaXEE7lcjg5wbMKlIuHY4/4Tl0Fvt+F2kQOMV08ce3hgBgpK1bjxtLHtZtvqg/YxiQtMmk9igh3VsC25OHPL2rRlQ+VKF3QozKQa3ZWQXXk/933FoQV/gpMqknO7r8yOtiyasmSfonm0zoWFUloifB5TMWb+E0MgaNFeN/CdXb8NP2jgOb12z3cmEzoJiOd2e0HbxGd8SxFpjHGXIp56siTi77Z6bRDSnDS7IMlrOZPWHnFcj7hd0u1A96QsiXjaik+W1KQN2tlrtBx3t91zdrtB2wHhntPyG62u59JG4PtakgYTYwAXob81gYB9GW7BJDwvpBIjrrz/H2pW1jrjWIojXmOx1LoYVEME1RjQ46AhNE4WBtTwKOKxZcTWrDP92wJkJq0I+FoRUd4MwCBYHRARMDaDBPg+4bEP5lhjD9jZavY6QsoqLpeFHo06xwZQjnEnRZMYcDs2gOPxfKqR48NpVCdxBJ2bQAlGohZGlsVjUBnB7Ec95KPF5BrX1nBStwR2kG2Zf5O1Ia1wB1wdcTA9+ACsHGdUKCczm7/G2GBji0iE8HwKACy0zoZbGGSRiSwCRAXGvdpPVO6gf2ILSKkQAMtz7K5mAtZobcuO9eBun303m30126EDVsbZ2MIzFFh0KdAYKgybbC9tujp3ly2JB4bMgNS3fxow1eb4P3ZwnyqMqS122wyEALJDZv8IUiSZQpOAFYpLR9CIK2qdZ2umZuEAowR4zYcD2C0NLR5YRqBx4C1gAlywq1Eld91f25jbr+39XdfdubYnAPHhCzRjjk8l/H1t9L+2oTubkm7NUssij905zbIEfGf+vnV1f40fm8k/sMF82Q9IKOmO+ZJzMz3m14rrdfFjj8dkwlM1hhmV2ivnU9OYsTfTLjEfnp0fDy8+jI/OjkfvLsbH7weji9IYxPSlIRXBOV3IYY2xr9Q/RiGnf5EiyxttdZ0yw+wkr21PvN5us92EPc+dtJ3dtt+EnaLhOz3SC7qddsPv+k0zFJLklIuFHvXHwdvB0cHF4Ozd+Hg4PBuCACAxZ0lpvA4JAnRxcOEIHjoEFvPcgZSrT7PgOs1H+9CwDxyPQAA6hWg5+vDu4HRwmPfDStHNe24b9rHupOcT2ut0dp3R64yGxzGsGlBO03khz5mb1euENJ6qme5sdRqlLlxPxiCV5f3SmxEhqfo9VYGzp8fgfqFpT3m8YzUa1ogmVtNttqxma7/d2G82rVenF5o0pqGmzCJYptoq40AQM0/jZ7fmNrJwEBTT/ljxUgiA9sipGDcRuRuvI6Xj7u657lLLNCwcYFGQTGM/4SxWWfDt52sqFWFJ0kypRO7X66QGAmtgwtQPQti1MQHXDef6bevf8veT6Tx9fzY5+7V58rVDZpev38i7T0dvyfuLPz9x/npP9d357q/NPvx/Q9Lw1UjduSevPseNc/6an90134iT04DNvr7zg4Mv7POX7mE0nfhhNH/T35t9jpIWvZh09r4k04b79v1JOJyy0ZfhbPLnaXfxYRTwvcP30Xnfy6M7M8pU8DT5cctBugdYkgdPprnpgTzrgU0Bkkpt3fwiSRMDRwc4/t5qtFsd13VfAurxwtSno3RyxGFPj+VL2GlpyImv2WEq1SO5YFMGQXQAcZEo5ziGHAoJXRPdOcXgdLhO7mZlxFzGLAgyMhrf8oUDuxXAZBI5qAXzqKNYZMK018gJbxeoAvSFkBlonOmafxlr52/Qgk0VxbkEbJqaa8Atw+qwwh8Ymk9Ip0S9DeCEYU0Ze0I+yjaF4lDtC0DhCyfhJlUx4rvN+iyd4K2d8utGbdgg7xZOB9JYb6/jtTtO707OmhvsbplQKQmdGRxDzDpfTRc4gk+VU0iODntidlxzAQPRkEVMObDaQAeQGeGZGQIGkKpxXwNixH1wHERTTvUgjUCkGOtIQQf3HiQ0YsNFxvGbdFXO2YDs3u4H7KLNrwc1+43+bmuv0+o0u+1ev3Owe9iCtdc8OGp09vp7buvo6LDRP+523c0PrPHltT4qg7/hyBM9eImxCYTyC7sMDCFKAYArucfwIhmwjZppUKS7y6DmdDAaDd69Gg+P/3s5GB4fjU8Gx2+PHr0wK8s/sCaCUcRRq1aEVWtxVeSF7JAih2zfgbweh09otcpRPkeRz5jtGbM9Y7ZnzPaM2Z4x2zNme8Zsfw1mq0I2u39wpAHV8ejC7ESF29pvY5mbwg1udp2mb/S+r+K77SK9em8INDfVW2J/nEkA2jkRaOu/4Brvm/D2YeC5LN5sr2a4NJ8dAFtqxvHtBpZhcD5EzeBbHW+9ZX1sbjqx0qKzqXn+ANsMXsPmm0vCaqtaJuN1T0T12+YG4F2B7YPzgS5p5kl3hBjXqF94d7G2YMLe6Nvc1XOFnKb6UKECsM8H+W26hiuAtG8hZ4Ox9R24QTQab+sJgSkQIAzXzxCOc2BcfDawehiwrvaXi/15Bb9UwDdV+UpRvlRpX7uoUE3fUkz/OdXkMsO/VwFvXav7vgLcQ/W37yuqPVRT+75C2WadbFktFOlgzio+63LN1ZYihi5TsDjgOAzXmoljt9bo1HqFALmM8c2Pbx0OT3XomhoEqI3jsngrBKcRvW/73JPVKCkv5Or7ifJ6+gU+1gDxv58auAv//qQhENO88JZPDSP7N5jfCzi+eGkEqEdvxDXrA08tD6IplVjzYVJTwuA5JALNJUpDxcAi2Ct8JyGY8vMKntRHchZrWah+foyp4Vyu/mB0nhcMs4MzPv0Cwpvfch3RCrWiovUEQAKQRXUz0jEjJaaxF5rtP66GaYyPqs4hziMSr5mJNK4BTotiTHuTVClQUd5OX6wp5vN5LTHDtLBcch2XokxgM101OUk6gbNKHeuft6CJFq6N3idSJynrcvj2Ov748eN1/HjuzYjy9w8gvBAa2UO8cMsjvft1Netv917P5CZF7xR6jGnldPjeZ1vWlc6u+CIn37QgmSBAxK77+wkY8VKEyyU2Q44X+m0frkjBTKn8CgFEtpnoyxAmscPPLycettVvwwwkvLB+5ou9rTqbfFJ9eajzCrTb+K7vhydefaX36ASqjwZLUzBEh9mJ58K8OckpNuqk6xHm5PQo7U0Bs5yfjS7w6VH2aDAyO5Agc3xiCD/37Wv4h4+UzHFL7+XYfg+7czxN4ZgHNIYvZl+SYiQVoYfBGdkfGBV5V7wozLKISYwi+BPV2kr+T1zMAGr+tSI3PQ8OWEEcQ8002l0u/weV7dAP +api: {"operationId":"upsertLead","description":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Lead upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"method":"post","path":"/leads/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.16.9","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert lead","description":{"content":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","type":"text/plain"},"url":{"path":["leads","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/data/data-listing-api.info.mdx b/docs/docs/api/v2/data/data-listing-api.info.mdx index d9cc0ded96..f2d45d5faf 100644 --- a/docs/docs/api/v2/data/data-listing-api.info.mdx +++ b/docs/docs/api/v2/data/data-listing-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.13.13 diff --git a/docs/docs/api/v2/data/list-hubspot-companies.api.mdx b/docs/docs/api/v2/data/list-hubspot-companies.api.mdx index 7c0f1e335c..1a28815538 100644 --- a/docs/docs/api/v2/data/list-hubspot-companies.api.mdx +++ b/docs/docs/api/v2/data/list-hubspot-companies.api.mdx @@ -5,7 +5,7 @@ description: "**NOTE**: To use the Data Listing API you need to use the Supaglue sidebar_label: "List companies" hide_title: true hide_table_of_contents: true -api: eJzdWWtT20YX/itb90NDxhfZxG3qad95CZDWKTYBTBggDFlLa3uNtKvurjCC8X/vObuSJV8IcSefmivSXs79ORc9VWTMFDVcim5Q6VRCrs2fyVDH0uzLKKaCM12pVgKmfcVj3AabXr/uHw8OX7/ukIEkiWbETBg5oIaSIzjOxZjsfeySVCZEMBYQU2w6S2I6DhNGelTQMawdMDxg6RMqAqJZyHxDrs8MPFEVkOPhFF7om1cTY2LdaTQC6eu6zu6p+zJqCPZgGnFIzUiqqCHdgYa8Z+qes9mPvhQjPk6ckDvIzZARnQqfBfXPAoQzdKwrnetKJnflplrRzE8UNym8fqo81GjMa3cMn27msBpTRSNmmNJ2XcADaCWSAR9xFtzSESzBvRx19XfCVAoP2p+wiFY6TxWTxrhdGwWaghXkmhp4E1DDaobDZdUKe6BRHOK+ltfarXmtWmt34Hkd+6fued5VZb5qlu6IxEre84AFVTLjYUikCFOimEmUIJleSM4msWyCVbgmSNkSnlcX4oCC2a3mj+zbJSmYbrZ21/nrJ9EQKMoRsKSTEHgBW2TcgRMSpFgnr3r0oUOaIOJOmR2wh5ZbaLXgxT/w0t5B9+FosId/W3897j1+GPTf9aYnYc87bPbSN17v8eSxN70Me3fdWW///PFksDdbF2AAHgxM5v7qWCL3FByxzOpDzU+0kRFTNR7kHE8YDaxXfAvLUVpc0dzMR75OugdgQ2pIIjhoBewN9hcGTaxtyC02coEhqQiN45D7VgQgqtjfCVcMYt+ohKF3g3FiKTTEPfDY8jz8b5l+GRkgugzQw02lixtTjTuf1qV1bggHwVXB6IY7OoVaX96L8b5JfyIJQzpEBaIoZX2y9EN8td/9uTs9SfsDv3019R+PBuMmuIDpH5zv9va99uX0cvfo4tP0MjrZ7R18mPaj7kN/v6u74kMYRJ9Sv3XOj6OryfDPfjg6+f13NEus2D2Xif633LybXh1Mosvo6u7o4rzdj5Cbw9kVcHM1PXk4ugBnnJ43L6dB1P+j+6afrnAjTtPg4tOvyImRhoa3vkxEWTXCRlzZtSCu5vOy1a+dOkuygAsYbsIMA3Kr2EO+VEFZWKoUxTDkhkX6ZcNBNHwdNbzmWq5BF3auXTi2IoCZzrmtJ6Z1MkAYg6UwIPCDZobQBNweePdpCEGBucWnQkiD6M8C4DjITsFrfAcpKiCzCRMkiQEPMYv5uZ8DLSWT8YTwKJbKrlkG3EtIdvW1IN3GIY5jJmoaYtNnJGD3LJQWDrOMZoVdwMGI+kieQ9SNXUpbz8+U6AmwSbQBXI9AaYQOZWLKGvsJEgHXOk+7Y0lDbYXwbdbbhvsz0N97RYXPtS832g/vRNUqVmYBDRVKwAuwhKWMzqu2JH4u0JLkDCVdV4SjZq99mf4jj7ej/esbr9VeoxlLUHuI/gEXAq2ArXkrUrO22Y7e/t5GAe1NSE+xMdrzRUFpEADGbwla7VabvAMrC7D2mXmGEcUw8Nz1mOdXhY4nUmwp9Kuf294OedP2am/fNr1nLJy7dKx4RMHWlg5x6GcJcxFAAG3rXPvHvY/ng8NTcnb8fnCxd3q4kTzeh8IOE80FCl5WPQQyxrCuk3cpxPaIQt1TdUVXho0pmVCNSVnJB+DeYApvtj1YZjU4AFcGRFp6tl7KCuSRkhHiF4PCOl8t8C2ATQarQGq5AfhTGcANUwJl7hmUuaQrNB9PjK4C58ZW64iEYD2o2mcZ4JQpR2hcW0FgVe/QwlU8W6FFVrlvVCVet8lvnCXliMElMmVsS9/dhWJynR5mzMxHkGbMJOyG6JFkJtXdxqCduA7hVs4EU7eb09nzbDyX3nKDgIGUq+VWgpcCUI+F7aTq5DI3lH2J9uJ4F8iC562l6OKwS9lodV8xl9RobtolsrkzukQGiZNvmcMSqbEZq+vxCzE6Y0MNmE0ckfqaOyI/OmtL7BaUKOtrrJfOuJmQIdXchyzomiebxlZTXJ0cQguYFnEG0HCHOR7PWwVC/8P1HXn1eicvAmIZJyEC5Ur5sCFsoLnyHcxmbFrnxbjO77C6zMTdTpnY60KrO5vN6tvoNYfeOnkP3Z8rE1awxraFkOslFEvwE6zvZ65SksJBpr7NYKTE+1DKkFFRrtpGcBtbZc3mc/Q4FjyT5r6p631b85qDltdpv+00f6n/0mpfbVQCXrEUMzNE1CBwswfX9Pi2DnBoIqFWuA3B/re21GMb4/h7Moi0HJdYbOFdEIbIRpWgf0FCUNRH38TlUI5xMqJpCHEAzROHdcReYKtKjriAfV3ROOudNS4AK/ReHMOy1tA8wz1U31WxFvARRlAN2W1SLCnI4UJWAG8smEseD7FW3BBBeYPHsapEiRpWGjyPgIlh5Rt+DwUfOCG8yBRWJXwEIluoAY40ohBFTwR5ITdj12iDHpjmhkgfWmuF1rPGBWYYXI7iwfMR6jIn4pS67N1Q+85IyjC64exPbrphDa/o7BYeNraj6x027MajNBtRuOSJHGRgBJWFraUy+P1YanVsK73SZtlRQJnKhnSSld9FLeyq0rxaLEq3vJQCN6UPlVJ9k6XkTSmzwKIFwi9F+VLEboySkgZLTWIuReZblfmq5KUusmgib+ZzuzFiZiJx8jhmtmGkZgIPjezShl8aNYDz3Oczt0SFGU7iTJDGvBgJctlAFhv3rTWzLsaP0LJV5qU53xmOKVxZUZr2FX1uzP9iC+V2SntWpzvL9HAMCrtsTg5DcMtFd+fytO/n9aJlyBaqI4mEUVB3h1dv7sKfSqHw1UlrNoWBmLDTEcdiqc6yGIJAJn39//LkFNaW9bi0uDZ2+hF+QfozSgaJj+8+w+8LFsJmhuKgHB+z2LATYCCYYPvpEjTiQ5n1opRx02GAITwEF+EQGtsaNwG2rXtWjWYzTKyDU+EjxciWwsVgOQd8dAEErjoy2el0ULGfxX9pcg1CoWzXP1yfJgIz+UeA5oiKgqBKRD2GdwJjAop8I0Vd3493ih1YYcTumGUo566BJbCOqc8Wr2pxMgy5v+BuB4lbl3gHarZ6Oz89+iy+fPnyWbwQmNku2xI66iXPRUsQ/7mPD0/FxPE/9x3CgY3JruFWPzZAnzJcvM7B1oZ8riHAsQloEZefntDnz1U4n+NrNyZHvAy4xlIz2FyvlZX6Hb4iPCOKxdT1zyRufm5rxm343P5rwlfZKn/u+Jccfe3zwFdpL75tFIRv8EFx1x5c32Dv6VLMdsZ8dZrl4R3yPT8afEWW1Y8fS7p0W/Yg7cWmtLb24QDFXxQGfxwOsPJJMADKGdml3+wHVEu+JNLS3eVU7cjjv8jMxu2/IWJArv/fYnvxeWfjgUXmd7tRFVja/AM4jzGw +api: {"operationId":"listHubspotCompanies","description":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","tags":["Hubspot"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true}],"responses":{"200":{"description":"Companies","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"101","description":"the unique identifier for the company. This field is set automatically and cannot be edited. This can be used when updating companies through importing or through API."},"description":{"type":"string","nullable":true,"example":"Open-source developer platform for customer-facing integrations","description":"a short statement about the company's mission and goals."},"city":{"type":"string","nullable":true,"example":"San Francisco","description":"the city where the company is located."},"country":{"type":"string","nullable":true,"example":"United States","description":"the country where the company is located."},"zip":{"type":"string","nullable":true,"example":"94025","description":"postal or zip code for the company."},"state":{"type":"string","nullable":true,"example":"CA","description":"the state or region where the company is located."},"address":{"type":"string","nullable":true,"example":"525 Brannan St","description":"the street address of the company."},"phone":{"type":"string","nullable":true,"example":"(650) 450-8810","description":"the company's primary phone number."},"industry":{"type":"string","nullable":true,"example":"COMPUTER SOFTWARE","description":"the type of business the company performs. By default, this property has approximately 150 pre-defined options to select from. These options cannot be deleted, as they are used by HubSpot Insights, but you can add new custom options to meet your needs."},"name":{"type":"string","nullable":true,"example":"Supaglue","description":"the name of the company."},"numberofemployees":{"type":"string","nullable":true,"example":"3000","description":"total number of people who work for the company."},"hubspot_owner_id":{"type":"string","nullable":true,"example":"101","description":"the HubSpot user that the company is assigned to. You can assign additional users to a company record by creating a custom HubSpot user property."},"domain":{"type":"string","nullable":true,"example":"uos.com.sg","description":"the company's website domain. HubSpot Insights uses this domain to provide you with basic information about the company. Every property marked with an asterisk (*) can be populated automatically by HubSpot Insights once the domain name is populated."},"website":{"type":"string","nullable":true,"example":"http://www.uos.com.sg","description":"the company's web address. Filling in this property will also fill in Company domain name."},"is_deleted":{"type":"boolean","example":false,"description":""},"createdate":{"type":"string","format":"date-time","example":"2023-08-01T20:58:17.725Z","description":"the date the company was added to your account."},"notes_last_updated":{"type":"string","format":"date-time","example":"2023-08-01T20:58:17.725Z","description":"the last date and time a note, call, tracked and logged sales email, meeting, LinkedIn/SMS/WhatsApp message, task, or chat was logged on the company record. This is set automatically by HubSpot based on the most recent date/time set for an activity. For example, if a user logs a call and indicates that it occurred the day before, the Last activity date property will show yesterday's date."},"raw_data":{"type":"object","description":"The raw data returned by the provider.","additionalProperties":true}},"required":["id","description","hubspot_owner_id","city","country","zip","state","address","phone","fax","industry","name","numberofemployees","website","domain","is_deleted","createdate","notes_last_updated","raw_data"],"title":"hubspot_company"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/hubspot/companies","servers":[{"url":"https://api.supaglue.io/data/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.13","title":"Data Listing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Provider API documentation for Data Listing. You can use this API to list standard and custom objects to sync them from Supaglue to your database.\n\n:::info\n**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n:::\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/data/v2\n```\n"},"postman":{"name":"List companies","description":{"content":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","type":"text/plain"},"url":{"path":["hubspot","companies"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/data/data-listing-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/data/list-hubspot-contacts.api.mdx b/docs/docs/api/v2/data/list-hubspot-contacts.api.mdx index c396bd30bc..31ba20d04a 100644 --- a/docs/docs/api/v2/data/list-hubspot-contacts.api.mdx +++ b/docs/docs/api/v2/data/list-hubspot-contacts.api.mdx @@ -5,7 +5,7 @@ description: "**NOTE**: To use the Data Listing API you need to use the Supaglue sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: eJzdWW1X27gS/iva9MNCT0icAN1uzu49lwK3my5JoYRygHKoYiuJgi15JTnBcPLf74xkxw5Jm6bbT23piy1p5tHomReNnyoyZooaLkU7qLQqIdfmr6SvY2kOpTDUN7pSrQRM+4rHOAvmvHzZfd87fvmyRXqSJJoRM2LkiBpKTmA1F0NycNomqUyIYCwgpph0nsR0GCaMdKigQxg7YrjAqidUBESzkPmG3JwbeKIqIO/7Y3ihb7dGxsS6Va8H0tc1ncmp+TKqC/Zg6nFIzUCqqC7dgrqcMDXhbPrCl2LAh4nb4zai6TOiU+GzoPZJwOYMHepK66aSbbtyW61o5ieKmxReP1UedmjMd+4ZPt3OYDSmikbMMKXtuIAHsEokAz7gLLijAxgCuRxt9U/CVAoP2h+xiFZaTxWTxjhdGwWWghFETQ28CahhO4aDsGqFPdAoDnFe02vu7njNneZuz/Na9qfmed51Zfb8WNoDEis54QELqmTKw5BIEaZEMZMoQTK7kBwmsTDhVLgmqNkqnlXn2wEDszvNH9m376QA3WjuLuPrJlEfNMoBQNJJCFjgLDJ0wEGCGmtkq0MfWqQBW9wuw4Hz0HIDqxZY/CMv7Ry1H056B/in+ffjweO7XvdNZ3wWdrzjRifd8zqPZ4+d8VXYuW9PO4cXj2e9g+nyBnrAYACZ89VBIhMKRCxDfdjxE21kxNQOD3LEI0YDy4pvgRylhYjGahz5OGkfwRlSQxLBwSpw3nD+wuARa+ty84lcoEsqQuM45L7dAihV7J+EKwaub1TCkN1wOLEUmmnE2PQ8/GdRfykwgHMZUIdzSnLrY40Tn5Y361gIC4GpcOaGOzWFVdfPRXdfZT6RhCHto/1wJ2VzsvRdfH3YftUen6Xdnr9/PfYfT3rDBjDAdI8udjuH3v7V+Gr35PLj+Co62+0cvRt3o/ZD97Ct2+JdGEQfU795wd9H16P+X91wcPbnn3gqsWITLhP9vWjejK+PRtFVdH1/cnmx340QzfH0GtBcj88eTi6Bi+OLxtU4iLpv23vd9Bka8SENLj/+jkiMNDS882UiyqYR1uHKzAK3ms3Kh37jzFnaCzDAcBNmISA/FbvIlyoob5YqRdELuWGRXn9w4AxfZf2+11hKNchgx+yC14pAyHTcdkSskR5GMRgKAwL/0cwQmgDrAbtPQ/AJTC0+FUIaDP4sAMRBtgpe4zvIUAGZjpggSQzhEJNYJh3dSMlkOCI8iqWyQ1a/ewmprobmAZ7zcDMmGEaj/5ZT2crtZzB+1RDdeURVSqwqQoMAXFVb5VRr6XOI4gFIialIV9v6y1AaK2yPggdcaePi2ibi3lHB1mzGSiYo2u4gHkmxoZKtV/veNtnb93Zev240v9F2Vg9xnoEMYAtvkD0QzzkmxMCyxmVn+7TAqH5KoF44j5FRFLkDCcFpBB8EPb4MIJldQQ2EBMvKGsh3LhcPBoW4XIXlFVRBOWjiHK5KGAfBypETqYsTUdVpGXjmamkVuQnUwEl0cW+gHbFbc3N9FwAmw8o86UsZMirKTjmgoWZLhYYIMNBDggFMFhvCcV5PRlSDPwHUCCowW/zh4Afmp37IyBvIQlt4kNuIE/1xy6rYtqhC+j1kO5LruIZyC6r5trDbRMMpDSU5CI1cowclZ/UNRis/0+cosZnKC4ExikAdDHZepzbj3IJmF90iPhzZmIcxccJpFsOqlnSWKxwS+NAVxxbtI483Q/r73q63uwYhCHUegRo07mkzHYcHaxRYmcumz2LkZsr2yFuuJAg9hbAKNela1YphwnGqqmBQP0yc/8FFwUSQtdDOkMUMeWFRRbLPQ/ZvI97qZFngclp+poDXWd7RpnFv5O54d3IqmLrbOEuC6fderTa8lYgMXC5MshID0vLchFBuKER8TkOmwR4+KzuiG86Kltx7IyoSexJ45wBPvpTqfhDKqS6sDnzlQ2HNgGJoaAXpPAgv2hlP1FfM1To0uycsAnQVFdpnbmdrxQF9+BfE9b4xVYOWnLeodCz7WWG6UeQ4fr9GHcglVrAL1mgRFnwhQn3TXf31jtfoNb3W/utW47fab83965UIUIS7upXPZgrpM8Mwv7HlZ0J962wWJ6ROpu8wsd3ZgpWtpPKPxGuTqAWNxERZwBqEUbXuVSVGUf8+iyKhHGJ7RyO9Xb1aJRGESYBVJSdcwLy2qJ93zuuXYAF9EMcwbKMtyKH63rqzj8ZBg2TS5hGnTOPMx1aW/V+KWZHUdjmGZtxR3e4G1+PNAh3JN3wCybxG/gcvMoNBaIco5jwDEGl0GlBj98vnJZE9UQj10vcTpbACsmcNYBgIx+3B8wnaMlfijJo7mOvc6JGckpRpwxSs/dW1aOzBKzq9g4eVl+rlNgHMxqU067Mw6/WIIOsUgWvZLJnFi9PShc32A55dFm0/w910Vl86yjeGvKhfqDZLRV5WiRUFkis+8gKhyN6LGXNFEHcRqRQiFvx4pbOUDFm68eaSM4pVZs8NULoSFzfi29nMToygGJbYRB0ye/ulZgQP9Uxo3S/aJkChSd4+TFSImrP2Jo150d3kso4I65Pl2828kwr3z8qs1LI8x5aLu3CXGpfFnT3mfzM09bxZlc953qha1IcdXZiFqQQ4D+QM2ISFyBabXiA0wUlZZllAeMUQA4mKcaNOhldr7MJPpbD386Zx1lFC07fm/bR8q3PqQTiTvn5+c16048LgUgftBfwibSCdDBIf332C35cshMksz5anmYfYZjYoTLCSc+kZo0QZepGBXaMbghEuAkHYTsfi1DWzbUZ3eTZvx8Ic7EWjxogMFIzMTxaGbPhHCmD4qiHIVquFhv0kfqYmPGwK93bzy82HRGDaO4UADfVOoVAlohbDO4E+0U+MgduKngy3ixnT6bQWu2UWUI6uPoU6ScfUZ/NXO3HSD7k/R7eNyi0l3oCZrd0uPpx8Ep8/f/4k1jhmNsu2MJz2EnPxJIj/hc8oT0Xz9Kf7ouJijcnEcGse659PWVS8yUNt4fG29TgCG+Lo0xMy/kKFsxm+dv1+jJYB11joBatbE2Wb/oDPIV/YiY2oy9973IcA2zfbBOfmn0W+Cqv83eY7EX3tO8dXdc8/0hSKb/FBcVec39ziFcwlmM0Oc+tDloS3yY/8+vGVvTz/irNgSzflAJJebEpjS59AcPvzquDtcQ+LmgT5X87HLvlm/0Gz5EMiLckuJ2qnHv9GMCun/4EBAzL9f+bTi+9UKxfM876bjabAuub/NTZvXQ== +api: {"operationId":"listHubspotContacts","description":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","tags":["Hubspot"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true}],"responses":{"200":{"description":"Contacts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"501","description":"the unique identifier for the contact. This field is set automatically and cannot be edited. This can be used when updating contacts through importing or through API."},"email":{"type":"string","nullable":true,"example":"team@supaglue.com","description":"the contact's primary email address."},"associatedcompanyid":{"type":"string","nullable":true,"example":"101","description":""},"firstname":{"type":"string","nullable":true,"example":"Jane","description":"the contact's first name."},"phone":{"type":"string","nullable":true,"example":"(650) 450-8812","description":"the contact's primary phone number. The phone number is validated and formatted automatically by HubSpot based on the country code. You can select to turn off automatic formatting on a contact record, either when editing the Phone number property, or adding a phone number to call."},"is_deleted":{"type":"boolean","example":false,"description":"Indicates whether the object has been moved to the Recycle Bin (true) or not (false)."},"lastname":{"type":"string","nullable":true,"example":"Doe","description":"the contact's last name."},"city":{"type":"string","nullable":true,"example":"Palo Alto","description":"the contact's city of residence."},"country":{"type":"string","nullable":true,"example":"United States","description":"the contact's country of residence. This might be set via import, form, or integration."},"zip":{"type":"string","nullable":true,"example":"94303","description":"the contact's zip code."},"state":{"type":"string","nullable":true,"example":"CA","description":"the contact's state of residence."},"address":{"type":"string","nullable":true,"example":"4 Giro's Passage","description":"the contact's street address, including apartment or unit #."},"mobilephone":{"type":"string","nullable":true,"example":"(650) 450-8811","description":"the contact's mobile phone number. The phone number is validated and formatted automatically by HubSpot based on the country code. You can select to turn off automatic formatting on a contact record, either when editing the Mobile phone number property, or adding a phone number to call."},"hubspot_owner_id":{"type":"string","nullable":true,"example":"1450461","description":"the owner of the contact. This can be any HubSpot user or Salesforce integration user and can be set manually or via Workflows. You can assign additional users to the contact record by creating a custom HubSpot user field type property."},"fax":{"type":"string","nullable":true,"example":"(650) 450-8810","description":"the contact's primary fax number."},"jobtitle":{"type":"string","nullable":true,"example":"CEO","description":"the contact's job title."},"createdate":{"type":"string","format":"date-time","example":"2023-08-01T20:58:17.725Z","description":"the date that the contact was created in your HubSpot account."},"notes_last_updated":{"type":"string","format":"date-time","example":"2023-08-01T20:58:17.725Z","description":"the last date and time a note, call, tracked and logged sales email, meeting, LinkedIn/SMS/WhatsApp message, task, or chat was logged on the contact record. This is set automatically by HubSpot based on the most recent date/time set for an activity. For example, if a user logs a call and indicates that it occurred the day before, the Last activity date property will show yesterday's date."},"raw_data":{"type":"object","description":"The raw data returned by the provider.","additionalProperties":true}},"required":["id","email","associatedcompanyid","firstname","phone","is_deleted","lastname","city","country","zip","state","address","mobilephone","hubspot_owner_id","fax","jobtitle","createdate","notes_last_updated","raw_data"],"title":"hubspot_contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/hubspot/contacts","servers":[{"url":"https://api.supaglue.io/data/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.13","title":"Data Listing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Provider API documentation for Data Listing. You can use this API to list standard and custom objects to sync them from Supaglue to your database.\n\n:::info\n**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n:::\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/data/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","type":"text/plain"},"url":{"path":["hubspot","contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/data/data-listing-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/data/list-salesforce-accounts.api.mdx b/docs/docs/api/v2/data/list-salesforce-accounts.api.mdx index a1d3a214df..0368a768e3 100644 --- a/docs/docs/api/v2/data/list-salesforce-accounts.api.mdx +++ b/docs/docs/api/v2/data/list-salesforce-accounts.api.mdx @@ -5,7 +5,7 @@ description: "**NOTE**: To use the Data Listing API you need to use the Supaglue sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: eJzdGWlT4zj2r2g8Hwa6yEEYdmtTM1MLhJ1NDwlXaIoARSu2QhRsySPJSQyV/77vSU5sknBl2dqqoaHB1tO77zx5MmaKGi5FM/DqXsi1Oach032pfLbn+zIRRntbXsC0r3iMgAD25Uv7uHP45UuddCRJNCNmwEiDGkqOAAEX92TvpElSmRDBWEBMDnSexPQ+TBhpUUHv4azB8ILlgFAREM1C5htyfW7giaqAHPeG8ELfbgyMiXW9Ugmkr8s6w1P2ZVQRbGIqcUgNcB1VpLtQkSOmRpyNf/Sl6PP7xIm5idz0GNGp8FlQvhEgnKH32qtfe7nk3u2Wp5mfKG5SOHnyJiUa89IDw6fbKZzGVNGIGaa0PRfwAIqJZMD7nAV3tA9HgJqjuv5MmErhQfsDFlGv/uSZNEZwbRQoC06QcWrgTUANKxkOyLY8NqFRHCJcrVrbKVVrpdpOp1qt2+9ytVrtetNFyzT7JFZyxAMWbJExD0MiRZgSxUyiBMlUQ2ZsEssmGIZrgpQt4enWXBzQMbvT/JG9X5Kc6e3azjJ/7STqAUXZB5Z0EgIvYI6MO/BEghTLZKNFJ3WyDSJuFtkBe2j5Aa3mvPiNatpqNCdHnT38qf3xuPf4tdPebw1Pw1b1cLuV/lxtPZ4+toZXYeuhOW4dXDyedvbGywJ0wImByZnLOpbIiIIvFlmdlPxEGxkxVeLBjOMBo4H1ivewHKU5iu3VfMzOSbMBNqSGJIKDVsDeYH9h0MTaRt0ckAuMSkVoHIfctyIAUcX+TLhikACMShh6NxgnlkIzjTzWqlX89Zx+ITdAfBkghzAFvJWhRsCnZWGdF8JF8FSwueGOTK7Vt2Ex4lepTyRhSHuoP5SkqE6Wfo27B82/NYenabvj73aH/uNR534bPMC0Gxc7rYPq7tXwaufo8tvwKjrdaTW+DttRc9I+aOqm+BoG0bfUr13w46g76P27HfZPf/0VrRIrNuIy0etysz/sNgbRVdR9OLq82G1HyM3huAvcdIenk6NL8MXhxfbVMIjavzd/bqcL3IizNLj89g/kxEhDwztrlQIzwgZc0bMgrKbTotGvnToLsoAHGG7CLAXMrGIv+VIFRWGpUhSjkBsW6bcNh1VmWVHLru08OfdjRSBFukRFneeVkZ9G8eLbBlhwYVJ4xpRkQwWcmfoO+z7kT0B0YIvAR7HbAIWbM8Q9h4zQIIDo0u41iLOKIMqn1qXpLq9B9kRq8KADGbD1KMf2PmAO2BrUoeCbNQlrvLoWScXYu/LIKpp49yNEzwc8jj/NnXSG7X0kP9GhPkT4f+BSH6L/WU71QaKf5VbvInsykGJNGbNU+pMmMSIhrlhYrP+ik/8WZ59OihibIoA2ZF0vxBsoPs+wYCszHnB/YBWVESVummHaEjyi2uz5ho8gbBrv9INnPXfN9tx/n/fc3Zc69WV2g4LzhMAHcOgYIXbOmRcxgsCLjBKwsAYvgNbYishG2Lph264YNMs+1ERSKlncS1eBJgUYGIZw8KL6gUDdBASoHDW/0soGgPkVUbCbK/JWhW3bza5jL+yDZwqYCwttPY+SiOBIgQLVdneJP4BJysdBylG0DnPcPwQzyJSxYk/Boc+8t83MO+jPBw02w+R65LFUDwR+FxlDwsdjwdTq9uR1atB8Z3LCkKvAYpLIsdDPmxWwMzzhC2ccuIrBTcAIoVP1Jetpvm6yyo03dmjIxdmRizrdgInasKJgPSlDRsWS40KEYvMOmhoPGAjk/MV1cmRANczNTIAXjtxMj4dnzE/9kJF9CMcN5G4T3UxIQzb6NNRs0zJxoBj640tB+Pb0uyoSXwg6XCIgCpRBPMuWZAwi+I4Vl7BTDV0rxALk+ij+f3Nm08RsMrf8KTq+g5srZ6dlGgCNdGg2ToONeqm1UbYQgCy85UEh4XiHhieFvtyOfQszQRPH1mJ/nYfI8854qW1d1VAutHmLLdhCd7TcuaxsKRbr/FIJnhVHV84KJWhFcciS3aoMlAdnMZ6eu/WSNxXMVxin9HzFdJfFrDdd1Hxh5Monrtvp1AJGEJgSV3X3Vr6YmgE8VHK8FZpP5pCPRrMNVaJCXEFkSzQa83yHxmUF+ayMakuONd/X7Z00vWlhK3aOU73LzoXdWD4WxvwPhnqe70NmMIu7kIWZ7KRJAArTCw1DCR4NtStET7WbIpAN2yD0asvQFLH1JRJGQR2Oanl7B769XOuLq8lsaQGRZ5cJjsWZqBjhEeWoLVw1/rO4aoSz53p8dri0pPkRvkgTHFgGiY/vbuDfJQsBmM0y6EkWnXZlCgSTCGq1Wy7hyFtkvUyuZEJ8KNZunQoJBC8BItzbYsfqVqaYaNzKZ77xAxjceCLFiPQVnMwtC0d2J4Qu0KOalZHJer2Oir0Rf6VVLwiFsl3/cH2WCGwgMZdEVOQEVSLKMbwTGBO9xBgpynp0v5lDjMfjcuyuWYZm3FWwr9AxhQCcvSrFSS/k/py7TSRuXWIf1Gz1BlX6Rnz//v1GvBGYGZTdODnqBc9FSxD6wrL+Kd/P/eX29i7XmAwNt+qx8fmUJcbrQsLF6jfTESSyAagRAZ6e0OkvVDid4mu3VcaEGXCNTRfkWtvJvKLWT1i6vyCMTarLnyq4dXPdsxvn9/P58eX7q2wVPx1Yk6PXtumv0p5/FJATvsUHxV2jfH0LoFmN+ZgxN86yUrxJPnPH/oosi58VPNOlA9mDuhebwtnSoh3Fn/cGvx920NsTDIFiSXb1N/sD1TI7EmkBd7FWO/L4PzKzEvwXzBlQ7H+bg+efhqy8MC/9DhpVgd3NfwBwH+ah +api: {"operationId":"listSalesforceAccounts","description":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true}],"responses":{"200":{"description":"Accounts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for this account."},"Description":{"type":"string","nullable":true,"description":"A description of the contact."},"BillingCity":{"type":"string","nullable":true,"description":"The city of the billing address of this contact."},"BillingCountry":{"type":"string","nullable":true,"description":"The country of the billing address of this contact."},"BillingPostalCode":{"type":"string","nullable":true,"description":"The postal code of the billing address of this contact."},"BillingState":{"type":"string","nullable":true,"description":"The state of the billing address of this contact."},"BillingStreet":{"type":"string","nullable":true,"description":"The street of the billing address of this contact."},"ShippingCity":{"type":"string","nullable":true,"description":"The city of the shipping address of this contact."},"ShippingCountry":{"type":"string","nullable":true,"description":"The country of the shipping address of this contact."},"ShippingPostalCode":{"type":"string","nullable":true,"description":"The postal code of the shipping address of this contact."},"ShippingState":{"type":"string","nullable":true,"description":"The state of the shipping address of this contact."},"ShippingStreet":{"type":"string","nullable":true,"description":"The street of the shipping address of this contact."},"Phone":{"type":"string","nullable":true,"description":"The account's phone number."},"Fax":{"type":"string","nullable":true,"description":"The account's fax number."},"Industry":{"type":"string","nullable":true,"description":"The type of industry in which the account operates."},"LastActivityDate":{"type":"string","nullable":true,"example":"2022-02-27T00:00:00Z","format":"date-time","description":"The date of the last activity on an account. The LastActivityDate is set to whichever is more recent -- the LastActivityDate of a related task or event or the LastModifiedDate of an account's record."},"Name":{"type":"string","nullable":true,"description":"The name of the account. Maximum size is 255 characters."},"NumberOfEmployees":{"type":"integer","nullable":true,"description":"The number of employees that work at the account."},"OwnerId":{"type":"string","nullable":true,"description":"ID of the user who owns this account. This is a relationship field."},"Website":{"type":"string","nullable":true,"description":"The account's website URL."},"IsDeleted":{"type":"boolean","description":"Indicates whether the object has been moved to the Recycle Bin (true) or not (false)."},"CreatedDate":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z","description":"The date and time when this contact was created."},"SystemModstamp":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z","description":"The date and time when this contact was last modified."},"raw_data":{"type":"object","description":"The raw data returned by the provider.","additionalProperties":true}},"required":["Id","Description","OwnerId","BillingCity","BillingCountry","BillingPostalCode","BillingState","BillingStreet","ShippingCity","ShippingCountry","ShippingPostalCode","ShippingState","ShippingStreet","Phone","Fax","Industry","LastActivityDate","Name","NumberOfEmployees","Website","IsDeleted","CreatedDate","SystemModstamp","raw_data"],"title":"salesforce_account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/salesforce/accounts","servers":[{"url":"https://api.supaglue.io/data/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.13","title":"Data Listing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Provider API documentation for Data Listing. You can use this API to list standard and custom objects to sync them from Supaglue to your database.\n\n:::info\n**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n:::\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/data/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","type":"text/plain"},"url":{"path":["salesforce","accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/data/data-listing-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/data/list-salesforce-contacts.api.mdx b/docs/docs/api/v2/data/list-salesforce-contacts.api.mdx index 3450953d73..2e432046d1 100644 --- a/docs/docs/api/v2/data/list-salesforce-contacts.api.mdx +++ b/docs/docs/api/v2/data/list-salesforce-contacts.api.mdx @@ -5,7 +5,7 @@ description: "**NOTE**: To use the Data Listing API you need to use the Supaglue sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: eJzdWelSIzkSfhVtzY+BDnxguvdw7GwsjZkZ92A3h2mCK2i5SsYyVVKNpPIB4XffTKnsko/mjtiIaQx0laTML+9U8hDIlClquBTNKKgHMdfmhMZM96QK2Z4UhoZGB1tBxHSoeIobYduHD+2vnf0PH+qkI0mmGTF9RhrUUHIABLi4JbuHTTKRGRGMRcQUm06ylN7GGSMtKugtrDUYHrAICBUR0SxmoSGXJwaeqIrI1+4AXujrjb4xqa5XKpEMdVnndMqhTCqCjU0ljakB1ElFugMVOWRqyNnop1CKHr/NnJibiKbLiJ6IkEXlKwHCGXqrg/plUEgeXG8FmoWZ4mYCKw/BuERTXrpj+HQ9hdWUKpoww5S26wIeQDGJjHiPs+iG9mAJSHNU158ZUxN40GGfJTSoPwRmkuJ2bRQoC1YQODXwJqKGlQwHYlsBG9MkjXFfrVrbKVVrpdpOp1qt20+5Wq1eBNNlyzR7JFVyyCMWbZERj2MiRTwhiplMCZKrhsxgEgsTDMM1Qc6W8XRrLg7omN1ofs+eL0kBeru2s4qvnSVd4Ch7AElnMWABc+TowBMJciyTjRYd18k2iLjpwwF7aPkCrRZYwkZ10mo0xwedXfyu/XG/e/+l0/7cGhzFrer+dmvysdq6P7pvDc7j1l1z1No7vT/q7I5WBeiAEwPImcs6SGRIwRd9qONSmGkjE6ZKPJoh7jMaWa94DuRkUpDYXo9jtk6aDbAhNSQTHLQC9gb7C4Mm1jbq5hu5wKhUhKZpzEMrAjBV7M+MKwYJwKiMoXeDcVIpNNOIsVat4q9F/l5ugPgywA73eHQrA40bH1aFdV4IB8FTweaGOzaFVp/eixG/Tn0ii2PaRf2hJL462eRLerHX/HtzcDRpd8JPF4Pw/qBzuw0eYNqN053WXvXT+eB85+Ds2+A8OdppNb4M2klz3N5r6qb4EkfJt0lYO+Vfk4t+9/d23Dv65Re0SqrYkMtMvxbN58FFo5+cJxd3B2enn9oJotkfXQCai8HR+OAMfHFwun0+iJL2b82P7ckSGnE8ic6+/QuRGGlofBPKTPiqETbgfM+CsJpOfaNfOnV6soAHGG7iPAXMrGIPhVJFvrBUKYpRyA1L9NOGwyqzqqhV13aeXPixIpAiXaIKneeVEU/DP/i0ARb57BLvGVOSDRWP+n5Cefxyup2CzM+aMCRCaBRBTGlLdje0RlqvisdJQ6DnOKkjYuP+ZxflUJJAW26DpyfSwSf4UEi0sTWl7vOUgFbjyAL6lStt2jZxvU3WHhIimAJJlmJm/1glYR8qZYiF0vL6HfLQYV+KN/PqAyGSIiXifNySb+oGNBCG+brtShkzKlb8rCkizFWQI0d9BgpUVovOcUmfamgTmIBaOXQtDC4es3ASxox8hkS6gRg3CbilkIZs9Gis2aYFcUC12Q0NH0L3AF3RWlGfrvg1W/H/Ma/4F89SEJKb+UgMOMBRHBCCDZbvFIws40Qn0cygsKM+h7Q9xJKB7YJi4DshelepZEmvHAWWuX+htqi+Q8UAAXRINT/SyhuP4khhUJdb5gp8D3+0CkB3LEO/OeZJlhDsZlCmf6545gFU5xMojuEr2Wp7dq57oGbJtiD8gcSe7SRfJY41nqOaOGKzdLIS6z5DTA/qtTzd4VewPZQaytCejF6pxdSeB8oRewV3uDWsD7dnmM94kWNZDp7LUzH2rG5kHVM8+yJBZZfH75NBE0tqNYd+HQmm3lad4LqnIIdIIkdCv7QcvYtwK1L9SsdvLm907FPsuBbpbTRtn2XJ7SmGyfN9C8YPCgTetJEEVj6xYB8ygsIXOigW1slEQ2sHiRsCJEn/38hsRp9dXy0+RUc3cHLtBWOVB+xGPjS/c0Kt6k5c8+RuzWDZrQDij+MZGh96zau9Gy01zk282/lN6Kxp9Ls8v8HyGyC/W1nTNHhlcKE4LZaUlXy/LhMv5cfl1LWYVYoEMAtFFzwzh1/01BUH8SziXSP0fLRyk5szmC4r07tqFDeN6+nUbkygQ5M4orq1gFNq+vBQKehWwuJGCtlnOJvMZCrGq3c+PKIpL2ZHXFYQZ2VYW/GV+Zxq97AZTL1p0AneZt1dxpsJFdehlP/B0AjzOcBsz/IMYOkuctgksAtbLxrHEpwUeqcYnc9OSKDbx4KAjmoBTZFaTyJjFNTRqJa3d+ATFFpfHsnll3XUfn0+qpiJikHrLjwBjtj+64/YYG1RjwuLK8OJn+AfaYI7yigL8d0VfJ2xOMSePW+lD/OAs6NCYJgl0Cu6oQpe9XzoZXIuMxJSkY8RISfgISCE80qs3G5UiLnDjTrmky7Yg5M+5JiQnoKVuWVhyc5C0AW6VLMygqzX66jYK/FXGnGCUCjb5d8ujzOBMyBMDQkVBUOViXIK7wTGRDczRoqyHt5uFjtGo1E5dccsoBm6ykiqO51SCMDZq1KadWMeztFtInPrEp9BzVZvp8cHV+L79+9X4onAzHfZSYvj7nkuWoKEPxhSPxRzqb/cvNrlGpOT4VY9Nj4f8sR46SXcIujtYKcPasQNDw/o9Kcqnk7xtZumYsKMuMbmBXKtvdI+otZ3GDb/QBibVFen6W7MWg/spPX5OF8+dH4Ulj8VfyWix6bIj/Kej8ALxtf4oLhrOC+vYWteY15mzI3jvBRvkvecLT8iy/KMfEGXbgs0USw13trKgBnFn/cGv+13sH3LMAT8kuzqb/4fVMtsSUw82n6tduzxJ4JZu/3fmDOg2P9nvr34K8DaA/PS73ajKrC7+R/4HYEL +api: {"operationId":"listSalesforceContacts","description":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true}],"responses":{"200":{"description":"Contacts","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string","description":"The unique identifier for this contact."},"Description":{"type":"string","nullable":true,"description":"A description of the contact."},"Email":{"type":"string","nullable":true,"description":"The contact's email address."},"AccountId":{"type":"string","nullable":true,"description":"ID of the account that's the parent of this contact. This is a relationship field."},"FirstName":{"type":"string","nullable":true,"description":"The contact's first name up to 40 characters."},"HomePhone":{"type":"string","nullable":true,"description":"The contact's home phone number."},"IsDeleted":{"type":"boolean","description":"Indicates whether the object has been moved to the Recycle Bin (true) or not (false)."},"LastActivityDate":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z","nullable":true,"description":"The date of the last activity on a contact. The LastActivityDate is set to whichever is more recent -- the LastActivityDate of a related task or event or the LastModifiedDate of a contact's record."},"LastName":{"type":"string","nullable":true,"description":"The contact's last name. Maximum size is 80 characters."},"LeadSource":{"type":"string","nullable":true,"description":"The source of the lead."},"MailingCity":{"type":"string","nullable":true,"description":"The city of the mailing address of this contact."},"MailingCountry":{"type":"string","nullable":true,"description":"The country of the mailing address of this contact."},"MailingPostalCode":{"type":"string","nullable":true,"description":"The postal code of the mailing address of this contact."},"MailingState":{"type":"string","nullable":true,"description":"The state of the mailijng address of this contact."},"MailingStreet":{"type":"string","nullable":true,"description":"The street of the mailing address of this contact."},"MobilePhone":{"type":"string","nullable":true,"description":"The contact's mobile phone number."},"OwnerId":{"type":"string","nullable":true,"description":"ID of the user who owns this contact. This is a relationship field."},"Phone":{"type":"string","nullable":true,"description":"The contact's phone number."},"Fax":{"type":"string","nullable":true,"description":"The contact's fax number."},"Title":{"type":"string","nullable":true,"description":"The contact's title."},"CreatedDate":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z","description":"The date and time when this contact was created."},"SystemModstamp":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z","description":"The date and time when this contact was last modified."},"raw_data":{"type":"object","description":"The raw data returned by the provider.","additionalProperties":true}},"required":["Id","Description","Email","AccountId","FirstName","HomePhone","IsDeleted","LastActivityDate","LastName","LeadSource","MailingCity","MailingCountry","MailingPostalCode","MailingState","MailingStreet","MobilePhone","OwnerId","Phone","Fax","Title","CreatedDate","SystemModstamp","raw_data"],"title":"salesforce_contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/salesforce/contacts","servers":[{"url":"https://api.supaglue.io/data/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.13","title":"Data Listing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Provider API documentation for Data Listing. You can use this API to list standard and custom objects to sync them from Supaglue to your database.\n\n:::info\n**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n:::\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/data/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"**NOTE**: To use the Data Listing API you need to use the Supaglue Managed Destination and select [Standard Objects](https://docs.supaglue.com/next/platform/objects/overview#configuration) to be synced.\n","type":"text/plain"},"url":{"path":["salesforce","contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/data/data-listing-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/create-account.api.mdx b/docs/docs/api/v2/engagement/create-account.api.mdx index 4c262a945a..20a0798ea1 100644 --- a/docs/docs/api/v2/engagement/create-account.api.mdx +++ b/docs/docs/api/v2/engagement/create-account.api.mdx @@ -5,7 +5,7 @@ description: "Create account" sidebar_label: "Create account" hide_title: true hide_table_of_contents: true -api: eJztWXtz2joW/ypa37kz7QwGY97pdneTQDq0TZMF+tokw5UtAWpty5FlHs3w3fdIssFA0qad2/9CMiGWjo7OOTqPn3XuLB5TgSXjUZ9YR5YvKJb02Pd5GkmrZEk8TayjKysbSaybkpVQPxVMrmD8zlraOGb2V6qebtYwG2OBQyqpSPR8BA/Ad2n7aSJ5SIXNCPBlEQzOKCZUwFPiz2iIraM7S65iRZ5IwaIpzNAlDuNADYWrLYuqtS5ZhCa+YLESHaZHM4ryedTvIjnDEqURu01psEKM0EiyCaMJTBQIWYRWPBUIx3HAfG0G2FTQ25QJCvaQIqXrUkGLWPA5MBO2HvkVPXgqwcb+7H4Vcv4o478nyo0ZoYk84WSlNtolKFk+jyToqqYKSlW+JGqLu0MJufeF+uqkYWfwBAkmMmx9LsiP6YxhDvWN0iDAnlLYiLXV/3yFTnkY42ilLcBDzKKf4xCufMOgDN+KCV9EVIwZ+Tk2nUmNdloTYtdJA/7QiW93Gh1iex71Jth3Wp1JQ3HHxvV/mj+mdY86btvuOK22XW83HBs73sQmbrXqei2/Tqraj40zjsE5A5LcZ3FMCFOHiIPLgu3NdrsedKpZoe0RIcmRR8HNE3imxEQFFhRFXCKfzyl4DvJWJih4GPIImW3L6EJ/I4jsBIXAF4VY+jME+vkSIgoYm0VC0CTmEQFzbL33+LJfVtmDSW2KXRXX68KMzjfjzMZ6auvRV7kb3qwLhi06pzqTqlurl/IILXjX1rn2PKaU7UrGGOLEch23Zjuu7bZGjnOkf/8HgqyNLEq3xPi661TV167Js8SIMpbW3xaBVAguiv6AhcBKKyZpeK+f7K4nVGIW3Oeyh1lnAk6M9IYopEmCpzAkwJHUCQsacknRZXa0ZaQWGCUQjggK6JwGiE+Q2RAtGPCaY7FSfrVZtZMC767BSIReW0d1xyldWx7kMniA4URimSbw/7XR/9qC6UwkPZpFwAp2CCANogXNnBmeGTlCV3fX6mOx5IMaMA9HExwktGQecm5mxnxtuF4XP9Z4jD1I12OQaGccEQ5bq13pkiXSDGbsjdg7zAcXl73B6PO4e9EbvhuNe5/6w9HOGuW7O0v2Ns7pAu6DUt8o6alNzn+TIusbbXUd2UGGDLTtsd+puw0X0qTjNex6g7g2JlVid3Bn0mo2qqRFXLMUImHKxUqv+nD8tt89HvUv3o17g8HFADYAElMyE3PqEP2gi60CR/DAxkHAFzYElC7acHSajz5Dw35i+1BAqV3wlu7nd8fn/dN8HiJFD7edRo1UW16HYNppNuv28HVGw6MIogaU03R+wHPmJnrtgEZTOdOTtWZ1Z0rFkzHIXni/8GdYJFS+TOXEbus1BEyhac95VELVKhrSGKmMg9zaUaN65Lro1flIk0Y00JSZByeptsp4IrCR05yzU3aqmTsIGnMhx5LvuABorzgV/SbEy/HWU5pOve04a72nYWEDi8LONCIxZwD2sgV5TKUi2NlpJmWcHFUquAwblsGEKZkEUFxUkq0YzpV57d/Jy7PpIv104V386Z59a+LZ+9dvkuWX7lv8afTxC+ev2/LEWdT/dE/g9w1Og1dDuXTOXn2Nqpf8Nb9Yum/E2fmEzb69I5PjW/b1tnUaTj0ShIs3J+3Z1zCu0ZHXbN/G06rz9tNZMJiy4e1g5n08b60+Dye8ffopvDzxc+/OjDIVPI1/3XJQUKF65s6TaW5mIM/6YFOBo0RbN8fLmhg42sDxZa3aqDUdx3kBxdkPUkKHqdfV9Sp5AXWUBhwTzU6lUr2SCzZl4ERQcWgs7V4EORQSuiZa2kXntLlO7iYyIp5EbDLJyGg05ys7jRMFQkNbacF8aksWGjftVHPC+UqpAHMBZAYaZbrmD2N9+Ae0YFNJlSwTNk3Na8U9yyoQ4Q8szQXSKVGXASUwxJSxJ+SjrCgUl+qzAOC2smNuUhXDxHErs9RTLyeSVIzaUCCXK7sJaazTbvqNpt1ZJjP3gN2cCZniwJ5xSIk6zjfiAkc4U2kXkiO8z/xcdtxyAQPRgIVM2hBtoAPsGUL1ZOAwAKjM8VXBR5wH14E35VQP0kABB6/SnqIOuPMgodk2WGUcf0i3zzlbkL2g/IJdtPn1IvekelKvtZu1pttqdE6ax/XTGsSee9ytNtsnbafW7Z5WT3qtlnP4gRhfX0cKWcN5AzIPxwYAPQYIDdMYTwFYZGBIoRSEk4T7TIE7wDZypkGRnt4FNef94bD/7tV40Pvv+/6g1x2f9Xtvu9YW6/5o/2PkCUYVjtqMKli13W4feSl2iiKHbI9AXt+HT8pqRaR9tUWRT5jtCbM9YbYnzPaE2Z4w2xNme8Jsvwez7UM26+S4qwFVbzgylahwqfhjLHNTuGjMrtP0nd7jrrbvu+/dv58Empv9y0wyznYA2gUWyta/4Rrvh/D2YeC5Ll7AbiRcr7M7z70rZa0TwpuOUEjljKtWUQyhpsTFcgZPFZx3iEpZnjX9HyhAqkOSl52YlZMMY5cZhxifQmINIQlW5u4BIt6g8ePLvioCm87TUIFgY59C/2lr4pi9ocrGm7ZNTrPfsNlD4Jd9dd+t7rY1ngEoPoekDqehL9IN5NGAXAsEtlIIYrBtyPTuu6P+qZvpbSvjcf2J3fbE43oOhy0Hfe4smnAlrzo6Yw+nXG2WO4WQex+pHhpBvc2xaUuYO2+APAV187NTrx+heYUg3E/+szl9o++ue+xMHrjiH/BBfYU3SWrgVfSRBkBK825ELp86yGdbIZ8DZvZT9Z/O/mX0mafIxxFKE1g6Y4leADwW4FyaWZgGksFJqllB7BirPJN3NxL9HsgivWXBFDmELl+DZFcfGF3kPZXspW0Cr5Rb+ptnudrKMOWi7pUY6hRQhxXDwDYMkkK8PNeb/ONqkEaqi3kJwRjiaMtTpFEZEEMYqTDzUilB72Q+fb6lWCwW5dgs03vmAlQWXHxNYkjrmyE7Tj1AzRXVMJqDXnpzfRwnONHRgN4P3qrBv/766zp6VLRntDqRGSkK3nOQdXY8YRPoki6lshXTbLQv3WUJ6crChZa1ggVq7O7OA4Hfi2C9VsMQuEI3rksKsjHTx7tSZSPLEPoVmCVqguSvpPuybPo91rNBVhqeo7+zHX2vsjrjHbTVdSmEcUs1rX9Z8P0m9HcF2O+I74hgiE4znDtSfLYUB92x7QqDl79Le1MoRZcXwxEQe1lPPORErRF4oTro8PfIuoYflV4NyNYJWo3fWQGOpil4JdAYvioV4lS5ULGemOKR/aO8Ip/S6TyXslhojCLqr1LrXvJ/qsCBSvWvDbmZeXDBpm4ZaqYxznr9f/UsetU= +api: {"operationId":"createAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"example":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/create-contact.api.mdx b/docs/docs/api/v2/engagement/create-contact.api.mdx index 267d6b0dee..706312ef65 100644 --- a/docs/docs/api/v2/engagement/create-contact.api.mdx +++ b/docs/docs/api/v2/engagement/create-contact.api.mdx @@ -5,7 +5,7 @@ description: "Some providers do not support `primary` phone number type, in whic sidebar_label: "Create contact" hide_title: true hide_table_of_contents: true -api: eJztWntz27gR/yooO525TE2Jot66XlvZljNK4tiVnLuktkcGSUhCQhIMCVrWefTduwuQEinJie3LTf+x43EkYLHAvn943BsiYjGVXIRDz+gZbsyoZEcilNSVxoHhscSNeYT90DsWASNRLG65x+KEeIKEQpIkjSIRS3ITxTyg8fKGRHMRMhKmgcNiIpcROyA8JIs5d+fEpQkjC/jlvk88NqWpL4kU5CYQDvfZTYUMp8QRcl7gR0Nv3V9inhAaM5JEzOVTzjxFKEJ/SShJeDjzGdGj8rXwhEQiSbjjw5LknIUbtmo9DiNpkvHZTJ93ebGIIuZVrkLQjKSzxOhdGpmuEuP6wEiYm8ZcLqH93rgzacTNLwy/Xa+gN6IxDZiEVav+EL6ATu9MN00kKDY2uQd8OSp6zihoGL4l7pwF1OjdG6hG6ElkDIJBD7ujQeRjU7DcsKgZq22jXcwZyfvJ8BjEppKkIf+aMlAUWDKUqLwE9bEhBHstRRoTGkU+d5WDwKQx+5rymIGnyDhlq4OCFLlbmKrlOXKIVIL3ufP9IuT8ScZ/aynXuoUl8lB4S5yoTHBguGAokBW7CkJVPyc4xf3uCoXzmakYgJkhRiSoSLN1Rex9n27K40ROtHp2pQ5T36cOiq0Xt9HCaybiGUMd+PRZDD4iAQz/LJyJ5NJ/4vCjwRmOpp4XsyTZJ+f22LLcrvL/p8w4piE5iWno8sQVOLcr0lDGT+TyYdzHsRDekvoTV3hPlLvbqFlt5ADj5VN11tcDY8bkpPa0sU27SQ5B+pCGBSb2k5hgx2pVjIlLbYeNLsuayaUsLLow9XWB9WVu0S0zFawEqt9in2tzrUzUUFFBJamLQitJYP7McdduCMJBdHJ/kjWwomfSOKYoIZcs2OuxZQ8tMfp2Spoz3xf/hgJHZ37KKq4IdlYy0aMfYS2oQWiYrKzgsqAUiJD68HEh4i/G9bYNyyvdO/H1qmysLeH2SbBfAL2Eou63FY7RhbV3ktXe51ugyOZp0fL3WqPWrNn1RrPV3l7QH7CEkv3AmAtVWjQkgA+AQmCBO2YpLX/fGraNUpa3LMReGXaNUdY88BeLEMi598QsN62zbnvqmQ2vCX/Y1DW7za5nOg5zptS12t1pU6V/V4X3k/lT1nCYZXfMrtXumI1O0zKp5UxNz67VbKftNryagigaZ0wAd/jeXocBt+NYn6l/XnAdPV0ZHBwpVmTjYYgmAa3xMIHvAOYU4EGciGDVFbcMzEicpcY7IghESPS0FXKm/icA2hISAF8SUAmYFeRzJYAlYKwHxRASkQg9UMcGmPTPhxVjY7GyiOhD6x4FsiduhrK33StDGCUnKuIOtAl6T6lIPyJJP5yCyVjuZOE8ox89mND35eQ/nIF8HjJbeX4RQOWoqASKNNLZSUrPircs5HFebR1vQgEqGrZl103LNu32hWX11O9/wWArbTP0gawU2Zaq+1uuqS1MMpbGDwOhLI7FH0nAHpOg/32hvQu8p+AMRE1IAjAWnUFTDAGHkRCzQEhGzrMQqBAcoIVQeyif3TKfiCnRE+qd1C3kXIy/9ahSyb2/MhBDXBm9hmUdXBkOwHn4As3oemkCn6+0/FcGdGdLUq1ZpljCDOBpCewys6CH79zrkcv7K/wxePIrNugvvSn1E3agv+TcdI/+b831qvhjTCbUgR3LBFZUaoddMUyNs7I7nkjdmLHXyy4xH52dD0YXnybHZ4Px+4vJ4ONwfFEag75eGrI1cU7nCxeE+p15A5zk9E8SZHWttK4yoJ8dGyjdU7fbsJs2lBPLaZqNpmeb1Kt5Zpd2p+1Ws+a1PVsPhUiYiXipRv3afzc87l8Mz95PBqPR2QgmABK9a0y01aESgSwmBk4sfJNCMlmYEFBq3wqmU3yUDTX7qenCHpKZBW85/vS+fzo8yvshUlRzx2rWvVrb6XqUdVuthjl+k9GIMISoAeEUneuLnLmOXtNn4UzOVWe9VSt1YTxphWyF98/unMYJk7+kcmp21BgPVKFoT0V4QGo1MmYRwYxD7HqvWevZNnl9eqFIQ+YrysyDk1RpZTKNqV6ntrNVsWqZO8QMz2QmUpRcAKRHTkW/CejdZOMpLavRsayVmlOzMIFFYWYWepHgocycr5fHVBr7pZnmUkZJr1qlFZiwAipMvakPRRjzf1Vzrt7W/5X8cjJbpB/PnLO/2Se/t+j8w5u3yd3n43f048Vvn4V405GH1qLxN/sQft/S1H89lnfWyesvYe1cvBFnd/bb+OR0yue/v/em/a/8y9f2UTBzPD9YvD3szL8EUZ1dOK3O12hWs959PPFHMz7+Opo7v522l5/GU9E5+hicH7q5d2dKmcUijZ6vOQAegDJy58kk1z2QZ13QKdTdRGk3PzJSxMDRBI6/1GvNesuyrJ8BxLh+6rFx6hwLKJlh8jPgDeYL6il2mErVSBHzGQcn6oNfRNIchJBDIaErojuz6JymUMldR0YokpBPpxkZC2/F0kwjBAI0MFEK7jJT8kC7abeWE94uUQTo8yEzsDCTNf8yUcbfoQWdSoZrmfJZqs8c9wyrQoQ/MDRfkEqJqgzggiGmtD4hH2VFoThU2QIA7tKMhE5VnHqWXZ2nDp7PSa+qxYYCebc0W5DGup2W22yZ3btkbu+wu+WxTKlvzgEc6ThfLxc4gk2lWUiOJn9idtxwAQUxnwdcmhBtIAPMGUD15OAwADy1+WrgI9aD48CbcqoHaWIEYqHyFDRw90FCPa2/zDh+l26bczYgO6N7hl6U+tUg+7B22Kh3WvWW3W52D1v9xlEdYs/uH9dancOOVT8+PqodDtpta/cHYnx1pQ5awN6wgwke3DTuAqFxBmEzMIQohdAkES5HcAfYRs4VKFLdZVBzOhyPh+9fT0aD/3wYjgbHk5Ph4N2xsdkTfG/+PnFizhBHrVsRVm2m20ZeyA4pcsj2COT1bfiEWtva1uYo8gWzvWC2F8z2gtleMNsLZnvBbC+Y7c/BbNuQzTjsHytANRhf6EpUOHz9Ppa5LhzIZsdp6kzvcbe7+87Ft89xgeZ6+9DXm2QzAO2CxqjrP+EY77vw9mHguSoeVK9XuFplZ54Bk3OBD0XwcBjXQ+UcvlXd/BXEQZZI9UEsVBg8Ac7rSsQr63NgLiCIZ5A5A8hy1Vt797FJDrf750N1MJun3TGiXK2AwhuLjQ4j/pahEtdPE3Ka7UcJWxD7fIgH/3jIrwALYO1byNp4SafaVPVWiFstCG/YASKMNo8OBvsO6x99il24rld38IXT/f/THeyPP9xXZvwRx/VrZptbsMddbZVvth53XbV7W6VCgYdTgRZGZ9ceZFVqrUq3kIU+hPpZ0mDt6Mp39DUAXv301g9ocm/P1QdNnnCTbdWWA2r7Yrrs0H+FHzJECO6lGnGGvzHfxTdc2UVWvj50/Z82i3wF2wg3xU+qIFbIJ5ESF1wvTWDonCdqAPBYQDgqZkHqSw6+j72xZ0YUU+/moRhujXmopiyoIt9VVK5gZZe/crbIr+OyfewUdtkb+uufcrFRMZWi7NUISjdQB1XNwNQMkkKGeaUm+cvlKA3xbdM5REpAww3POA0rAKKCEBOTk0oJcie3s1cbisViUYn0MDVnvoAqOmMSQaVbN5lR6sBGoop3jbcgl5pcmeMQX7+h9j6M3mHjzc3NVfio/JjR5m9cYBUF7zlSxYW4+9/t3W+unV6e8BWf8OlkItmdRA/iSrkqwu6zwnZpuIXnfYgfse3+3gENfIj91QqboQDE6pHfAWJ7ri/GLxFfZJVGnZXwBDu8/OziYQv9NMowxCvyI5/u7RVWVc6dJ4gKM0G7gQ/8nr3w7Qd731zA9uvB0hI00VG2IbpAPhuKnWvUzQi9sfom7XUB0pyfjS+A2MneDwa6isZ0ga8N4W/PuIJ/+CxE78ZUocf2e6jn4SyFWAUazRcLBE3RhYq4RIOQ7AN6Rd4VLgurLAIWLQj+RbH2kv8D0wkgnn+uyXXPgwPW+EdTcwWGV6v/AW95Bgw= +api: {"operationId":"createContact","description":"Some providers do not support `primary` phone number type, in which case we will default to `mobile`. If both `primary` and `mobile` phone numbers are specified and only a single mobile number is possible, then `mobile` will be used and `primary` will be dropped.\n","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"example":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create contact","description":{"content":"Some providers do not support `primary` phone number type, in which case we will default to `mobile`. If both `primary` and `mobile` phone numbers are specified and only a single mobile number is possible, then `mobile` will be used and `primary` will be dropped.\n","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/create-sequence-state.api.mdx b/docs/docs/api/v2/engagement/create-sequence-state.api.mdx index eaa93ae201..bc8f364481 100644 --- a/docs/docs/api/v2/engagement/create-sequence-state.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence-state.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence state" sidebar_label: "Create sequence state" hide_title: true hide_table_of_contents: true -api: eJztWntv2zgS/yo6HRbYAqGth9+9vbs83MJt0+TitNteEngpibLZSqIqUX408He/GVKyZSdpcsXuf1GCxCKH8+LM8EfSt6ZIWUYlF8koMAemnzEq2Zh9K1jis7GEF/PAlHSam4Mrs2o3VEdu3hyYOfOLjMsVdN+aS0JTTr4yfLtZQ29KMxozybJc9SfwAkKWxC9yKWKWER4Ae55A44zRgGXwlvszFlNzcGvKVYrkucx4MoUetqRxGmFTvNqysM31gRmw3M94inZA9+WMGVW/MTox5IxKo0g4aB+tDB6wRPKQsxw6aoQ8MVaiyAyaphH3lU9AaAY284yBc2RWsPVBzYo0E3NglhHV8jN2iEKCw/3Z/SZU/I2S/54qN7qF5fJIBCsUtEtwYPoikWArdtWMan7JUcTtXQ2F94X5EiSBZAgLCS7SbH2RBY/ToTjqywkPfmy13+5bgd9xSY+1XNLq0Rbp2e0WsUPPsyzq992Ohx6JKY88sXyUn9sPAztkFrH6LY+0aMcmXqsbEpe51Ldc17FcDLO7DobQEKEKglKUIYVR5MwIRaaa8zLgG8ZF6VrVdZiKKBIGTQLjrJzBhvEhgZG6f0wjlkcilA00o2LyqB1er91ibdsitt+ySIuFHQKxBM5hntsOW/3AdVWwg5zsAWY/shGHGYuZMHhuwKyBojEMUl0wazBiz8qNFQeGUBxpVLP+ABJqY/DGC+Z6XY/Tq3pM7HoColdyqeNBFZ3JpjdXZWefUxmFN+uay+qxiQ4x3Xa713Jpm/httwMu7DkQCv0usdp2x/JCrxt0e6iIkjAw0e45plY91EzaZT2gBiZeD+LJsjyITycgfccOadvp2C3LNw92wt3seIHPPN8hYa8HggMG0d1jAbG8PvNajhV2PXvPAwOz1WZWt2d3SRi0+6Ct3yO064C2nU7gBJ7T9fseClL+CSYUMtl0LMcllkOc7qVlDdTvf4GmSINHaNb4oEvzVCS5zljHsvHfbtRsqrzyklFKN/+0csKyTGR5jY5mGV1h/ZQszh8fHzAJs/W06A+LKDKUQCNmeU6n0JSJWAV9xmIB9p2XVbZh4ABthErtiM1ZhMmjBRoLDrzmNFsZ3mo7aieDb6/BSQG7NgcQNQfXpgeFGV6gGX1Z5PD5Wtt/bUJ3qZJqPdc2rkBCBDXdWLCMGYmQ+M6DgXF1e42PyfOP2KBfBiGNcnagXypuukf/23C9rj/mZEI9WHsmoNFOuxEIEI1S2ZLnUjeW7LXaO8wvzs6HF5efJydnw/H7y8nw02h8uTMGF66dIXuCK7pI+GDUdxYMUcjpX2TI+kZ5HQpGxqIS8yjfw5LTctqOT/qY9a124EDhtSHhaT/sdtp20A0cPRQyYSqylRr18fDd6OTwcnT2fjK8uDi7AAFAotf/XM869X2whWDiZCIiFOrmgkBCKQQCU6f4qDnU7EPiQxVlpBYtJ5/fH56Ojqt+yBTV3LPabmB3vX5AWb/TaZHxm5JGJAlT5VzR+ZGomOvsJRFLpnKmOt2OvdOF+aQdspfeL/0ZzXImfytkSHpqDJYbRXsqkgPDto0xSw0sPIbjDtr2wHGM16eXijRhkaIsIzgvlFcmYaaXnXKerYZll+GQsVRkciLFTgiA9cipHjcxXU62kdKxWj3LWiuZmgUBFjXJLAlSwRNZBt+gyqkii3YkzaRM80GzSRsgsAEuLIIwohlr+CJuas7Nufuv/LdX00Xx6cw7+8V59b1DZx/evM2XX07e0U+Xv38R4k1PHlmL1i/OEfy+pUX0eiyX1qvXXxP7XLwRZ0vnbfbqNOSz7++D8PAb//qtexxPvSCKF2+PerOvceqyS6/T+5ZObevdp1fRxZSPv13MvN9Pu6vP41D0jj/F50d+Fd2lU6aZKNKf9xyghDnLquApLdc9UGd98GlGk1x5twL/ihg4EuD4m2vD0mtZ1ksA1H5UBGxceCcCFtgkfwmQlkWCBoodllI1UmR8yiGIDiEuUkmGCdRQKOiKaEnqwUk0ENGZkYg84WFYkrFkLlakSHNEIjFBK7jPiOSxDtO+XRHOV2gC9EVQGVhS2lq9TNTk36EFn0qGuoR8WugN0z3DmpDhDwytFFIlUS0DqDDklPYn1KNyUagPVXMREG9FUqFLFaeB5TRnhYc7LRk0tdmwQC5XpANlrN/r+O0O6S/zmXOH3ZxnsqARmQkoiSrPN+oCR5hTSWrFETZn/1913HIBB7GIx1wSyDawAWTGsHpyCBiRBHr6bIgR68FxEE0V1YM0sIBDVKlIwQnuP0ioxUarkuOjdPucywHlbusn/KLcrwY5R/ZRy+113I7TbfePOoetYxdyzzk8sTu9o57lnpwc20fDbte6+0COr68T3AHAfHsRiycaAD0FCI2LlE4BWJRgCFGKQfNc+BzBHWAbOVOgSHXvgprT0Xg8ev96cjH8z4fRxfBk8mo0fHeCapQA/jH5h4aXcYY4atNa7Um0uH3kheyQooJsT0BeP4ZP6LX6vuFqiyKfMdszZnvGbM+Y7RmzPWO2Z8z2jNn+Gsy2D9nMo8MTBaiG40u9Epnb89DHsczNFnxVx2nqaO9p5/T3HR3vn7bed0IbTEoJQLugGfr6LzjGexTePgw81QFnpfNGw/W6PPrcRaXHyqbNEb8+7cSjYCZnAk9nU8g41JrKGbw1d4+nc3WYi1VXX23BcoSXP9UilPJGXiLuBheQ8VMoszGUxObcuYOPN9j88HyES8LmUm2MkFh7q3a1tnV4yt8y9PjmRqqi2b+L2sPj5yMDqPCyQ6EbAOZzKPEwN7lqU0u9gudKIfAc4omL7V3T8L7z953j8Cdd8ewduz/xGmf3CP1Jdya1K5N6vPMkFKg5TqL2jNWwO41+LRU/JHhRGBjDzQQqn2wO/3F46f1qFnFbEuutRSD8/N+bOAAggprsBMpO550Q/Ts8xghxaFBo2JX8ziIgZThPOEGVfjilv26VfAFY2i/wE9UXO59FYfg0UZdbcsZzNQB4LCDMFLO4iCSHOcXeLCApxfpTXUDman/IEyWy5ooKWjeuQbOrj5wtYGMZx7C9KzdzeDe0pb/5tTIbHdOo295MYf3CG6mmZkA0g7yWOS+UkL9dXRQJXtWeQ3bGNNnyzIqkAUgiTjDhvEJKsDufT19sKRaLRSPVw5TMSoHmQmRf8xTK/aaJpIUHaLop5ggB2EIJV9NxRHOVF8aHi3fY+Mcff1wnT8r7klYVOK1FLXoeqkY7AbHJfMmWEl3GFTcVUrdloboy9wsVFBQED9h1e+uB+h+yaL3GZqDL1F39AQI7Tj21N8bFpawcaqPMc+wIqo3rvkqbWyHz1+r68IXxZ97A32uzqoR3vkmgFkxoN/Ge/qcV3793/6EC+18C2FFBEx2XaPgS+Wwp7tyhbUdoVP1D2pvaSnV+Nr4EYq/8GkAsAhyT0QV+aQD+Dsxr+IGXEoqrwo3tt2ZEk2kBMQo0mi8WRlpgJNXXGb2olB8wKqquZFXTsr4AaUPwL5p1L/k/MI1gBfvnhlz3PDhgs55paq6Q0Hr9P6myubw= +api: {"operationId":"createSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"contact_id":{"type":"string","example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","description":"The ID of the mailbox to use for the sequence. Required for Apollo and Outreach. Unused for Salesloft."},"sequence_id":{"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"user_id":{"type":"string","description":"The ID of the user who is performing the action. Required for Salesloft, optional for Apollo, unused for Outreach."}},"required":["contact_id","sequence_id"],"title":"create_sequence_state"}},"required":["record"]},"example":{"record":{"id":"355843a5-c536-4e82-b497-05160bfb7d78","state":"active","mailbox_id":"a7e860b5-cb8b-400b-812d-921fa526140c","contact_id":"6bdcebc2-f886-4de3-88ed-0b9eb420f7b1","sequence_id":"45e07817-fd59-4ec8-a727-066d2db27c9b","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Sequence state created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence state","method":"post","path":"/sequence_states","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"contact_id":"c590dc63-8e43-48a4-8154-1fbb00ac936b","mailbox_id":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","sequence_id":"b854e510-1c40-4ef6-ade4-8eb35f49d331","user_id":"string"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/create-sequence-step.api.mdx b/docs/docs/api/v2/engagement/create-sequence-step.api.mdx index b805aa254e..a9409b1a14 100644 --- a/docs/docs/api/v2/engagement/create-sequence-step.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence-step.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence step" sidebar_label: "Create sequence step" hide_title: true hide_table_of_contents: true -api: eJztWntz27gR/yqoOjeNZ0yJkm1ZVnpt/UqqJI5dy7lLJvbIEAlJiEmCAUDJOo++e3cXpEQ9nPjSu+k/lj22SCwWu4t9/PB4qKhUaG6lSjphpV0JtOBWdMXXTCSB6FqRVrYrlg9Npf25Urw2lZvtihFBpqWdQsND5d7jqfTuBD7dzKA15ZrHwgptqD2BB+B+7wWZsSoW2pMhMJYJvBwJHgoNTyYYiZhX2g8VO02R3FgtkyG0iHsepxG+iqcLFvXKbLsSChNomaIC0Hw1EqxoZ50TZkfcsiyRIHc0ZTIUiZUDKQw0lAhlwqYq04ynaSQDMgYMqkFbqQVYxepMzLZLWqRajYGZ9ujNj+ihMguWDkabVSj4s5z/o6KYfEZ6C3Om3I7WumwaBMyjBmSIgkv1icL7jb1W0A+aXtNv+N7ujs+91m5LeJwPeNDn4WCXi8oM3QClEMYeqXCKLFeFClRiYUqwqWT72heDQj6sy6L6X0RgQRYwELithZl0bAOlw+/TOaOta7ZuG6RkQzkWCetPyUaZgekYKO0MBnFRZR+MCLG5yyNhIjWwTCXRtIpTKkEvPeZRD6JEJaEpjZpkcZ/cZH3Uohd7AR6Z99wC97UygmGloXHZREYR44GVY4hUxgfQh4RKtRhLleVUyCLgRuAcD6Q2ll5vMy0iMPJYMKvYZAT6gYlMCtbKqQTKYBifO8XWS1KrCI5+RF0LUb0+RysUxKbKrlBQ+PXRNKEY8Cyy5OUg7bfdquE3djy/Dr8brYMMHjPDRhmxw5p8KIoVMGIuzvo44HIyqsXCGD4EPjktMuyTG4S5G+SCVNn5ytDYTEwYfCn4IKnBAFOJOB9QUvy2s8rwaa66COOyqCDnipgQkOWs8BkHuMFU8m0x+nnofl8QpCxEceq/+PfV2bstMrnJHPsnccqJl5gRl98ZwCt2cXOvSgy41ny61v+QRdLQ6Ln7MrAHpCTGkzDXjIehhollKYegQXtDChIUVWjv+URADKIA1zDqdQUCTESUpqHdrKuB8xME/w/pguBp0vX/P+L1nyqfK+g9ojSbygGMLFFOHl2UnHxTgTwmVmwRC3n8ywTqgIUcQMiCa/A0ZVmgxkK7YkDAQsUxaOyGhfzgvBnQkWEx8GUxt8GIQeILLGQOYOw6abBKCjkf1FkggMOLDmYNKy3lyGUVV0OagnURbHnAACDDkmR6WqRROZj7SkWCJ2tz2IG4QZusZts+QoUE1Mb6QMwK4ZdqD8UZFGSock8qe9jnb4aF0sDEQwrBnjAgDJ4wac0CnmzMtOc5knLVDGcYzEfZFmoC1EcQl1kZlyulTMALoMwWjBmhXhBomylo1xMJ2ZPYuYY5Q6uGAglIukV3JzGWvRhFk5a5qqOcB7tmiIjckqRYASMYhVG1BCJCBd6GXoU5HMluicEtI0y9TYG0GDEBJjyEYAPlYpk4J7xdxR+3oI4EG1nNE4PRhT3zubsN+TRnjkwoSdKcbajVMIvoZzyzqkfBDC9jnmQwUvEY8CiiNYO5g3+RTO4ETAkIkoS9vBji8mHdDXCwVUQKJsLEzd4rK9rsdiO3W7RDloQqyGJELyFmjrlXoLWKegIKByOeDEX1OiE1QcYeWPoJNeUQwjl1qQPnpoAD3FoYBNOBWiq1z7nI6XtToqaVZW++YkFLrXXKkfzNbOZaUAbjgEgDYOEaXusu/ARCyQ2BReIPWlgIrZU2G2reahF6pD9EJQbFkxDLIIMMSwPOMeNAw7TjfGgRo89d5BOBIBtUJiXIwSMxFpGruTigy9ZjrqfoBfNeS2D7Acq+CsV1pb3r+9vXVDrgAV5jyGUGvl87/a8r0JyLRG9zf53CCBGs7thE5K4HzzJss88P1/iBivMLvnAP7QGPjNh2DwU31+L+zblelz+VXo/3YbHcA4mW3i/SpLgHwOFe5uyd2EvML88vTi+vPvVOzk+77696px873aulPlgpl7qsDFzQRQoSnPxNhKc4yNmfpMjshqxOcRjluzNkex4c7Db2GoF34Pf3vN29sOHxsB56B/xgsN/cq4f7YcN1hUgYKj2lXr8cvuucHF51zt/3Ti8vzy9hACBxGxbGzToPYHVkPAwcrSIPkriaeBBQtGUCU0d8aA4d+4EXYObzSt5y8un94VnnuGiHSKHXLX9vJ6zv9w9CLg6azV2v+yanUUkCUQPKEV0QqYK5i14vEsnQjqhxp1lfasJ4cgZZCe+XkOG1EfbnzA68FvXBdSDRnmGFr9dZF3IFLjZZY6e9V283Guz12RWRJiIiytyDTUZW6Q00d3K6efarfj13B0BBStse4PuyC4D2yKnsNzG/7y08penvtnx/RmM6Fh4uERYjQ31LFZTo3PnaRUxlOloaaWRtatq1Gq/CgFUwYRYOIigFVcj7Nce5Nt75p/n51XCSfTzvn//UePVbk48+vHlr7r+cvOMfr379otSblj3yJ7s/NY7g9y3A9tdde++/en2X1C/UG3V+33irX50N5Oi39+Hg8Ku8+7p/HA/7YRRP3h61RndxuiOu+s3W13RY9999fBVdDmX36+Wo/+vZ/vRTd6Baxx/ji6Og8O7cKEOtsvTHLQflD2pd4Ty55q4F8mwANkW4Q9YtdiuJGDh6wPHnnfreTtP3/ZdQSoMoC0U3658owDGJeYmQNlI8JHaYSqmn0nIowYkOwS9S650mkEMhoRPRvVd2Ts/BBRcZiTKJHAxyMpGM1dTLUoMQJfZQCxkID0EqUR/UC8LxFFWANlxTiSTXtXjo0eSv0YJNrUBZBnKYua3dDd1qEOGPdC0EopRIZQAFhpjyCviYF4VyV5qL0OtPvVS5VCV56Ddqo6yPW8M2rDm1oUDeT70mpLGDVjPYa3oH92bUWGM3ltoCqvRGClIixflcXOAIc2q9UnL05O/MjgsuYCARyVhab76lFUP1lDlwJrZ18BH/0X7gTQXVozQa0XFCnoITfPAooRs2muYcv0u3yjnvkO+7/oBdyPzUqXFUP9rdaTV3mo39vYOj5uHu8Q7EXuPwpN5sHbX8nZOT4/rR6f6+v/6BGJ85jA3zDSu1uPfYkmIdCHWzlA8BWORgCFEKrDiNCiSCO7f0om0hbF4GNWedbrfz/nXv8vQ/HzqXpye9V53TdycE9R0K/S7MZ30tBeKo+dv5LhQNt4q8ikVLAdmegLy+DZ/QarMS+ecFinzGbM+Y7RmzPWO2Z8z2jNmeMdszZvtzMNsqZKscHZ4QoDrtXrlKVNoC/D6WuVmAr2I7jXb2nnZiv+kQdNM55uo2Y9jLRwDaCddo6z9hG++78PZx4En7m4XMcwln7rO2AUw6lTfF6VpOLOxI4aWdFAIOhcabH+1KbX7YXXso3Q+Z1Za2Xg2eE1Eudjd0oEjhHZaiNKWyanIcXpUK8sAQki9ur9fGjTXUPEfshxcdLBTzu0FdBMrOhqUbQotpSOVbMS2OqdolmtUrNSso/aKDO9i4W02YB+D6GBI/HjTSOwIABNpJILAnoozLxV2U0wJdl++OFFdqipXB+h0Ov7jFsHxVoXydAB22NPuLQze3sZ+fivnbcxOUT1JK5xELMVYPEsg/ZDKgc2ycPmcTv1pvVg9KofkhwZtOITudTx1Zw+2Nc3cUn6tczB8uU2K31AhVYP419wAAJtC27CJLjWsu+1f4sA7i0jBzMCz5VURAKoozhkI+nMwXCyG3WHGQQ1Wiyj6pjAU8yU/DpKEOeHkFHIyYxVlkZRpRqw69lGM+Ks4sTPm8rWSKAmpXr0Gyz79IMSlOSvLFHR4tLuhvXhRqo2GqZd1rOPdAHdccA88xMKWY2aJB/vL5MkvwbOoCwjXmyYKnzpIqIIs4wVDrZ9aC3mY83FpQTCaTauq60ZiFALWJ0ncmhfQ/f+WlWR/QdQ2PgcagFw1O03GE14HQeh8u3+HL29vb6+RJEZ/TUsJzUpS855HstOQP85C34t6ixSQxI496yBPX5/ltNsxN7eWrbSu5C3IMogzs9PCAh60fdDSb4Wsg03QLcRsRoMRjYreIlga/h8WidlW++YlR5cVlXly22OPX5DaqU8R0ggmMKiI8wVfKekt39ags5tntf5Luj7rsuFEfJ/fqpc25Ynh56IcFX73i+E0BVu9bLongiI5zHH+FfBYUa6d/ix5uPfBN2ptSkb04714BcXEfKlYh9tF8gpct4W+7cg0/eMHLLSKouOD7h0rEk2GG597tiuOLKRwy/2i5FrrCl38pXRBb9qdykXSK4N/SRa5l8r9jwEOV/cec3LU82mFecx21JAw3m/0XKk8zCQ== +api: {"operationId":"createSequenceStep","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"description":"The ID of the sequence.","schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","description":"The name given by the user for the step. Used by Salesloft only."},"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate after the previous step (in case of first step, relative to when prospect first enters a sequence); only applicable to interval-based sequences. This is 0 by default"},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence. Only applicable for Outreach when adding steps one at a time after the initial sequence creation, otherwise when creating steps together with sequence order is implicit based on the order of step within the step array. Salesloft does not use the `order` param, and order is instead determined by `interval_seconds` which translates into the `day` parameter"},"type":{"type":"string","enum":["auto_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["type"],"title":"create_sequence_step"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence step created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence step","method":"post","path":"/sequences/{sequence_id}/sequence_steps","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto_email","task_note":"string","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence step","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id","sequence_steps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the sequence.","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,15 +34,15 @@ Create sequence step ## Request -

    Path Parameters

    Header Parameters

    Body

    required
      record objectrequired
      template object
      +

      Path Parameters

      Header Parameters

      Body

      required
        record objectrequired
        template object
        The email/message template to be used for this step. Only applicable for email or message steps. -
        oneOf
        custom_fields object
        +
        oneOf
        custom_fields object
        Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. -
        custom_fields object
        +
        custom_fields object
        Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. diff --git a/docs/docs/api/v2/engagement/create-sequence.api.mdx b/docs/docs/api/v2/engagement/create-sequence.api.mdx index 7cb2de6ad4..c650f4a010 100644 --- a/docs/docs/api/v2/engagement/create-sequence.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence" sidebar_label: "Create sequence" hide_title: true hide_table_of_contents: true -api: eJztWntTGzkS/ypzc7V1oYrxCzDg3N4dr+SchMBhspsUUEaekW2FmdFE0th4KX/3625p7PEDwuZ26/7BoQiWWq1Wqx8/Sf3gy4wrZoRM25Hf8kPFmeEd/i3nacj9Td+wgfZbV37RpP2bTV/zMFfCTKDjwb8PWCaCO47fbqbQmzHFEm640tSfwhfgfB+EuTYy4SoQETAWKTQOOYu4gm86HPKE+a0H30wyJNdGiXQAPfyeJVmMTclkzqLuTzf9iOtQiQyFh+7LIfeKfq997JkhM16eCpA7nngi4qkRfcE1dJQIRepNZK48lmWxCEkRMKmC1QrFQSNG5Xy6WVpFpuQImKmAWn5kHTI3oOVwuH4JBX/P8V8S5ca2cG0OZTTBiRYJNv1QpgbWil2lRVW/apziYVVC2fvKQwMzwcxgCwZUZNmGUkXfp7OKWV7vtLCcWQdTik1QX4Ynes0AHEEtq6pbVZIeMsU9pPNknzZUO/useB1uDIzzjPRuDWfJrTcWceyGjIUZEv14KGPgAP0V7zZTYgRm7yhlCvayRC7HKVcV3MY0T9AfcCTpgkb6NyA+0XRFtFYb2vDsOer4XVpepxqk9AZixFOvNyHZcw3W1JfK6gnkqHifNI+wu8NirmPZN7ToCgoqwHrUiMVdcHKZRmXZYOk9svLVWYtR3itwKDdyA7zPiBimFZrmteploSGdeawPY0ioTPGRkLmjQhYh07S1faG0oeZNT/EYTHnEcWfHQ1gfqEhnoC1HxVEG7bGZLWy8tnvp3KAX09BC1KDHUAsFsa54lygo/NRQNRHvszw25KS4w0+6dKPW2ApqdfhZqx1k8Jga1sqIA1bkI6fiMKMTZ3UecGwRVxOuNRugcVtaZNgjM4icGThBKt7Z0tTYTUw8+KPgQ6aLti9TftanmP60sa5zgXVqgSDtvLcsKsi5JCYFh3mYu8IJbjAoPy1GzwXI7wuClIUodvmv/n15+mGDVK5zy/55gckSLzAjLr/TgZf0Yvderokfi+MPvFhomt2Zrwf6gMDvsTRyK2NRpGBjvYyB06C+IdBz8irU92wjwAdRgGuY9doHB+Nx9HTwDsP/h3Rh+Dzpev8f8XrPlc/ikS5Rrk0HMLNAOVl8XjJym/EXl3FErLy5Lzj/FynkAQMxgIARZrdUGi+UI65sMiBcJJMEVmynhfhgrRnAnfYS4OslzIRDDwJfaCByAGM7SIFWMoj5mHdnAObgvI1RwwhDMXJxicsuTc46dzbnMIAnMSXpruJZXHbmnoT0zdKVPWyD36BOlqNtDxFCCsvG/EDMCuEXcg/5GcAeyHLPSns45m/ai4SGjYcQgiMJNIAFCKNLqGRdpD1zQNBmM9xhUB9FW8gJkB9BXM+IpJwpRQpWAGm2YOwRYAeBNj0J/WosNLfsbMeMoZEDjgQW0syGW4kx7SUomjCezTrSWrDtBo9wmqSFFTDCIzeqlEBEJMHa0KowhiPZLTG49ehIsEmONJ8xBSYsAmeDxSUitUZ4u4w/AJQNBejIKJZq9C4c6fbuNmITxxyZ+E9gyAK3sdzILjkzNCYszWGm4mvI4piOPPoO/otFesdhS0CQNOq6ZIinn1UzWAdEQUUYuL2P0vCWd7uW2y3qIU8jGeYJopcII8fMKlBbRT6BBYdDlg545Tq14FrfdUHTz8gpB+DOmQ0duDcFHGDGwCQYDuRCqn2JRXa9NyVqOhR3i53toqZeojZqyp1Rv6OwlWHubHkzndoelEJb0NYACL2CbTsL0Y5jLv2DTrlcKan+h3MZBC+MHc8Cdv0cEhFNOIPWfQV7jpuheIKuee52Ac8iEEFoERQHYj7isYUmOKFNaiOmJmgCs1ELZ5IHQEcy4td+a7tW27ymDAtfoBkjU67h72u7/msfup1I1OqMdQIzxDmY4pg7u4PvImp5Vw/X+IHE/As22C+tPos137RfCm62x/4343pd/vjdLuvJ3HRBooX2eTbh94DLbKNjb8VeYH5xdn5ycfmle3x20vl42T353O5cLoxBW10YsjRxQRdLyAPiNx6d4CSnf9JCpjekdXLC2N2/ke5ZuL/d2GmEwX6ttxNs70SNgEX1KNhn+/3d5k492o0adih4wkCqCY365eBD+/jgsn32sXtycXF2ARMAib2W0nbXWQiHSB2g4ygZB5Dr5DgAh6KLMdg64kN7aNn3gxATRFCyluMvHw9O20dFP3gKNe/Vdrai+m5vP2J8v9ncDjrvHI1MU/AaWBzRhbEsmFvvDWKeDsyQOrea9YUu9CerkCX3fg2JUGlufs5NP9ijMXhcJtpTBEL1utcBdIJncq+x1dqptxoN7+3pJZGmPCZKZ8E6J610+4pZOe0+1yq1ujMHAItSmS4cg8omAKtHTmW7Sdh9d24pzdr2Xq02pTktiwBPUvOZAQZkEpCMM75W4VO5ihdmGhqT6Va1yiowYQVUmEf9GPJABYJ+1XKujrb+qX9+Mxjnn896Zz813vzWZMNP797r+6/HH9jny1+/SvluzxzWxts/NQ7h5z2cbt52zH3tzdu7tH4u38mz+8Z79ea0L4a/fYz6B9/E3bfdo2TQi+Jk/P5wb3iXZFv8stfc+5YN6rUPn9/EFwPR+XYx7P16ujv50unLvaPPyflhWFi3U8pAyTz7cc1B7oNEVxiPW7ntgTgbgk4RFZJ2iztpIgaOAXD8eau+s9Ws1WqvIY+GcR7xTt47lgD3Uv0akX8sWUTsMJTSSKnEQIARHYBdZCY4SSGGQkAnovugbJyBRVXWM1KpU9HvOzKejuQkyDONSC4JcBUi5AFieaLerxeEowkuAfrw6MlTt9biS5c2f4UWdGo4ytIXg9xe3q8ZVgUPf2RoIRCFREoDKDD4VFCgbJcUykNpL6KgNwkyaUOVYFGtUR3mPXwAMFHVLhsS5P0kaEIY299rhjvNYP9eDxsr7EZCGQDfwVBCSCQ/n4kLHGFPTVAKjoH4ndFxzgUUxGORCBPMbv4SyJ7CnS+IbR1spPboOLCmgupRGoWHiJQsBTd4/1FCO208cRy/S7fM2Q1wjwA/oBdSPw1qHNYPt7f2mlvNxu7O/mHzYPtoC3yvcXBcb+4d7tW2jo+P6ocnu7u11Q/4+NQeRWC/4UCbdJ9/e9/JMzYAYOHAEKIUOJhrGQoEd/NLd+peBDWn7U6n/fFt9+LkP5/aFyfH3Tftkw/HdCKy2PO7pyGvpwRHHDVrnV3W0XTLyKs42xWQ7RnI62n4hFqblsiv5ijyBbO9YLYXzPaC2V4w2wtme8FsL5jtz8Fsy5DNPzw4JkB10rm0mah0//d9LHMzB1/FdRpd6j2vfGRtucSa597ly8Wo62YA2jFTqOs/4Rrvu/D2ceBJV5uFzDMJp/azcvtLa5q9HeDTBDdDiRVZGfgaysvMEL5VZ+UA+FhGkdZWWUEKwjqkIvFkoqIdyq4ICV4+gNCKbwzVUWMFE8/w+MF5G9PArL6rgzDYaqhU5TVXcibe80nxVtcq0SyXRS1h8PM2Xk7jRTQhGgDjIwjr+NpKbZTeCZKTQKAtxBAX87KnkwI7l8uUnBAz3F9UrrmGm+JtqCjdmZfrzMe4Kp2rVW6rZTG1ojBksfqjXKFRZr7wjmlfANxDY20m2cLjVOmJZy7G8ovDFLdrtZHqePpUL4AWYtVeq9Sblf2Sb39KsSAu8k5m1kEKt5frzJY8OD0UJoLnnMSeVSIZ6n/NjAyQDfQtWuFC54rN/xU+XhuBbZRbHJf+ymMg5cULRSEf2suruZAbXvFgRmmm4n2RuRey1L06Ck0DsEgIbJiYJXlsRBZTr4qCjGFAK148dPlds6SKAqtXrkGyq18EHxfvLO50iE+4c/qbV8WyUTGV8tqraBBAnVQtg8Ay0CW33KBJ/nJ1kaf4BngOTp+wdM5T5WkFoEmSojf3cmNg3Xo02JhTjMfjSmaH0ZyFANWxVHc6g/wxawqyvAfwvIqPSCNYF01O23GIZVeovU8XH7Dx9vb2On1WUHG0FDGtFCXrWQ1vC6bwMPfMe4PKEsSHjOnBRT7w43IFKiIQbHx4wPfqTyqeTrEZKBTVoW4iOhT40k5VqZtFKKLTttDYERWn32VhZk9L/qsLl4U2vD+yunTtaim0rlTJUtaFdh/LnX5Y8OWa0icFWC5wXRDBEh05SH2JfOYUKw9x8xEWmj9Je1NKeudnnUsgLiq4EhnhGMXGWBALv1v+NfzDIG7xPGUCbH/wY5YOcnypb/mWLwZDCKzDxcRls5T7o1TSxtJJScpyRrMLwd+l0rNF8r+j60BK/MeM3PY8OmCWIC21IDg1nf4X4mW4Ew== +api: {"operationId":"createSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","description":"The share type of the sequence. Setting to `team` will share with the whole team. `private` will only share with the owner.","enum":["team","private"]},"owner_id":{"type":"string"},"steps":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name given by the user for the step. Used by Salesloft only."},"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate after the previous step (in case of first step, relative to when prospect first enters a sequence); only applicable to interval-based sequences. This is 0 by default"},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence. Only applicable for Outreach when adding steps one at a time after the initial sequence creation, otherwise when creating steps together with sequence order is implicit based on the order of step within the step array. Salesloft does not use the `order` param, and order is instead determined by `interval_seconds` which translates into the `day` parameter"},"type":{"type":"string","enum":["auto_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["type"],"title":"create_sequence_step"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["name","type"],"title":"create_sequence"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence","method":"post","path":"/sequences","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","tags":["string"],"type":"team","owner_id":"string","steps":[{"name":"string","interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto_email","task_note":"string","custom_fields":{}}],"custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence","description":{"type":"text/plain"},"url":{"path":["sequences"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,15 +34,15 @@ Create sequence ## Request -

        Header Parameters

        Body

        required
          record objectrequired
          steps object[]
        • Array [
          • template object
          +

          Header Parameters

          Body

          required
            record objectrequired
            steps object[]
          • Array [
            • template object
            The email/message template to be used for this step. Only applicable for email or message steps. -
            oneOf
            custom_fields object
            +
            oneOf
            custom_fields object
            Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. -
            custom_fields object
            +
            custom_fields object
            Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. diff --git a/docs/docs/api/v2/engagement/get-account.api.mdx b/docs/docs/api/v2/engagement/get-account.api.mdx index c3c918ba03..99f9ad49d5 100644 --- a/docs/docs/api/v2/engagement/get-account.api.mdx +++ b/docs/docs/api/v2/engagement/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: eJy1Vmlv20YQ/Stb9ksMiBItKYorFEXTNgiMtoCR2A1a21BW5EjahNxl9pBMCPzvnVkeog4bOVrDsKzZ2Zk3x5vZbaBy0NwKJS+TYBoswb6MY+WkDXqB5UsTTG+DWmKC+15gIHZa2ALl2+Ah5LkIPwJ9uy/xNOeaZ2BBG38u8QsaFTJOXQIzzTezhFuOpoVE+ScHusAvJl5BxoPpNrBFThfmSqXAJR7BA8/yFGVWOyh7QQIm1iInvKj3bgV2BZpZxWofDH0w8sEWYNFswhZaZQy12EgnDPHZguVarUUCuh+UvRbkQxg7Y1UGOhRJg3AFHPVOQTRWC7nsIgyyYmfiPDgCe40YmnN2+Rti4pY5KTALacEQj7RiIcB4sK2ikKxQTjOe56mIfaHQqYZPTmhImrx0omiCC73ka+JQzmrg8ep0CI19Vtt/FAqvuma2y2bO7eroxudhiobPL+J5PAkn0TAKx6OIhxfjCwg5X/B4zpPFmENQUgtqMLmSBgwZHEYRfexHsWvwWEmLaSeVTn4HHwzpbY+BqfkHiOkiJgFpY0XlBSN8Cvzz8eh8iLlUGwl6dlpZujTl86bRu5EPRzAZRwsIJ+fR83DMz89DPhlNwhHnk/kknsCLyZAqVWX9Syz/WbBfVZZzWfhKq4wL+WUWsiKuDPTxk4zE2DgWkhm3n2NooXRGmgESFkIrfD91Io+GwzAahsMX11E09b//kBOXJ/+/E2FmCaQ4ypKn59KCp4YGU8qNnWUqIQo/Bu0robRj80Qj8iQR1LM8veq0pGdi2WXabeBp2LZg3S9t2fdKt5fivVSciBMpZ4VNO4xHHpbl0ex4DZbxlnm4JFaqXjjEJ5oM02BQK5jBdjc9ShpboNfNUnE6pYlmbW6mgwEuoL5xOV+mDvpCDUAu+RIyZPVgPQwOQbytNdnLq8ug7Kyzt0T1is2dpdbmGyW/Q9FkbdrRORywB6Pm6pKhFi0onqYKVxOsIaVCGS+LYzDVwPeAqO/kQpFjCreyEfXPJ/0fgl2ab6RPPnvVhupvV+OMx771apxNvNRnWGdKXKJi83ObMeJt7yCle4dHdfwef9iltFolLibZnXwHKaoCRUShNPgo+Gc7kGcMXTv6z0/ZPvtbORZzyZzBqyth/AW0scGCeGOZS61AbtCpTsL95W3YRqBcepedVOAMh6XSRf8Okd3+JWDDEFymJKvGOUMWdvTvnzVhU2L63dgHecotcXZQGQgrA6bTY2feyXe3b5ykTX2ljM243NnUTvZzlElqzbmzFuM26+XZTmOz2fTz6pr32QAYbJT+aHIeQysKczfHHTVQ2BtrjMs79+X4hRvfQezmzR8kfP/+/Z38LIbUulTmGkWne/Ypu9cGLTMsPFhKlPA2fCNtazrfNgPB4O1p5zmAvFuhM9LYbueI/UanZUni6kVILE+EoSme1BP2yH27ur/9Edg7HYufAKfermtOjJoGfoCsuRbVuvki0M/e1KP5jD3mvxk9suj6bHB10lneo3Y9gL4axX/5On0inYev7F0ue98A/PBN+iSAwwfyHoRKCV+IkNvO2dHrkErf7rDXr65pFTtq+u7KqPZD/Q9V5mRJu7ukck9/CcxJ9R+J57iMfmrVq5NHL7SrqWloapiy/Beb1sV0 +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","name","domain","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/get-contact.api.mdx b/docs/docs/api/v2/engagement/get-contact.api.mdx index cb3c408ce6..3ca7e86abd 100644 --- a/docs/docs/api/v2/engagement/get-contact.api.mdx +++ b/docs/docs/api/v2/engagement/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: eJy1WG1v2zYQ/iua9qXBLFt2ZKc1hmFp1xXBBqxomnVbGriURNtsJVIlKTuG4f++O+rFlKwYcboFQWKTx7vn3o/cuiKjkmgm+FXsTt0F1a8E1yTSbs/VZKHc6a1brij3rucqGuWS6Q2sb917j2TM+0Lx290OdjMiSUo1lcrsc/gCTBmPkjymM0nWs5hoAqwZh/WvOZUb+KKiJU2JO926epPhgVCIhBIOW/SepFkCa1rmdNdzY6oiyTLEC3QfllQvqXS0cEoZDshwUIYzpxrYxs5citQBKudcxg7g0xsnk2LFYir77q5Xg7z3olxpkVLpsbhCuKQE6LogKi0ZX9gI3XSzZzF0D8C+BwzVvnP1C2Ai2sk5AyskGwfwcM3mjCoDtiZk3NmIXDokyxIWGUeBUEm/5kzSuLKLpUWlnGdWnqKHyLWkJFp2q1Dxd0r+D0KJiqiZ7a2ZEb08OPE4TP5o/DwKo4k38Ue+F5z7xHsePKceIXMShSSeB4S6OwxBSVUmuKIKGY58H/81tdgHOEIEsyOJZd/BZ4V020NgIvxMzUEwAqSNZoUU0PAY+HFwPhyBLcWaUznrJuZ5kpCwCnRb89E5nQT+nHqToT/2AjIcemRyPvHOCZmEk2hCLyYj9BSJIpFzfTL/YExjSsbE88MXxAuC+dwL4wAkBeORPwxoGMwJ8p8zqfSs8O0p/N9QIRcUOSTkSQz+QgI4/lmEM810cuLxV6//MOaJY4gM1eXM9tmmcyNT7E6ReE2486skPGIqEijbOEaeyOXm+hLPZkJpkswiEZ+o94tg6F8gBzivT7XZZXFQUqpnw9POjkdj5yVoz6F+75mMTmKCG7udXSluCz/sbdm0TKWlBdoSfWexvq082nKT5SUwfYt9Zc3amGgh20ANrW2ljSYgvwzcOgxBOSgtLJmVC9SOTCIlQQ2ZpmlnxDYjtMHoeBld0iQRP6s8I4skp/1IpAdIZsXpR3iL5yk6JpMsJYVHoO8LThL4uBbyi3vX9mETaafgu13TWS3lujToVqCAYNu+bXDMrqXgdAaKhGZkeaoHbDanZcsPw2A4Ho7Og/Hkog3oGzxhdO+5S2FadCpCluAHgdPSoVsa8LswtJ3S1LepRKcOh85oWh67Y0b5zOSgpXIpAmsodOcvR/YlzZLNkf0QdiIaH5MAQ48GCqIfY/O5kClSujBsUk8zY2ira/ujkeePvNHFe9+fmt9/UEiexf+/EKZmMU1gDLdHgY6Zek4SRavGnIoYx8+HoD0RSj3yd+QQZCLDeYskb61sMlNkK0DNCFmPT41ZxB4r7Blh3/EPK2077xvB1wy1ZmC1w6gRNA3nNpzQYWErE8o5GabX3e5g4n5DtRPV8ypcrZaivKahFjhPT91BSaAG2/3MvcM2ROWquorlMsHqqXWmpoMBXNv6dQ1lYkD5gixoCrPwYDVy2yCuS0rn8u2VSeLqEniNA3JRAq2r4L6KZuw3iuWovpxUNO1rSVMeiHGACq91BKo9XOjoiiYYIsqsRRH40VyTDCCMeD4XKBjVLXj4/eGk/8Ldm/mGG+M7r2tVzelebf9pfXOp9K1CB6NeRKrddZombTfVpkrfw49zBfOFiPMI1z7yDzQBUooaoSoVPlT+2R7kmQOic/xk7iZ952+ROxGMLrmCo0umzAHgsQaHGGZpnmgGWYm7MvaaV17lrBmscyPSMgXcfOhCyE3/IyC7/ZPRNYRdmgruFJcgB/Lfor97VqmNhunbug+yhGisFoOCgVcwUFaMnRkh392+yzneb9/CpJUSvucpc97PYI1jaIa51qC3Wi3O9hTr9bqfFceMzArAAPuMykhE6yUvy0NI6IGA2FiBXka4ccdLokwEOTfvfsfFT58+feSPypCStprPAYUVPc2UbYRBnRma3ms0FDM8TCBty3S+rQIS69LUukTfYT9XGim22xCw30gYknG5eEfBLI+Zwv4Rl7X9QHx94f32p5Nety6mAnS9+KwIZtTUNQVkRSQrGt1JoJ+9K5vCmfOQ/Kr08I0ts8JlmXOHQ01ZgJ6M4r980zlizvbb1N6WvW8A3n7JOQqg/azUgFAQXUJdzrS1d/Cmgq6ve9ib1++xS+cY9HbLKPpD+QE90+lSu5cU4vEvgukk/xHzHJrRTzV5sfPggbo1VQGNAbPb/QtxmD8t +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"account_id":{"type":"string","nullable":true,"example":"45edea5a-0b9a-44ff-bd45-4452014eb4fa"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}],"title":"phone_numbers"},"open_count":{"type":"number"},"click_count":{"type":"number"},"reply_count":{"type":"number"},"bounced_count":{"type":"number"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","first_name","last_name","job_title","address","email_addresses","phone_numbers","open_count","click_count","reply_count","bounced_count","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/get-mailbox.api.mdx b/docs/docs/api/v2/engagement/get-mailbox.api.mdx index 222d3ddc78..3e00acf557 100644 --- a/docs/docs/api/v2/engagement/get-mailbox.api.mdx +++ b/docs/docs/api/v2/engagement/get-mailbox.api.mdx @@ -5,7 +5,7 @@ description: "Get mailbox" sidebar_label: "Get mailbox" hide_title: true hide_table_of_contents: true -api: eJy1Vvtv2zYQ/lc47pcEiGzFdtPWGIZ1WFEE64AiTVZsaeDS0tlmK5EqH3YMQ//77qiH5UeCLt2CILGPx7vvXt9xw3UBRjip1WXKx3wO7g8hs6m+52fcibnl41teS8DyuzNuIfFGujUebPh9JAoZfQH6dlfiaSGMyMGBseFc4Re0KlWS+RQmRqwmqXACbUuF8q8ezBq/2GQBueDjDXfrgi5Mtc5AKDyCe5EXGcqc8VCe8RRsYmRBgFHvwwLcAgxzmtU+GPpg5IPNwKHZlM2MzhlqsaFJGeJza1YYvZQpmB4vz1qQ91HirdM5mEimDcIFCNQ7BtE6I9W8i5Dn662Jc34A9hoxNOfs8jfEJBzzSmIWsjVDPMrJmQQbwLaKUrG19oaJoshkEiqFTg189dJA2uSlE0UTXBQkT4lDe2dAJIvjITT2WW3/QSh51TaTbTYL4RYHN74NUzx49iKZJhfRRTyIo9EwFtGL0QuIhJiJZCrS2UgAL6kFDdhCK4vdigYHcUz/dqPYdniilcO0k0onv/3PlvQ2h8D09DMkDi9iEnBunKy8YISPgX82Gp4PMJdAGTmmqXyWiWnT5Z2bdIAXvQUzqZzsqz6cseHLWXo+gziKX46m0UhcnEfT0fNZNIShSOLhcBAPU6pwgrV2kE6E+xZoM21y0uQ4YxA5GVpg63QQDwZRPIgGz6/jeBx+/yYnvkj/fyfSTlLIkH3Sx6lkJjJLXJIJ6ya5TmnqHoL2JChlt8dveRiAqvjbWu4kfidBO4EcQYk97qTLOiOGHsvyYFjfgGN52+rIygtdUzw1MI3imPfzhtv7m+28lkQUYJYNjXuTEYc4V9hxv4+U37O+EPPMQ0/qPqi5mEOOc9RfDvg+ive1Jnv17pKXnQXynoarmp/OGmkrgJLfgZZDS2yNzj6l7fpDNwy1aCWILNO4DGAJGU2rDbIkAVtRbABEbaNmmhxTuJWNuHd+0XvJt3m+USH77HUbarhdEYhIQufUOJt425Jj6+jE/tJmLNE51XsnpTuHB4X8EX/YpXJGpz4h2Uf1ATJUBYqIQmnwUfAnW5CnDF17+hR4rcf+0p4lQjFsQrwnbbiANlZYkGAs95mT2Np0atJod11atpIoV8FlJxXImjDXZt37iMhu/5SwYggu14pVBMpwiDr6dydN2JSYXjf2fpEJRyPXrwxElQHb6bHT4OSH2yuvaDe+09blQm1tGq96BcoUtebUO4dx2+X8dKuxWq16RXUt+GwA9FfafLGFSKAVRYWf4lboa+yNJcYVnIdy/Cps6CB2c/WWhJ8+ffqovmlCal0qc42i0z27M7vTBu1kOLh3lCgZbIRG2tTzfMvbecbr484GxsFboDdS2WymCP7GZGVJ4uoRRmOeSkssnNYMeeC/3Zbf/+46Ox5MoIBjz8WloJEa88AgS2FktS7+FeiTq5qTT9lD/hvuUeuuzwZXJ53lHWrXDPRkFP/lg/CRdO4/bLe5PPsO4PvPwEcB7L9JdyBUSq+QmAvXOTt4kFHp2y325vU16gpPXd/dGdWCqD9QZY6WtLtMKvf0l8AcVf+JBh230c+tenXy4IV2NzUNTQ1Tlv8AmRuVGQ== +api: {"operationId":"getMailbox","tags":["Mailboxes"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"email":{"type":"string","nullable":true,"example":null},"user_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","email","user_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"mailbox"}}}}},"description":"Get mailbox","method":"get","path":"/mailboxes/{mailbox_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get mailbox","description":{"type":"text/plain"},"url":{"path":["mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"mailbox_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/get-sequence-state.api.mdx b/docs/docs/api/v2/engagement/get-sequence-state.api.mdx index e260c44be5..3832f84b3f 100644 --- a/docs/docs/api/v2/engagement/get-sequence-state.api.mdx +++ b/docs/docs/api/v2/engagement/get-sequence-state.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence state" sidebar_label: "Get sequence state" hide_title: true hide_table_of_contents: true -api: eJy1V22P4jYQ/itu+uVWWkMggV1QVfWqnk6r9sNp966ndm/FOYkDvgt2ajuwCOW/d8Z5IQF2dS8tQkDs8cwzb8+YvadyrpkVSt4k3txbcnvH/ym4jPmdZZZ7l55lS+PN771mnbgN4z1ceobHhRZ2B9t775GyXNDPHJ8eStjNmWZrbrk2bl/CA1gQMs6KhC802y4SZhlYEBLWQbnewYOJV3zNvPnes7scD0RKZZxJ2OKPbJ1nsGZ1wctLL+Em1iJH8CD3fsXtimtiFaltELBB0AZJuQW1CUm1WhOQIoFOCOCzO5JrtREJ1wOvvGxBPtK4MFatuaYiaRCuOAO5cxCN1UIuuwi99e6gYuSdgH0LGJp9cvMbYGKWFFJAFLIdATzSilRw48C2gkKSnSo0YXmeidhlDYxqSIzQPGni0vGicY66lW/xQxVWcxavzrvQ6Ce1/iehmLp4FgaLZ3EIas7s6uTgl0FL02g6vvJDypIkoeEk5DSKrqeUJ/7VbHblB0k89UqsRM1NrqSBogWFY9/Hr74z/eIGM7GSFpKAkp1oDz8ZFN+f4lPRJx5bOAghgY6yojIGjj7nwyQMRmOIrIvKOUlZZBmLmprves9iKzYc04JQ4Wlx3tbTGuLJzIcQBfSahwENr1lIr0eTkI7SKPJ9Fs+CaYT610xkkXqs9R/rezo/wSxNRin3qT8LIxqy6YhG4VVKAx6w2A+CMWQI9ReG669WziJ/Evg8pdMRJp/NZjQaTyM6jSZgKL6Kp2MXnLbwvtZAdA0FNRn5dBSHPg15OoU64xAiHgWTNJwlQeD6Oob2sDxZMPsl0U+VXqOkB7TEqRWuaw5Gx/54TP0xHV+99f25e//tQpQn/78RYRYJz4Cwk+fZN2WZQfrNmLGLtUqQqJ6C9k1Qyi4f3HuOLEzdl51iPFROrwf6Oe8lqBfInsNnvAHesMJmp+wFAMvyhA5fc0saOdKihZGk6rmK3IBkN/eGfX1muD+hx9K5oTfN8Cx0hsxtbW7mwyEM2oEpcrbMCj4Qasjlki35GvhquBl7x8juakny8s2NV3bG9h2SWMVTneHdJhFWfuc4kttx0sgcD5K+PTBDQAoHMcsyBSOYb3iGrGjcWhxzUw02BwgrT6YKDaO7lQ5/MJoOZt4hBe+kSwx51brqTreZd81d4Wz8xUrDcsHqU7H5pY1YrNZYCr2Q9jZPkvsjvMiNtFolRYxrH+R7noEoR4/QlQYfOv/iAPKCgOkCf7n5MSB/qYLETBIoXTgnjDsAOraQEKdsXWRWQHfgrk5o/5JiyFbAunQmO6GA6cSXSu8GHwDZ/Z+CbwmAWytJqkFFoA878g8vGrcxMIOu78M8Yxa7dlgpoJUC06mxC2fkh/vbQuKN5I0yds3kQacu5CCHNYmlGRXWgt9ms7w4SGy320FeHXM2GwDDrdKfTc5i3i7RvIhg+g4V1MYG/HLGXTp+ZcZVEHl3+wcufvz48YP8og6pZTHNNYpO9Zzt4141tA1i+aPFeAmnytXTvu7x+yPOMKBkfnoJgmZcAQKU3+8jcOidzsoSl6vrMLZ+IgySe1IT7wmY9qby/Tfgy/OeOVo4d3HfMGyzuedYZcO0qKbQV4F+cVtT/QV5yn7DR3LXtdngOo1q+QCHanL6ZjD/5Q39mage/9M4hPTyO4Af38ufBXD8J6EHoRJ6CZyd287eyZ0YK6Cddq9fvQVZVmAndMdJNTvqH5iZs5ntzpnKPH4imLPiPyEHwKD6uRWvdp480I6tpq6xYMryX3R4Hnk= +api: {"operationId":"getSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_state_id","in":"path","required":true,"schema":{"type":"string","example":"ffb62704-addd-454e-bb86-ed0799703dc6"}}],"responses":{"200":{"description":"Sequence State","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"state":{"type":"string","nullable":true,"example":"active"},"contact_id":{"type":"string","nullable":true,"example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"user_id":{"nullable":true,"type":"string","example":"ab0530ef-61dd-4a99-b26b-6b5a61c7c62e"},"sequence_id":{"nullable":true,"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","state","mailbox_id","user_id","contact_id","sequence_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"sequence_state"}}}}},"description":"Get sequence state","method":"get","path":"/sequence_states/{sequence_state_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states",":sequence_state_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_state_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/get-sequence.api.mdx b/docs/docs/api/v2/engagement/get-sequence.api.mdx index 67ec1f013e..c4051c5750 100644 --- a/docs/docs/api/v2/engagement/get-sequence.api.mdx +++ b/docs/docs/api/v2/engagement/get-sequence.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence" sidebar_label: "Get sequence" hide_title: true hide_table_of_contents: true -api: eJy1VllvGzcQ/ivs9sUGvNJGvmShKJqiQWA0D4aPBq1tyBR3JDHZJbckV7Ig7H/vzJ7U4cB1WsOwpeFw5pvjm+E60BkY7qRWl3EwCmbgbuDvHJSA4ChwfGaD0X3QiGzweBRYELmRboUH6+A55JkMvwJ9eyzwNOOGp+DA2PJc4Rc0K5VI8hjGhi/HMXccbUuFcjRrVvjFijmkPBitA7fK6MJE6wS4wiN45mmWoMyZHIqjIAYrjMwIMep9noObg2FOs9oHQx+MfLApODQbs6nRKUMtdmxihvjcimVGL2QMphcURy3I51Dk1ukUTCjjBuEcOOrtg2idkWrmIwzSVWfiXbAD9hYxNOfs8jfExB3LlcQsJCuGeJSTUwm2BNsqSsVWOjeMZ1kiRVkqdGqwJNJA3OTFi6IJLiwlb4lD584AF/P9ITT2WW3/RSi2bptxl86Mu/nOldeBiganQzERZ+FZNIjCk+OIh8OTIYScT7mY8Hh6wiEoqAcN2Ewri+2KBgdRRP82w/B6XGjlMPGk42W4/8WS4noXmZ58AeHwIqYBqeNk5UYvFRgKdE8MKk8SPml62I/p4nQKUTy4CGEoRHgy5CK84NM4hGgQD6Pjc356cU5F2G+3tXN6cvxuQGp2DIo8xa+iUlWm9Q6+TT9FMwdai9wYTqyVDlK7C6wg03k6tg4y/xhlE2xBPMUBYaSw+7LK41hSAXhy5eW3BiywKx3EY+5ek+apNilpBjgNIHSybNYu94NoMAijQTg4v42iUfn7F4HLs/j/d5Jw68apjonvL7l6k+nCJ9d9UDGva4u66HVJ/Tp1VdnI80Y+9uBGujnpEp/uCKIodibHR3DMdrRDZ3NdbxwiE82FUdBvNGx/7U2PguYWmEWzVXKT0EhzLrOjfh83UM/mGZ8lOfSk7oOa8RmkSOr+YhBs47ipNdn7q8ug8PbZDTG9IrO31bqmz+TvsGoSOPJ0tifspj90w1CLNhRPEo27CRaQUGvbUiYw2Gril4CIxWqqyTGFW9mIeu/OehdBl+o7VRaAfWhDLW9X04yLsp1qnE281Dspl5S4WAv7S5sxoVOq8kZKNw53Svkj/rBL5YyOc0GyB/UZElQFiohCafBR8AcdyEOGrnP6VA7ZHvtT50xwxXKLV+fSlhfQxhILUhpL88RJ7Hc6NXG4ub0tW0qUq9Kllwoc4TDTZtV7QGT3f0hYMgSXasWqac6QWZ7+40ETNiWm58fezxLuiIf9ykBYGbBejx2WTn64v84VreorbV3KVWfT5KqXoUxRa05y5zBuu5gddhrL5bKXVddKnw2A/lKbrzbjAlpRmOUTXFF9jb2xwLhK52U5fuW27CB2d/2JhE9PTw/qVQypdanMNQqve7ZYu9EHLTUcPDvKlCyNlJ20rhl9304Fmisj/0WA1JujP9JZrycI/84kRUHi6lVIRI+lrdfZlCcWdgC0y/v7H4JH+6Mph8C+9+uCE6lGQTlDFtzIaiv8K9AH1/WoPmQv+W+mj1r5Phtcfj6LR1Svh9CbYfyXT9Rv5HP7qd0l8+g7gG8/TL8JYPuVvAGhUnqPszlz3tnOA5Fq326yjx9u6QGTU9/7a6PaEfUHqszemvr7pHJPfwnMXvWfiOu4kH5u1auTFy+066npaGqYovgH92fJkQ== +api: {"operationId":"getSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Sequence","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","nullable":true,"example":"95fe0d29-e8cc-48ac-9afd-e02d8037a597"},"id":{"type":"string","example":54312},"is_enabled":{"type":"boolean","example":true},"name":{"nullable":true,"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"num_steps":{"type":"number"},"metrics":{"type":"object","additionalProperties":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","is_enabled","name","tags","num_steps","metrics","created_at","updated_at","last_modified_at"],"title":"sequence"}}}}},"description":"Get sequence","method":"get","path":"/sequences/{sequence_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/get-user.api.mdx b/docs/docs/api/v2/engagement/get-user.api.mdx index 4b62ccb18c..e55c8ddc9f 100644 --- a/docs/docs/api/v2/engagement/get-user.api.mdx +++ b/docs/docs/api/v2/engagement/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Get user" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: eJy1Vm1PG0cQ/ivb7ReQfLYxhFKrqpqqEULth4hA09Ygs74b25vc7V72xcay7r93Zu/F5xcQIS1CYM/Ozjzz8szsmuscjHBSq6uED/kM3K0FwzvciZnlwxGnr5bfd7iF2BvpVihc88dI5DL6DPTtvsDTXBiRgSNdOlf4Bc1JFac+gbERy3EinEC7UqH8iwezwi82nkMm+HDN3SqnCxOtUxAKj+BRZHmKMmc8FB2egI2NzAkp6n2cg5uDYU6zygdDH4x8sCk4NJuwqdEZQy12ahKG+NyK5UYvZAKmy4tOA/Ixir11OgMTyaRGOAeRhDzsQbTOSDVrI+TZamPihO+BvUEM9Tm7+g0xCce8kpiFdMUQj3JyKsEGsI2iVGylvWEiz1MZhxKhUwNfvDSQ1HlpRVEHFwXJa+LQ3hkQ8fxwCLV9Vtl/EorHlhlvUpkLN99Tfxmg/uDNRTyJz6Pz/qAfnZ32RXRxdgGREFMRT0QyPRPAC+o/AzbXyoIlg4N+n/5th1D1dayVw4TTeSuzvU+WlNb7qPTkE8QOL2L4SBUnSxcY3nPI35ydngwwi1NprBuXedlXVz5NxaRu8nbgl6DNDKgOqXiVgb9IAa9jMDL9uquz4PsX63MxSz10Y52RpRhbw0EyFu4l5qbaZKTJkZIQORk6ZuNj0B8Mov4gGvxw0+8Pw+8/5MTnyf/vRNpxAikOq+T5yTMVqYW6BJlOiKRPQXsVlKLNihEPlGl1TLv4dSW36rCVr624DoBGkjjp0pqg6L0o9nh+CTiZSqLgNJ/raidQ+xOLh7xHp7a3rjhe0GQBs6jnvjcpDR3ncjvs9XBHdJs2kroHaiZmkCH9eosB3/X9odJkb99f8aK1cT4QJ0vatfZOUwOU/A60TZpJWOvszsBtf+iGoRbtEJGmGrcHLCAlktsgi2Ow5UwOgKhx1FSTYwq3tNHvnpx3f+Sb1N6qkHD2rgk13C7njohD71Q463ib2mLz6NhuE6+zk9JdVm6H9D3+sCvljE58TLI79RFSVAWKiEKp8VHwRxuQxwxde/oUxmGX/a09i4WiZsB70oYLaGOJBQnGMp86ic1NpyaJtverZUuJchVctlKBwxZm2qy6d4hs9KeEJUNwmVasnLsMadTSvz+qw6bEdNux9/JUOCJdrzQQlQZsq8eOg5PvRtde0TJ9r63LhNrYNF51c5Qpas2Jdw7jtovZ8UZjuVx28/Ja8FkD6C21+WxzEUMjinI/wWXS09gbC4wrOA/l+FXY0EHs9voPEj48PNypFzGk0qUyVyha3dNi6lYPNLRw8OgoSzIYCF20rlg8ChPA4tVhvauRbnP0QWfr9QQh35q0KEhcvtWI3Im0NH2TajLuOW5W67c/zzqHowjEP/SqXAgi0pCHubEQRpZr4qtAH11Xs/iYPeW/njhq1fZZ46pzWdyjajV0Xg3hv3w0PpPL3cfvJpGdbwC++1R8FsDuu3ULQqn0Fmdx7lpne083qnuzsS7f3aCu8NTr7TVR7oTqA1XmYD3b+6N0T38JzEH1n4jbuIB+btTLkycvNOuo7mZqmKL4FwFKoRI= +api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","first_name","last_name","email","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx b/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx index 0662e328c6..dace5b0ae5 100644 --- a/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: eJytV9tuGzcQ/RWWfbEASevkIUCMoqiTCI3boHZsuUUhCzC1S0lMdkmWF8mCoH/vDLlXSXHswDagCzk7c2bmzEVbmnFteMocz+iZM573qdLcMCeUvIAjarnMrpi1bmmUXyyv+X+eW0f71LGFpWcT2rqk0z7Ip94It4GrLX0YMC0GXzl+m+7gNuM2NUKjdtB9A7qJiRpJJgCHyzfEKcKINmolMm7AUCnwTmWgZhu+gmgNN1XScenwimmdizRgT75YNLGlNl3yguEnt9EcjKrZF7ADesEEeOoEt3irmVu2pKwzQi7oPuLxkhOURJAYGeLgoPIAzk4yRaRyIGNtuMtUwYTs0V2fFtwtVXbMBpe+wFD+PhrDt6vLm/B2G17Px+8/wvuH0afReIQB5g+s0Dk+j+Kgd8kZBMoec7EL/mMURJwRnwJ4awkwOCtAmmWZQFGWX3VC04W7A5Pgr9l83+BnFANbhoHvL2N5VrKgawi5cVw5OUmZJDNOog6iDPnj5vIvEhH3wLaS/HIe2LpnrX/o3nGcyMPdFNE13JxEQtVZh+soYLWSNnr3+vT00JVWOZFKmr4Yy73Jn0byuc9zcnv9qUPwNbNkDSggxLRNxKVz2p4lSeqtUwWXC7bg8OaGqSoS6ABJyoCf4L51zPl2ZoH4s1Dke40hyJFUZYDEqKIspRZjauMQxOfUwDi4E8NKyqe+YeL5pGRy8z0qlQ63TgQkdtE9mimVcybbR8wYtgFQwvEioHiEis9l7rEYoUtH47JPc2RUndgmEdNdnaMAd1Tla0tXLPe8JuMTydNwBxLeyffDoKSnHeSiEFAib9/UOZmEugul17ShkCEJX8D6w6C0awYiw/hiAKJ2tLlfVk3LrslfbBoVr5Dkh8Gs7snFBwgnc8RLAZBh1sGIk07MIRkhzrWgkGSjvCGtWqf9vdGHaa69qOblIJz8iB/KY4LT5XEXKv2k1L8HZdqMN6pV2A/iQKWJbu0HuB6YVZWCbv4h1UPrNVsAO4ZCJQ0TktXrww5RSpLzqwu6a+0dN+gqL5lRbx9NHWnxJ8dCqiNXyezHrGsPzBCQCstJnqs1yfiK51hJYeCwNOXlxA+AIIbYmq+b1aVVAGVk6hzUkYvzv+F2a9LWjG56CuCdq1BQIB1Rng5fvRm+xeVMuJDUW4nkysioDmbAF+cJS8M8KSNRRRRJATsLpiZTqf2tzgnUI9x1k9a5PCDOz/BHLqQzKvMpnt3Jf3gOohxjhsGq8GF4TxqQPeg4qcdPgfpD8q/yBAe5h67tlsKGB0DHGlIelBU+dwLii7cmG0Cxu01NWphaAs5lMNkKBa69C2U2wztANvlb8DWMnKJQksSCIXNYFxr56UnlNgZm2PY90TlzIF0kUcEgKrAtFveCkZ8m115ieV9BlRRMNjqNl0MNZxLJP/POgd92teg1Euv1eqjjY8FmBSBZK/PVapby+mig/QwaR6KAGyvwKxgP6XjHbOAoDnc8vL+/v5NPqsFSFtNcomizB5dh3dldqh8KHU5sm03miet/WbiOPziMsggAyj0mVhLuWp3fIEvsQHC83c7A21uT73Z4XNbSBD6umBFshiUymdbrQ2hKmbB4AeU4Z7nlj8A/uS57YI+8ZJM/6m9oYgfDqpykNCwKPwx8v7U/CmB/znQgRKH30dBgjHoaiYO1tXniHLqndo/KtgdM+QOp2roK2BLh1LA1ziV4PaN38I+rfXA+zIJwvqU5kwsPlAaZqBc7NfOdn35QBHEelB9a+xwseC2U7dkRHcHX9tLWEf8Fqw6Gz6+1eLz55gP1KIrSmAhcZ/4HU4N4Yw== +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customengagement.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customengagement.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -46,19 +46,11 @@ Headers to pass to downstream Query parameters to pass to downstream -
            body object
            +
            body object
            Body to pass to downstream (can be string or JSON object) -
            oneOf

            MOD1

            - -Body to pass to downstream (can be string or JSON object) - -

            MOD2

            - -Body to pass to downstream (can be string or JSON object) - -
          +
          oneOf
        • string
        Passthrough response @@ -66,33 +58,9 @@ Passthrough response The response headers from the downstream -
        body object
        - -The body from the downstream - -
        anyOf

        MOD1

        - -The body from the downstream - -

        MOD2

        - -The body from the downstream - -

        MOD3

        - -The body from the downstream - -

        MOD4

        - -The body from the downstream - -

        MOD5

        - -The body from the downstream - -

        MOD6

        +
        body object
        The body from the downstream -
      +
      anyOf
    • string
    • number
    • integer
    • boolean
    • Array [
    • ]
     \ No newline at end of file diff --git a/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx b/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx index 3282816573..b2e9f9ff69 100644 --- a/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx +++ b/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/engagement/update-account.api.mdx b/docs/docs/api/v2/engagement/update-account.api.mdx index ecf64d821c..d17d506eca 100644 --- a/docs/docs/api/v2/engagement/update-account.api.mdx +++ b/docs/docs/api/v2/engagement/update-account.api.mdx @@ -5,7 +5,7 @@ description: "Update account" sidebar_label: "Update account" hide_title: true hide_table_of_contents: true -api: eJztWn1z2jwS/yo63zwz7UwMxrzT692RQHq0TZMD+nZJhke2ZVBrW44l81KG734ryQYDSZt2nv4XmkmwtFrtrvblZ23XBotJggVl0cAzOkYae1iQruuyNBLGiSHwlBudayMb4cbticGJmyZUrGB8bSxNHFPzK5FPtxuYjXGCQyJIwtV8BA/Ad2m6KRcsJIlJPeBLIxicEeyRBJ64OyMhNjprQ6xiSc5FQqMpzJAlDuNADoWrHYuKsTkxPMLdhMZSdJgezwjK59Ggh8QMC5RG9C4lwQpRj0SC+pRwmCgQ0gitWJogHMcBdZUZYNOE3KU0IWAPkaRkc1LQIk7YHJglphr5FT1YKhKC3dn9KuT8Ucb/QVGwPpDJzpoxFrOjFY+TybLrLddxG2bDsi2zVrWw2aq1iImxj10He34NE2MjT1dyJ1ycMm8lWR5u5rJIgKXlVMGk5S9cKrg+loU5X4gr/Qz0Bj8UcECarcsS78d02hbHmkVpEGBHqqbF2ml6sUJnLIxxtFL2ZyGm0c9xCFeuZlCCv5IJW0QkkefwU2zafpW0m75n1rw6/CK+a7brbc90HOKA0a1m269L7oVz/in+mNQcYtkts201W2atVbdMbDm+6dmViu003ZpXUVGkQ2ECoRF4/D6LY8+j8hBxcFWwvd5u33/PFCu0OyIkGHIIBBmHZ+LpmMQJQRETyGVzAp6DnJUOSRaGLEJ62xK6VH8R5BWOQuCLQizcGQL9XAHxDIz1oiQhPGaRB+bYxU73alCSuYsKZYp9FTebwgxEoiCTzMZqaufR17kb3m62hlUW6udGXhtzHKRk32PlQVXsau0kj9SCy+087sCNTjJRvAmG4DFsy66alm3azbFlddTP/0A69ZEiSpW5Fsa2LPln/ySybI10NpcZ4i8KTJIkLCm6CU4SLPWigoT3us/+eo8ITIP7PPk4Ffrg20htiELCOZ7CUAL+JQ8+ISETBF1lJ15CcoFWAuHIQwGZkwAxH+kN0YICrzlOVtLdtqv2cuD6BozkkRujU7OskxvDgRQHDzDMBRYph+83Wv8bA6YzkdRoFhgrpNyBowXJfByeqddB1+sb+TEo/yAH9EPHxwEnJ/oh56Zn9J8t15vix5hMsAM1ZAIS7Y0jj8HWcleypFzowYy9FnuP+fDyqj8cf570Lvujd+NJ/9NgNN5bI713b8nBxjldwFxQ6hvx+nKTi9+kyOZWWV0FfJDBFWV77LZrdt2G7Gk5dbNW92wTexXPbOO232zUK17Ts/VSiIQpS1Zq1Yfu20GvOx5cvpv0h8PLIWwAJLqOc33qkBRAF1MGTsICEwcBW5gQpQpJwNEpPuoMNXvfdKGqE7PgLb3P77oXg7N8HiJFDbesetWrNJ22h0m70aiZo9cZDYsiiBpQTtG5AcuZ6+g1AxJNxUxNVhuVvSkZT9ogB+H9wp3hhBPxMhW+2VJrZFJQtBcsOkGVChqRGMmcg+xqp17p2DZ6dTFWpBEJFGXmwTxVVpn4CdZy6nO2SlYlc4eExCwRE8H2XAC0l5yKfhPi5WTnKQ2r1rKsjdpTszCBRWFnEnkxo4BAswV5TKVJsLfTTIiYd8plXIINS2DC1PMDqDkyzZY15/K8+i/+8ny6SD9dOpd/2OffGnj2/vUbvvzSe4s/jT9+Yex1S5xai9of9in8vMFp8Gokltb5q69R5Yq9ZpdL+01yfuHT2bd3nt+9o1/vmmfh1PGCcPHmtDX7GsZVMnYarbt4WrHefjoPhlM6uhvOnI8XzdXnkc9aZ5/Cq1M39+7MKNOEpfGvWw7qLBTV3HkyzfUM5FkXbJrgiCvr5iBeEQNHEzi+rFbq1YZlWS+gZrtB6pFR6vRUxeIvoLySgGFPsZOpVK1kCZ1ScCKoOCQWZj+CHAoJXREtzaJzmkwldx0ZEeMR9f2MjERztjLTmEtkHJpSC+oSU9BQu2m7khPOV1IFmAsgM5Ao0zV/mKjDP6IFmwoiZfHpNNXvOvcsK0OEP7A0F0ilRFUGpMAQU9qekI+yolBcqs4C8NzKjJlOVRR7ll2epY58YxJeWasNBXK5MhuQxtqthltvmO0ln9lH7OY0ESkOzBmDlKjifCsucIQzFWYhOcJL1s9lxx0XMBAJaEiFCdEGOsCeIVRPCg4DOEsfXwV8xHpwHXhTTvUgDRRw8CrlKfKA2w8S6m2DVcbxh3SHnLMF2XvLL9hFmV8tsk8rp7Vqq1Ft2M16+7TRrZ1VIfbsbq/SaJ22rGqvd1Y57Teb1vEHYnxzE0nADecNgD2caAD0GCA0SmM8BWCRgSGJUhDmnLlUgjvANmKmQJGa3gc1F4PRaPDu1WTY/+/7wbDfm5wP+m97xg4C/2j/LnISSiSO2o5KWLXb7hB5SXaSIodsj0Be34dP0mqbAvn1DkU+YbYnzPaE2Z4w2xNme8JsT5jtCbP9Hsx2CNmM025PAar+aKwrUeGu8cdY5rZw/5hdp8HIAidS/99wtfZDyPkwGNwU70q3Em7vIfeR4nt114jwtnUUEjFjnm5MuLIzoRoUHaOckfDyene5vZHdE5UJddsISoRsrOSFIaYlnqHgEmUQhVNIfSGkqfLcPsKsW7zcvRrINL1tWI0kTNXWKrStdgaP6RsiLb7t9uQ0h32eA4x8NZAX1fJSWiEOAMtzSLtwNuoGXIMSBZmVQGA5WeOHu05K4UJ5d4/8U7fHux7E4xoL+32FxzULjnsFygto5DN1FQ7qantYpUqj1C4ExftItt481N8em7KEvpUGUFJQNz87+YIQapDvMZf/e3v6Wt9999ibPHLMv8MHDSQi9FINgKKPJABSkrcRcvnkQT7bCfkcUK2bym8qP5fQZ5YiF0co5bB0RrlaADwW4FyKWZgGgsJJytnEM2MsM0HeluDqTY1GasuCKXKQW7oBya4/ULLImyHZa5UPL307+ttnudrSMKWi7uUYKglQh2XNwNQMeCFenqtN/nY9TCPZ/LyCyhTiaMczSaMS1PQwkmHmpEKA3nw+fb6jWCwWpVgvU3vmApQXLPnKY0i82yEzTh3AtWXZ6ZmDXmpzdRynmKtoQO+Hb+Xgn3/+eRM9KtozWpXWtBQF7znKQXuesA10QZZC2ooqNsqX1ll2us4Dg8PqTiFIII3IMi4p1msHxH+fBJuNHIYwTlT3+0RCLKrbcfItlXL53cvfGg+F2bZkjGfDrOn0HMmouU/IPEWpNJB1nQz4qjJYMZhVfckS1S9L8Vc20+9VR4t9+J8CtnrJPvcvC37YQv+uAIf9/D0RNNFZBojHks+O4qiNtluhgfV3aW8L9fGqOz77D1A7WVM9ZJ5clOCFbOfD745xA/9kmtdwXBUKOb42AhxNU4gOoNGMZUrGqXTlYl3TRSz7It3iXn8qFjytifwt9bqX/B8ygKFi/nNLrmceXLCtn5qaKjS02fwfBwa5Rw== +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/engagement/update-contact.api.mdx b/docs/docs/api/v2/engagement/update-contact.api.mdx index 9ba9344ece..4a3bb6fe6d 100644 --- a/docs/docs/api/v2/engagement/update-contact.api.mdx +++ b/docs/docs/api/v2/engagement/update-contact.api.mdx @@ -5,7 +5,7 @@ description: "Update contact" sidebar_label: "Update contact" hide_title: true hide_table_of_contents: true -api: eJztWv9z2jgW/1d8vtmZ7VwMtvnO3t4dJKRH2zQ5SHbbSzKsbAtQa1uuLUPYDP/7vSfZYANpk2x37peknQSkp6f3XR99udd5RGMiGA+Hnt7V08gjgh7zUBBX6Ee6ILNE717rWUui3x7pCXXTmIkVtN/rdwaJmPGZ4rfbNfRGJCYBFTROZH8IX4DvneGmieABjQ3mAV8WQuOcEo/G8C1x5zQgevdeF6sIyRMRs3AGPfSOBJGPTcFqy8LS10e6RxM3ZhGKDt2Xc6rl/drwRBNzIrQ0ZF9S6q805tFQsCmjCXQUCFmorXgaaySKfOZKM8CkMf2SspiCPUSc0vVRQYso5gtgFhuy5Tl68FTElLjzwyrk/LWM/4OiuMohk601IyLmeyMeJ5NpN9qu4zaNpmmbRr1mEqNdb1ODkClxHeJN64Tqa/QucqeJ6HNvhSx3J0OpwNLYVTBp9VOCCt7vy8KdT1TGGegNcSjAQYqty2Pv23RTFidioiyyr1+Y+j5xUEEl3Fbf15THM4oe8MmzGHxAAhj+iTsTwYT/xOHHg3McTTwvpklySM/dsWW9XZl9T5lxTELtNCahyxKX49wuT0MRP5HL1biHYyOeCOJPXO49Ue9O3TJbyAHGi6farKcGxpSKifW0sQ27ofVB+5CEBSb2k5hgx3pdzK9r5YetLcuWybUsCF2Y+rbA+jr36I6bCl4C0++wz625MSZaqGigktZFpaUmMH8WuJswBOUgO5k/yRpoMTJJHBPUkAkaHIzYcoSWGH29+Myp7/N/JWlEZn5KKy4P9iSZqNGP8FaYBuiYKGYBUR6BhYiHxIePSx5/1m93fViW9ODEt+uys3aUO6TBYQWUCEXb7xocs2vOQzoBRRy5hj7XA0U2T8uWv1l1q2HZtXqj2doV6A94Qup+pM+5XNgC7jAfP3BYkON9t5TEPyTDrlPK+paVOKjDvjPKlgf+fBkCOfOeWOWmNdppTT2j7jXgF526RqfR8QzHoQ6sp2arM23I8u/K9H4yf0LrDjXtttExW22j3m6YBjGdqeHZlmU7LbfuWRIgKZQzAdTjewcDBsKO4fpM/ItC6KjpytDkWLLSthGmCa45FPBTAt+pp+AWiakWcqG5fEHBjZqzUmiLBwEPNTVtRTuXfzWAjIkWAF8tIMKda6CfKwCqAWM1KIaUiHjogTm2sKh3MazoW4+VVcQY2vQAyBJ0ksEkfTe8MoRRCCJpoUFu5Ht9QSCXy2AEHYUhVVq5H1G5H67L2ljslea8zB8/WOUPFeo/XJZ8FlJbpkMRVeVQqYSUFPzZq1TPSsKsDuC8ymXehAB+1G3TrhmmbditS9Psyv//BS/KH3Qlhka2QtmmiX92IlY5XlMbGk//btiUxjH/I3XZowI8cCjj93cDUwgHTU6oBeAuMoOmGPIQEySmARdUu8gyo6LhAKWERkJP8+mC+hqfampCbcmA1wJKMablZlRpJb6/0RFa3Ojdumke3egOoHz4As0YfGkCn2+U/jc6dGciydasgKw0mTaJtqRZLYDvzOtq1/c3+KOz5BdsUF+6U+In9Eh9ybmpHvVnw/Wm+KNPJsSBbdQEJCq1ax6HqXFWescSoRoz9krsEvPR+cVgdPlxcnI+GL+/nAw+DMeXpTEY7aUhOxPndD53QanfqTfASc7+JEXWt9LqsjD62Y5d2p64nbrdsGGVMZ2GUW94tkE8yzM6pDNtNRuW1/JsNRQyYcbjlRz1S+/d8KR3OTx/PxmMRucjmABI1FY2UV6HBQp0MTBxYu4bBMrJ0oAslZtpcJ3kI32o2E8NFza21ChEy8nH972z4XHeD5kim9tmo+ZZLafjEdppNuvG+E1Gw8MQsgaUk3Suz3PmKnsNn4YzMZedtaZV6sJ8UgbZSe+f3DmJEyp+TsXUaMsxWBQk7RkPjzTL0sY00rDmaHat27C6tq29PruUpCH1JWUWwUkqrTKZxkTJqfxsVkwrC4eYRjwWE8FLIQDaI6di3ATkbrKNlKZZb5vmWs6pWBjAojAzDb2Is1BkwdfNcyqN/dJMcyGipFutkgpMWAETpt7Uh7UZV4Cq4lxd1P6Z/Hw6W6Yfzp3zH+zT35tkfvXmbXL36eQd+XD56yfO37RF31zWf7D78P8tSf3XY3Fnnr7+HFoX/A0/v7PfxqdnUzb//b037X1hn7+0joOZ4/nB8m2/Pf8cRDV66TTbX6KZZb77cOqPZmz8ZTR3fj1rrT6Op7x9/CG46Lt5dGdGmcU8jZ5vOcAjAD7y4Mk0Vz1QZ12wKay8ibRufo4liYGjARx/rlmNWtM0zZ8A27h+6tFx6pxwWDTD5CeAIdTnxJPssJTKkTxmMwZB1IO4iIQxCKGGQkGXRHdGMTgNLou7yoyQJyGbTjMyGi74ykgjhAIkMFAL5lJDsECFacfKCRcrVAH6fKgMNMx0zb9MpPP3aMGmgqIsUzZL1XHfgWFVyPAHhuYCyZIolwEUGHJK2RPqUbYoFIdKXwDuXRkRV6WKEc+0q/PUwUND4VWV2rBA3q2MJpSxTrvpNppG5y6Z23vsFiwWKfGNOcAjlecbcYEj+FQYheJosCdWxy0XMBD1WcCEAdkGOsCcAayeDAIG8KhynwUxYj44DqIpp3qQJkYoFspIQQd3HiRU0/qrjOM36XY5ZwOyo7tn2EWaXw6y+1a/Xms3a0271ej0m736cQ1yz+6dWM12v23WTk6Orf6g1TL3fyDH1zfy/AX8DRub4MG95D4QGmcgNgNDiFI0kiTcZQjuANuIuQRFsrsMas6G4/Hw/evJaPCfq+FocDI5HQ7enejbrcK35u9pTswo4qhNK8Kq7XS7yAvZIUUO2R6BvL4On9BqO7vdHEW+YLYXzPaC2V4w2wtme8FsL5jtBbP9OZhtF7Lp/d6JBFSD8aVaiQpnst/GMreFc9rsOA1aliRG/f+Eo7VvQs6HweC6eKa8kXBzDllGilfyrFFzN68nAirm3FN38y5ezss7+q5ezUiS6v32Hn+Nh7yyEqqzVFgi8BA3XxgiVtkc5TIOWTiD0hdAmaou7D3MusHLvYuhPFvN6+YYYaqyVuHlxtbgEXtL0eKbBw85ze5Thx2MfDHEA308vJeIA8DyAsouXr7JNrn8SsgsBcKbc1jjR9vHBIWD9+15+6MPogvX8PJuvXBA/3+6W/3+5/PSjd/jxH3DbHu79bgrq/KN1eOuofZvoWTesHDK5SULqKEiyKxYzUqnUEauQnyv42mDTaDL2DnKX77g8CwK8mjPzQdNHneTXdOWE2r3wrkc0H+FH22IGNpLFWQMf6U+kNL8giqXD0P/x62Qr2Af4Kb4Sa5oFe0jTzUXQi9NYOicJXIA8FhCOkpmQeoLBrGPvbFnRARrZ37hlci9LQvllAVT5NuCyg1Idv0Lo8v8mi3biE5hm7ylv/0xVxsNUynqXo1g7QXqoKoYGIpBUqgwr+Qkf7kepSG+mLqATAlIuOUZp2EFUFAQYmFyUiFA72Qxe7WlWC6XlUgNk3PmAlQxGJMIlqpNkxGlDuwEqniHuAC95OTSHX2SyPqhXY3eYeNvv/12Ez6qPma0+dsVkKIQPXtVuxQJm9Io6J1AWzHJRsbSfVbPr/OYxPcD3cLLrFu87k4EUtzfOyD+Veyv19gMhS+WT+aOEJQyddGL+3qW4Gcv32fvCrO5xNJ/HGXXma80zJpDQuZFPcTynd1n6vBR1vziCzK5Imel/dlSfM8XeAfVUWLvviTc6IWP454t+O67u68KsPsIsCSCIjrOthCXyGdLsXfxuB2htiJfpb0tIIqL3uXxv4HayV7iBWrdiskS3wDC765+A//wgYXawMilFdvvYQUNZylkB9AoxliSSYqhXEQCatnPPmBYHIynIkRQmuBv1Osg+d8xgQFj/GNDrnoeHLBBHIqaSfy4Xv8Pr/KEDg== +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.16.9","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/enrichment/enrich-person.api.mdx b/docs/docs/api/v2/enrichment/enrich-person.api.mdx index 0146abc11a..4b8dc10677 100644 --- a/docs/docs/api/v2/enrichment/enrich-person.api.mdx +++ b/docs/docs/api/v2/enrichment/enrich-person.api.mdx @@ -5,7 +5,7 @@ description: "Enrich person" sidebar_label: "Enrich person" hide_title: true hide_table_of_contents: true -api: eJytVm1v2zYQ/isc9yUBbMkJhgI1hqEdWgzB9iHIy4YhCRJaulhsJZLlix3B8H/fHWnJsp1maTcHiK3T8e65u+ceacW1ASu81Oqs5FMOysqiOgfrtOIj7sXc8ekNTwbH70bcQRGs9C2aV/xpLIwcfwa6ulvjXQvOoCPgqRU/nUzoqwRXWGkoB2ZIoT7GPA0o/0F4gZkKrTxekb8wppZFxJR/Ihxoc0UFjaBfvjWAYfTsExQeDxpLFXiZUha6MUK1/+6oRAMDL+etVHP0UqGuxaxGm7cBRhyeRGPokr9xgIXx9YhLVQY80H7b+Uv96JfCAhOqZFdQVErXet5SQKFUEPW9hQWoMISlQjMD+1LYk8lPk/jBMKVuhFTfU1WGfSMggFbdAtwXOqRhvB7IydvT9ZoY8CVICyXRJjZ50K+DSnvMB6mRS176CDFxEsr7brj7aTr73Zo+oz3CJaox03HaCIuwPF5GCiciIJMLxKgbsGNZRsxorECUseoD+vWd3XayabchTvgBjKsKWHefnX1gvhKeBSW/BKhbJkskv3xEcuKNgaNUrNXBssFO8GHxNIT1aFAFsnyBwey47/231uFEDe5R2wKeL6LLwDYZvgoGM8m6g4BlRgLser8OkcDSwTXSV+/mFDOxleQG51hp0q05xBUXvsKL3GzkitTKLrpJB1tTL7w3bprnKFyZC0bM6wCZ1Dn0ipQvTvl+4ZcbT/b+/IyvBzJ4SfiTpAzEsK8GLb8D1d0PqPPZH81uPkzD0It5zURd6yUrcWNqEjAXbQU2JFElAoqi9KgpMZWbYkyykzfZW75dpGtFDCvZVnzj6SS+ovBbXezrjYtJY5ziphbuXd8xGsFor6U7Nw+48yN+2JnyVpehINst/v0FNToD1UTFdAip/KMtzGOGyQP9ihuQsb91YIVQLDg8WkkXD2CMJY5kE0zacoyr7tuesC6jjDd/SlgyTNpoxRL7GLJ90JS7o64gKjkbVpWbWnj0bvIUYJwCuAF7jmOSH24ugqLtPdfON0JtY9qgMoM2RaSbBe+xHreYH289lstlZtKxmLMDkC+1/eyMKKA3jU2Y4XLkGqe+wLpi8tjoX4WL3GDXF3/cqoeHh1v1KuZvfGl8GwwDVuxL6c6Ae857ePLUKBmjRIqsNqt5w832TaLC+GRarWYI9trW6zWZk1LQwpbS0aMG9/tR1A4O8vXvDPzoYiMrx4z4/hyOuJe9Ji0EkXvK4y4vhJXpmYYvMaNuJb8bwf+p9C+Usv/E2pY0+g/A99X9RQD7D5sdCMnpPSqV8YN7B293Ozr+28creksIRJahiCbF3PygyXS3VDuIPVTXlJ7+E5hn3X+m/UB5/qV3T3e+eqAX6+RNzaB3jn8AcMrmug== +api: {"operationId":"enrichPerson","tags":["Persons"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"PersonEnrichmentData","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"6sense"},"industry":{"type":"string","nullable":true,"example":"Software and Technology"},"annual_revenue":{"type":"number","nullable":true,"example":104000000},"domain":{"type":"string","nullable":true,"example":"6sense.com"},"employee_count":{"type":"number","nullable":true,"example":1192}},"required":["name","industry","annual_revenue","domain","employee_count"],"title":"enriched_company"}},"required":["company"]}}}}},"description":"Enrich person","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"email","in":"query","required":true,"schema":{"type":"string","example":"alicesmith@gmail.com"}}],"method":"get","path":"/persons","servers":[{"url":"https://api.supaglue.io/enrichment/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (Enrichment) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Enrichment](https://docs.supaglue.com/platform/common-schemas/enrichment)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/enrichment/v2\n```\n"},"postman":{"name":"Enrich person","description":{"type":"text/plain"},"url":{"path":["persons"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"email","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/enrichment/unified-enrichment-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx b/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx index 59d93cc69b..6b6f31649c 100644 --- a/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx +++ b/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/marketing-automation/get-form-fields.api.mdx b/docs/docs/api/v2/marketing-automation/get-form-fields.api.mdx index d277e1f097..10d0e87682 100644 --- a/docs/docs/api/v2/marketing-automation/get-form-fields.api.mdx +++ b/docs/docs/api/v2/marketing-automation/get-form-fields.api.mdx @@ -5,7 +5,7 @@ description: "Get form fields" sidebar_label: "Get form fields" hide_title: true hide_table_of_contents: true -api: eJytV21v2zYQ/iuc9iUBbDlJuy/GMCxDXxasxYK0WTEkgUNLZ5sNRap8sWMY/u+7oyhZspWuWZcCiS0e7567e+45dZPoEgx3QquLPBknc3BvtCneCJC5TQaJ43ObjG8SemiTu0FiIfNGuDU+3CSPQ16K4QPQt7stnhqwpVYW8M4mOTs5oT852MyIkkJggHfCOqZnbBYiMK2YWwCboXu2Em4Rvs3FEhS7eIXxM60cKEd+eFlKkQWoo8+WnG0Smy2g4PTJrUtA93r6GTKHF0tDiTlRQamitey4MXyNZsJBYf/9vshbNtYZoebJdpAoXkDvgYEvXhho35pqLYErOqVsJ0+4zLnjEzLg7ulzHarZl0+32B9AYjZ8KoHFK1RprLGwVQNS9qeSaxZLS3ZiFlrQgsHQ+N4GT/fR3vqy1MZBHtz97qfYdce4ytl7bh7A6fTbSyv5FGRvqksufX95hZ3kMONeup4C7xfhAjMyHgbILynZFFiVC4Kfrll0k7JX1QfLnGYzLi2kybbTyJuItMaFbHfCSYoc+tlqTLiJViIPbJ0UYC2f96SCDPJSUt2TMWGkgHwVXPUVjue5IIdcXrZKGC7uQUVyRXa2nu+I16XZfiaBGZjDns84Q3fbbTjqFvktuGqIZ7VylNxgfAfGBqmoRgUVI/PW6QLMMOAQdHkBPAeD3w7GuakTPPKiDBCL9c7FaXIA5COStz5HCUEyI4O9El88IHFFjmIiEKMNLG8MhWJr7Q1raUy7crE5rSyQw0t0ZoaxyM/Pw3IJFkuWQX8SdQS238Z9MEJl0ucwaZgT0WDGZt0HZjcoDZpIvi6KTwvAIhmaiBiDYYwgDWwGDt3i/BtdhFK+MDnDlrt1AxwHaAdyx7yAreRucZDTt9Xt9OzFy5+QnchapNdCx60VGIdOx8mIYtnRJobcjiYNJy2YZU1IbyS1zLnSjkcj3GMpqhqf42inQo+KoGMYe8g9UqTaOsuzQ4WNd9j55UWybe3HD5RKpXCtLbnT61L8Aet6SMctm30udeNhGIZW1BMupcZuwBIkiUFQLp5lqDWhIQEQaaWaaQpMiVc+TtLTl+lJspv6a0UjkbPXyohsUeCIhNvV9uVZENmIs86XWlJwQSXMdWZ/bWqX6QLPusXtHB7Q7Ef8YRfKGZ37jJ7d4r9PINEYKCdKpkZ4nlVbjMpw9L7uETtvenTMEI6nFMLXlP2tPcu4Yt5CtffoKnpdYZOie2HyYZe6NiUMN38JWDGEUeBbSkXNsO/64t4d1clSOdJ2xqNSckdkHFWuhpUr28ux4xD4h5srr0iULrV1BW95N16lJT5TRNKpdw5ztMv58c5itVqlZXUtRK+hjFbaPNiSZ9A8GpZ+inI30siNJeYagod2/MZtYBC7vnp3q+7v72/VMycl3qJ2RzQtFh1uiw4lmilx8OiofCL4CaTaxDG/CZJCV8c7baknHedwgUHJarOZYi7XRm639LgSRZr/XFhavCgfYd0fQGjePL9fBwf9+QRF6JPv+OKTBEFZciOqN4RngT66itp6zJ6KX0uRWrdj1rjqqm7v0DSq0X+G8H9u5a/Ucv/tYlfIwXcA39/EXwWw/2LQgVAZnaNIl651dvA/m85ye/v6I737eWJ9e39UyyJ+oM709rO9WKrw9JvA9Jr/TEOPm+mXxrw6efJCs6dqNhNhttt/AL03+gk= +api: {"operationId":"getFormFields","tags":["Forms"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"List of fields on the form with the given ID","content":{"application/json":{"schema":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"required":{"type":"boolean"},"form_id":{"type":"string"},"data_format":{"type":"string"},"data_options":{"type":"array","description":"Selectable options for this field. Only applicable if the data_format is `select`. Only supported for Hubspot and Marketo.","items":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"},"is_default":{"type":"boolean","description":"If true, will be selected by default. Defaults to false."}},"required":["label","value"],"title":"form_data_option"}},"validation_message":{"type":"string","nullable":true},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","name","required","form_id","data_format"],"title":"form_field"}}},"required":["fields"]}}}}},"description":"Get form fields","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"form_id","in":"path","required":true,"schema":{"type":"string","example":"12345"}}],"method":"get","path":"/forms/{form_id}/_fields","servers":[{"url":"https://api.supaglue.io/marketing-automation/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.0","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Marketing Automation) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Marketing Automation](https://docs.supaglue.com/platform/common-schemas/marketing-automation)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/marketing-automation/v2\n```\n"},"postman":{"name":"Get form fields","description":{"type":"text/plain"},"url":{"path":["forms",":form_id","_fields"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"form_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/marketing-automation/unified-enrichment-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/marketing-automation/list-forms.api.mdx b/docs/docs/api/v2/marketing-automation/list-forms.api.mdx index cbfc508865..f016243ff0 100644 --- a/docs/docs/api/v2/marketing-automation/list-forms.api.mdx +++ b/docs/docs/api/v2/marketing-automation/list-forms.api.mdx @@ -5,7 +5,7 @@ description: "List forms" sidebar_label: "List forms" hide_title: true hide_table_of_contents: true -api: eJytVm1v2zYQ/isc+yUBLNn1BgwwhmIZ1g3BOiBIkxVbEiS0dI7YSKTKFzuC4f++O+rFkq0UCNokcCzyePfcc88dteW6BCOc1Oo85QueS+v+0KawfMKdeLR8ccPr57sJt5B4I12Fi1v+HIlSRk9AT3c73DVgS60s4Jktn89m9C8FmxhZknt0/gGdM71iK3LIhEqZy0AaVoATqXACYyZaOVCOzoqyzGUSoE0/W3Kw5TbJoBD0zVUloEu9/AyJw4OloUScrMOHCD0zYYyo0Eo6GKy/cFymPRvrjFSPfDfhShQwupEYEA7Se+GOtyccnkVR5rQ0n83n0WwezX++ms0W4e8/NCC0dJQjCRA5iVHQqS/T7+/UiM19oHqEA5GmktgW+UWPDWc87OgkfPHSQEqKQH4aNga5DzCjIpx0ASFBue+KvDv0VhfrbrcLOyOSWTWCLIXBmA6MDQqsy4FCTLx1ugATBVySzmUgUjD4dKSYEQaLau/iLT/CcJUBa/fZ+e8oWuGYV/KLh7xiMkW9yhVyRWreG0rFKu0N68mY9/MOvE56WaAE1+jMRA2xr8/DihwskpXAeBJtBNZEeBGMVEnuU7jv1NKgwYxNNQZmqXUOQvXR1C4PUHzKAEkyzGnWxGAYg1EMtgKHblO2MroIVP5oUoYld1UHPOY0aFACmaZh9QihdYXL8GHaqsSCWbcS8SYnEp0r7WI6xYEVW1+Kx9xDLPW0EOYJHLIYCY9Fq0fNes4PUX9szrCzi/OAoB2EH4mHemT0xuF+6pTyL6jaVln0bA6rO4yHYRhaEUsizzXyA2vIqSVtWEsSsLXaAqAdeVtpCkyJ1z5m8duf4hnfN+G1IpGm7L0yMskKFG04XY9ckYQh0+Bs86VyFkIShalO7K8dd4kuqNkH5A42jwr/Bn/YuXJGpz6htVv8/QQ5GgPlRMm0CM+CgSV47OTvtkbsrKvRKUM4nlIIjzH7V3uWCMW8RWeZrI+i1w0WqXEvTRoNxWRjwnDzj4QNQxiFVqzWNc0bNhb37qRNluiI+xlPy1w4UuC0dhXVruyoxk5D4B9uLr2iMXGhrStEz7vxKi5xTZFIl945zNGuH0/3FpvNJi7rYyF6C2W60ebJliKBbikq/RIH0FSjNtaYawgeyvGbsEFB7Pryw616eHi4Va/slOYUlbtB01PRYHQP1NA1iINnR8zJ4CLoadv0c3ctTHiGrmlhu10i4muT73a0XA8j6vJUWrHMaY6tRG7hKFr3UvHt82cyDj30/djYXAvqowUPY2MtjCSg4Y1p0nb/6zI4uWyG9in7nvfSV7I6vF/3KU2+AfjhXfRVAIdX4wBCbXSGQ7F0vb2j18fB1fHn+yt64/Ektf68rodz84Uq026pque7P8jr8PRJYEbNf6Emw5vgXWde77x4oLsXWl0heHw5+h90fwdQ +api: {"operationId":"listForms","tags":["Forms"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"List of forms and their metadata","content":{"application/json":{"schema":{"type":"object","properties":{"forms":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string","example":"2022-02-27T00:00:00Z","format":"date-time"},"updated_at":{"type":"string","example":"2022-02-27T00:00:00Z","format":"date-time"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","name","created_at","updated_at"],"title":"form_metadata"}}},"required":["forms"]}}}}},"description":"List forms","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."}],"method":"get","path":"/forms","servers":[{"url":"https://api.supaglue.io/marketing-automation/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.0","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Marketing Automation) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Marketing Automation](https://docs.supaglue.com/platform/common-schemas/marketing-automation)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/marketing-automation/v2\n```\n"},"postman":{"name":"List forms","description":{"type":"text/plain"},"url":{"path":["forms"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/marketing-automation/unified-enrichment-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/marketing-automation/submit-form.api.mdx b/docs/docs/api/v2/marketing-automation/submit-form.api.mdx index 39dba52a0b..0c887991b8 100644 --- a/docs/docs/api/v2/marketing-automation/submit-form.api.mdx +++ b/docs/docs/api/v2/marketing-automation/submit-form.api.mdx @@ -5,7 +5,7 @@ description: "Submit form" sidebar_label: "Submit form" hide_title: true hide_table_of_contents: true -api: eJy1V9tu4zYQ/RWWfUkA20rS7YtRLJptd4ugtyCXbYvESGiJtriRSJYXO4bhf+8MKcmSrN226dYGHGk0nDlzO6NsqdLcMCeUvMjolFo/L4V7p0xJR9SxpaXTO4q3ls5G1PLUG+E2INzS5zHTYvzE8W62g6eG/+m5dW9UBqJtuBWGg1VnPB/RVEnHpcNHTOtCpMFr8sEqiTKb5rxkeOU2mgMUNf/AUwcwtEGMTnCLTxcA5p3gRWaHdDNuUyM0WgYxIyW4EnJJ1IIs8BCRrOTEKbJihecEjBHO0rx6KCRxeZBi+PyZlbrg6AaQiQIMlvxb6zVbwtlJqlBpIYx1v4BRePoDV2bJQViwRvY7eKe7fhCVvQa/dQb1+vgRTFAlLMsMtxbjQGHBWdZGeABstxu1CnBXOYQigSGB1llx2UKEFeofaSV61klGtwL/NTXhg56tVtLG9JydnOCfbjIuJDoOTUPYXHnXZIKkhjPHMwLV9DoLl/NNU0oSmtpaNPPZ2lBkf1++GwAgsnbN4II5sma2hpzUeEHECCTBFw4PxDl02LpDHXl69tWrryFr1jHn7RCSfWtUHg5aojoLtXXCBc3o9AGdPdT1oFV9upFdB80almYGKuq4sYEYZCzv8zj11qmSm7HAZhV4MIckcAN3B3keQF5u9iZO6QEITG/9nFx8H3PrpQAWKjaQeKiygLm2IYONIsz4RnlDWsWnox5Z7UatKKDuKzBmxkHykjgsK7iFXKV8OIjaA6k8fBRMqMw+mZq5/ED9n0EKDQS1hepD5XKF3K+VDX2OVqc0QWc22VY+d8lDbA+MmZtVXWxvcPhz57SdJglshEnDAkIlJTNPHLt4zDykP47a6uxgUq6rM+T88oLuWpvmGmOJE9faN01kIPkRBKN9tWqdfp26/sANAS1cBKwo1JpkfMULnG8bZGmKZIt9EwBB1ZAfrvYL7u3/RocIfKHQFOY4wj2ZnL6anND9pN5K7OyMvJVGpHkJnR6ARnZjaWC3KiV1arH8FbZMpbaPrlvH7i7pZ+9L+JAL6YzKfIqye/j+xgtQDrsV81YjPA8KFuGRo5/rdiDnTTscE4DjMYRwOyF/KE9SJom3YCwX8ShYXUM/VOaFycZAOm7TjI6dIIa794KvCcAoYUfEMQgrfsjv7KgOFtMxaUec6II5LGsSTY2jKTvYzsfB8Rd3V14it1zCEJWsZd14OdEgkzgPc+8cxGhXy+O9xnq9nuh4LHivoSRrZZ6sZilvRGPt58BaiYLeWEGswXkoxxtmQ7OS26uf7uXj4+O9/JdDWZ0KLysRTaeL2oTfaYdmGB1/dpg6EWyEhtpWbBLfJiwcne45rCYUGPccqQe0tts5xHFrit0OxTBuJrxejuiKGcHm2PxAOpmweA2ktWCF5QeAmh1Pj64qcjwmOD5DQGsqkUga4bUQ7uAyME1DubsZqFZs8mIIn3NjDcYSMfc3bxMUrpIXA+9vqU8C6C/NDoSo9F10NL5BO3uNg5ey/YlzoGXtPqnb3meXv17fgPK8+n+kVBmeMWyNOxN+p/QevnCjQvCBvoN8C7Qsl54tUT/aRV6Gacm7uycumuoCu2Kwl9pLKQaCvxjWoPo3OMWw1V436vHJRw80Oy5qYyFmAPgvwofOVw== +api: {"operationId":"submitForm","tags":["Forms"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"formFields":{"type":"object","description":"a mapping of field name to value for each field in the form","example":{"email":"me@supaglue.com","firstName":"George","lastName":"Xing"},"properties":{"email":{"type":"string","description":"the email address of the lead","example":"me@supaglue.com"}},"required":["email"],"additionalProperties":true}},"required":["formFields"],"example":{"formFields":{"email":"me@supaglue.com","firstName":"George","lastName":"Xing"}}}}}},"responses":{"200":{"description":"Information about the lead created or updated by the form submission","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the lead that was created/updated as a result of submitting the form","example":12345},"status":{"type":"string","example":"updated"}},"required":["status"],"title":"submit_form_response"}}}}},"description":"Submit form","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"form_id","in":"path","required":true,"schema":{"type":"string","example":"12345"}}],"method":"post","path":"/forms/{form_id}/_submit","servers":[{"url":"https://api.supaglue.io/marketing-automation/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"formFields":{"email":"me@supaglue.com","firstName":"George","lastName":"Xing"}},"info":{"version":"0.14.0","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Marketing Automation) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Marketing Automation](https://docs.supaglue.com/platform/common-schemas/marketing-automation)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/marketing-automation/v2\n```\n"},"postman":{"name":"Submit form","description":{"type":"text/plain"},"url":{"path":["forms",":form_id","_submit"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"form_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/marketing-automation/unified-enrichment-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/marketing-automation/unified-enrichment-api.info.mdx b/docs/docs/api/v2/marketing-automation/unified-enrichment-api.info.mdx index 6da935f18f..4abe789c5b 100644 --- a/docs/docs/api/v2/marketing-automation/unified-enrichment-api.info.mdx +++ b/docs/docs/api/v2/marketing-automation/unified-enrichment-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.14.0 diff --git a/docs/docs/api/v2/metadata/create-association-type.api.mdx b/docs/docs/api/v2/metadata/create-association-type.api.mdx index db66dc3eb4..083de6d1a0 100644 --- a/docs/docs/api/v2/metadata/create-association-type.api.mdx +++ b/docs/docs/api/v2/metadata/create-association-type.api.mdx @@ -5,7 +5,7 @@ description: "Create associationType" sidebar_label: "Create associationType" hide_title: true hide_table_of_contents: true -api: eJztWXtz2rgW/ype7+zMdiYGAwkhdHvvhUA6tM3jAt22EzJU2ALU2pYjyTya4bvfcyQbzCNNb2f7X0gmxNI5R+etn6UHm8dUEMV41PHtuu0JShRtSMk9pkf7y5jaR7ZPY0E9mAIiJRJ6ZCsykXb91t6hlfbdkR0TQUKqqECKBzuCB5C9cLxEKh5S4TAfZLIIBqeU+FTAk/SmNCR2/cFWuGTdlkqwaAIzdEHCOMChcLkRUbJXqJb0BItxcZjuT6mVzVudlqWmRFlJxO4TGiwt5tNIsTGjEiZyhCyyljwRFonjgHnaEFhU0PuEiczc1VHOiljwGQgTjh75GTskCagcc+HRw0ZkK1jpCjvKgIcl9RLB1FL7d+GQmDlfKT7d4SzSU6ma3F+iItvsR7bHIwW+wKmc0cUvEhV42LeAj75QT4EeoBdkiwIXajrwmkeH6FW1HEJI92xeYZqICVVPEMlkMgF9qT8EI4bG0QfIfCbjgHyHwCPCZxEJtGMOBCBKQkzZ66v2sH89vGxcfcJsBc10VMgmk4fIOsyLW63yYbjdN/6AqQcN2zFjW+mcNqYSh0ns49eubqCP0UjGPJImHmW3hF/b6bRTnpYRi7r9Q1lAheBC5uiIEGSJZaFoKJ/m96kiLDgUrv26GCdBYOkFrZBKSSYwJHio61nQkCtq3aSlU7CQwRhhkci3AjqjgcXHllnQmjOQNSNiaY2WG66tMn0YgJN8OrDrx657NLBHUE/wAMNSEZVI+H9g7B/YMJ2qpEdvjI1LWCGAUrTmVFAr4gqfmV+3bh8G+LGZ/BsHzEN9TAJJj8xDJs3MmK+11EH+Yw+HZMQTNQSNtsYtn8PSuCpdMKnMYCreqL0lvHt90+72Pw1b1+3eVX/Y/tjp9bd4MGG3WHYWzugC7oFR36jfxkUuf5EhqzvtdY8LQYN0B9O+J97Zcfmk7Dln7ujEOT7xyw7xS75zRs7Gp9WTkn/qlw0rVMKEi6Xm+rvxrtNq9DvXV8N2t3vdhQWAxLR1aaJOPA9scbBwBA8cEgR87kBB6Y0FQqfl6Bga8WPHI5CATi5bWp+uGped82weKkUP19yTil86HZ35hJ5Vq8dO701Kw6MIqgaM03RewDPhpnqdgEYTNdWTlWppawrryThkp7xfelMiJFWvEjV2apoHm4ymveTRkVUqWT0aW2W3XLHKlfpJqV4uW68v+5o0ooGmTDNYJtorw7EgRk8TZ7fgltJ0EDTmQg0V30oBsB4l5fMmJIvhJlOq7nHNdVd6TSPCARG5lWnkx5xFKk2+elZTiQi2VpoqFct6sUgKsGABXJj444AIWvB4WDSSi7PKv+Wri8k8+Xg9uv6jfPGtSqbv37yViy+td+Rj/8MXzt/UVNOdH/9RbsLvW5IEr3tq4V68/hqVbvgbfr0ovxUXl2M2/Xbljxv37Ov96Xk4GflBOH/brE2/hnGF9kfV2n08KbnvPl4E3Qnr3Xenow+Xp8tPvTGvnX8Mb5pelt2pUyaCJ/HPe05SMaMiS57UcjMDfdYDnwoSSe3dDFNoYpDogMRXldJJpeq67kvASV6Q+LSXjFo8JCySLwGn0IATX4vDVqo5uWATBknUgLyIldOOoIdCQ9dECyefnA7Xzd1URsRlxMbjlIxGM750khiUpCR00ArmUUex0KTpWSkjnC3RBJgLoDPQKLU1exjq4O/Rgk8VRV3GbJIY+HuArQgV/ghrppBuiXobQIWhpow/oR+lm0KeVcfCd0ZLJ+amVTHiu+XiNBkhgFN+0ZgNG+Ri6VShjZ3Vqt5J1TlbyGl5T9yMCZWQwJlyaIm6ztfqgkSIqXJyzREw9//XHTdSwEE0YCFTDlQb2ABrhrB7MkgYHvkmfCXIEfdRPsimjOpRGtjAIat0pmCAzx4lNMsGy1Tik3S7klOGFCT/hF+0+zVTuVlqHldq1Uq1fHpy1qw2js8rUHvlRqtUrTVrbqXVOi8126en7v4Hanw1iBC2QrxHAQ0NsPshINRLYjIBYJGCIUQpVgYRqQ/YRk01KNLT26DmstPrda5eD7vt/77vdNut4UWn/a6lobpBnk+t37BGglHEUetRhFWb5XaRF4pDigyy/QDy+j58Qq+tcuS3GxT5jNmeMdszZnvGbM+Y7RmzPWO2Z8z2azDbLmSzm42WBlTtXt/sRPbmIO9pLHO3AV/ZcRqM7B35PXmUdvB0defcEmhwuTkR6NxfcG73JJ59HGnqI83MEWsNV+azC0PP9UGmRfauKkKqphzvMmKoMVSbqCk8FXOUupNJPJ/VndbcUsAWhOf42cYTs4JMUXaB8SJIJbDhkuKsvIeI12i8cdOx86fzPQTBxl25M/qNx2P2lqLL11cLGc3upcIOAr/pWEBlKW5pPANQfAZNHYIj9Zje3DUg1wqB6xBBdDeXAu0MOR86xN/g/v2z+83coSP73BvD1kn9ZnzrgH7rHH6FJo85qoQRMYa6hVKlUMrV0mUaBW2YOcIGBINM6UpZKPBtIjRvBD735H/WoQT8AHPbsd6a3Eu03+FjdRA++olBS/DzgQZATNHd6Oe8XgB8vSQEp+lUs8bwfnbevSxYn3hieSSyEglsUyY1LfCbCzh4Q4qsLMkghIJDCMMkUAwChfTCd2KCbSS7HJIFVOT2t9tuEuEl1g2ke0iiuz8zs0QSFWAzDiPM31GiFI8KcjZ5saGYz+eF2LBpYJU5ojjn4quMoWOuh5w4GQEgLfIZ7qJ0/gIX165pEqkTzXrffTeIPn/+PIh+oIhSSt0ujAa5KD5a21uRWdeRogtVhHxjWpyO7UNa9rf2ftlDgeL2i5MPDyPQ/r0IVischgIR+hLtCKERIyP9don9Mq1E/arJJE742avfrlLrexX7z27aeF9Y/+TV5EGrdWfZu2LVWw6M23iB+dOK715HfleB3dvRLRUM0XmKJ9OgZhR7t1AbDoNLv0t7l+v8N9e9PhCP0vvPkPvII8gc71Lhb90ewA88pGBWX5Li+IMdkGiSAIgGGiMX2ydJMJfyfds06fQfzIpsKlrmtMw3dGMI/kWzDpL/hVUEO8K/1uRm5lGG9f5gqJnGEqvV/wBSpuLk +api: {"operationId":"createAssociationType","deprecated":true,"tags":["AssociationTypes"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source_entity_id":{"type":"string"},"target_entity_id":{"type":"string"},"suggested_key_name":{"type":"string"},"display_name":{"type":"string"},"cardinality":{"type":"string","enum":["ONE_TO_MANY"],"title":"association_type_cardinality"}},"required":["source_entity_id","target_entity_id","suggested_key_name","display_name","cardinality"],"title":"create_update_association_type"}}}},"responses":{"201":{"description":"AssociationType created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"association_type":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create associationType","method":"post","path":"/association-types","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"source_entity_id":"string","target_entity_id":"string","suggested_key_name":"string","display_name":"string","cardinality":"ONE_TO_MANY"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create associationType","description":{"type":"text/plain"},"url":{"path":["association-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/create-custom-object.api.mdx b/docs/docs/api/v2/metadata/create-custom-object.api.mdx index a6b2948946..06b01be253 100644 --- a/docs/docs/api/v2/metadata/create-custom-object.api.mdx +++ b/docs/docs/api/v2/metadata/create-custom-object.api.mdx @@ -5,7 +5,7 @@ description: "Create customObject" sidebar_label: "Create customObject" hide_title: true hide_table_of_contents: true -api: eJztWnlz27oR/yooO2/yMiPqtOUjTVvbkvOUxEcl5yUZ26NAJCQhJgkaAHXEo+/eXYCUSMlX05f/LGfsEFgsFnv+oOWdI2ImqeYi6vjOvuNJRjU7SpQW4dngO/O0U3I0HSln/9LJDyvnuuTEVNKQaSZx+s6J4AF4zFzPEDLpch+W8wgGx4z6TMKT8sYspM7+naPnMZIrLXk0ghk2o2Ec4FA4X7GoOYuS4zPlSR6jmDB9MWYkmyedFtFjqkkS8duEBXPCfRZpPuRMwUSOkEdkLhJJaBwH3DNHhk0lu024ZHB2LRO2KOVOEUsxAWbSNSM/cw5FA6aGQnrs/kNkO5B0hzVhQMOKeYnkem70O3NpzN0bhk/XOIv0TOlD4c9RkOLykuOJSIMucCp36Mp3hQLcbZ5AZAYHucArNKgQZ9PhJ+lUMhqBNMzvWxU+phnNvRuGLDaVgovRUq98EvAbRrQgiWIE1JizJ7EylMkxDPeWai6RKSNTHgRoZRb55Fu/730jfEgi5jGlqJzbJX8kg14sdIlwbeljqtBfpEhGY0KVy1V5w2abB4qSIKADPJHV+OqAF+aAqZjICehYoJ6hReCcBFQ+rj/LHvnGQSJp8Bxq5SwWeR+7XO21ZHONHCUPQVF9CKHA74O7PWjPTeMBtTWgGBprXWXcrhxi+Fn1p6KVMCiXptBjrgi3UWtobWAb8wwY8bmKAzpnvnEFSiTzhPSRAy741CGDOfHZkCbBPW5heGecJBsyySIPWFGVinkKQi9lvMdV+5DKQDdmPm9FKiWdY3LQLHyGddNDPCNCUgfqtHDbx4xwn6TrpulEm9oIIZAIxsiU67ENFOPyXPVXPrLcbiBEwGiU329IA8UynfQt3T3iRUlofG0VM+EAMuj1EzJOxyxauoQCTUAeeGWZvCoZo4V0RgIWjUD6zLIpXX17u+AN97GGwM8xtkKljGNwLa5AKkJBPcqDpes71HbNXLUEzqRisDSfQO0pb0RYwd45OxbVXNAhKEZzbQxqc13f+pKNR9hhPYiLabeo1mXeeTCslz6d39eggH4S+/inIMXGCdPh60UqmIpFpKyz16s14/MFM+dBBLEboQL+olrFpBTy/4lPpim/N5tu5rohJH9iNiQh1pYRDEkoTehCkoVCM3KeFvgywQX2EMZxAgb+gknSbmjdawLmQb9dripE990VKMmHJLW/Va2WriAifciq+zCsNNWJgv9f2fNfOTCdimRGz+0Z57BDAIABiqSEOis0PnN/n1zeXeEHfPJPHLAPNr5L9iHjZmfsnyXXq/zH6ffpQCS6DxIVxokvYGvclc240nYwZW/FLjDvnp23uxdf+62zdu/0ot/+0uldFNag9xaWrG2c0QUCApj/YH4bNzn5RQdZXButQ0mSLEjxtNE99fa26tt1z92rDrbdrW2/7lK/5rt7dG+409yu+Tt+3S6FSBgJrJSw6s+Dj53WwUXn7LTf7nbPurABkFjwqazVqYeIxsXAkSJwaRCIqQsBZeAvmM7wMTa07IeuR8EB3Zy3tL6eHpx0jrJ5iBQzvFvdbvi1ncGeT9les7nl9t6nNCKKMNeJyNB5gciY2+h1bTo2k41mrTCF8WQVshbeb7wxlZBW3yZ66O6aNZh2DO2JiEqkViM9FpN6td4g9cb+dm2/XifvTi4MacQCQ5l6sEqMVvpDSa2c1s7VcrWWuoNksZC6r0XBBeD0yCnvN1Be+itPaVa3dqvVhdnTsnCBRW5nqKSx4JFOnW8/i6lEBoWdxlrHar9SoWXYsAwqTPwhQDBW9kRYsZwrk8a/1Nvj0TT5cjY4+61+/KNJx5/ef1Cz762P9MvF5+9CvN/Vh9Xp1m/1Q/j3Acrcu56eVY/f3US1c/FenM3qH+TxyZCPf5z6w4NbfnO7cxSOBn4QTj8c7o5vwrjBLgbN3dt4VKt+/HIcdEe8d9sdDz6f7My/9oZi9+hLeH7oZd6dKmUEADn+ec0pJidMZs6TntzOQJ71QKeSRspoN7v5GGLg6ALHt43adqNZrVbfAOzzgsRnvWTQEiHlkXqDZTsQ1DfsJjQNJCH5iIMTHYBfxNptR5BDIaEbopmbd05XmORuIyMSKuLDYUrGoomYu0kMQjIaungK7jFX89C66V4tI5zM8QgwF0BmYFF61uyhb4y/QQs61QxlGfJRYi/j9yyrQIQ/sDQTyKREUwZQYIgpq0/IR2lRyC81tvDdwdyNhU1VnPrVemWcDPCaqf2KPTYUyNncbUIa29ttettNd2+mxvUNdhMudUIDdywgJZo4X4oLHMGm2s0lR5f/j9lxxQUUxAIecu1CtMEZYM8QqicHhxGRb81XAx+pPrgOvCmjepAGCjh4lfEUNPDeg4R222CecnySbp1zuiC9yv+EXoz6zaL6Ye1wq7HbbDTrO9t7h82DraMGxF79oFVr7h7uVhut1lHtsL2zU938QIwvriJzoZQCbrThg4B+Ewj1kpiOAFikYAhRClyslPA4gjt7v0BQZKaLoOak0+t1Tt/1u+3/fOp0263+caf90Vx5Uiz61P4HZCA5Qxy1HM3unna7deSF7JAig2zPQF6PwyfU2iJHfrlCkS+Y7QWzvWC2F8z2gtleMNsLZnvBbL8Gs61DNufwoGUAVbt3YSuRs/pq72ksc70CX9nXaTDy3CYQ9zcx2/pXhkCDm0ypRJX+gm/rnkSxD+NL8y1mdvylhAv7WQefR+bry7QltWyXhkyPBTZTYwgrlJnqMTxV7CFUxZJjC9FkVts7hZKD3cWs0MS8rFJUXeaiAiwpFFhamdQ3EPASfR+cd5x8z7CHoNcqKtc5XOk65h8YKnvZ8Mxo1luda4j7vGPaPFoQg18Aek8giYNZlBkzxdwAcCMQKA0RQ3fVqmxnSDnfWlxvHj7YISz01fJttVXjLOuOrZpjqw7Yw+2tQvsk6/Ncrrdscn2ZfFumsLjQQbGIvNAkWfraNWqHR0OB8qMr2DNWy7VGuZYL2pPU/Eaj9rtyatWW7p75AF5bQnv18IWn/r30Ic84XNHJCpMbvv13+JAO4lQ/sbAMfj6zAIhNTxYNnJcLELaXhFCYTa0wPbqj7kmZfBUJ8WhkerimnYO0sN6+dwBXsYhk3g2+I4XCzlSgOXgI0kvfjSnmq6xXrsooyOXfLrtJhM2/cwiykEbXv2fHkklUhqofRhg4g0RrEZXVZPR6RTGdTsuxXWYQXKaIylTIGxVDal4OuXEyAORbERMs12z6Gjc3qjmkyng4+dT9eBV9+/btKnpG9KaUxg+tBDkr3p9O7m9BazbTFfBLbngZw96lmSbryWDTJ801kBWwxuPc3d0AJP8kg8UChyEqpXmfoIT4i9tm9iWm5zT80xDAiZU3r8m0bN44v3dTx39N/sq3NO49tElnG2+bmLoG4w6+y/HTgq+/mfGoAOsvihREsERHKWi9QD4rio1W12qFBb+P0l7nas35We8CiAfpqyCh8HGNpFN8rQR+7ztX8AMPKWI274vg+B2kUEicgNSBxvLFrEQTdKV8sbCVIf0PekU2Fc1zUuariD0I/sZj3Uv+D4wgKEP/XJLbmQcXLIuSpeYGsCwW/wWEt5Nl +api: {"operationId":"createCustomObject","tags":["CustomObjects"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"201":{"description":"CustomObject created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"object":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create customObject","method":"post","path":"/objects/custom","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/create-property.api.mdx b/docs/docs/api/v2/metadata/create-property.api.mdx index c1b93e65b7..8899e41036 100644 --- a/docs/docs/api/v2/metadata/create-property.api.mdx +++ b/docs/docs/api/v2/metadata/create-property.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Create property" hide_title: true hide_table_of_contents: true -api: eJztWltv2zYU/iuc9rAE8CXpXgojCNYmLRasFyNJMQy24dISbbORSI2knASG//vOISVKsiwnDbqHYW6BmiYPeS48l++YXQcyZYoaLsVVFAyCUDFq2FDhrHkMOkHEdKh4igSwPBgMhDRsLG6XXJM50GaKERhKET8SuqI8prMYZgQZKrbi7J4YSTSLWWhImGkjE6aQmshMkXfCMJUqrhlJYyp6ZHQhhaFAmunJUQKHGTkwjCa/6SylizhjvVAmx2QuFUkkMhYwTKz0vbEA4cbiwiqgCc3ZkTTXBWUyS4bfVzxiilAREcUWXBsUiRskuCn4jAXobuhCB4NRkJuDMx1MOoFmYaY4GGcwWgcPXZry7h3Db5MNrCr2d8a0eSsjmFrbr1wxMK1RGesEISjIhMElmqYxD63w/W8azbsOdLhkCcWReUwZGFzOvoHpQJa0lAFWBU1YhUobxcWicVu3oG4mOAhEQGNh+JyD3nAhM5jXLMKhYnM3Z/BGvbFoqKQGK8ZxeW09bx5yz2EBjnC7YDcoA1sVB9uDIyQ0dUdWzA2844hcXTrTsgeapDHKbnh4xww436YTgPOw+Hl6LbOEii5cdmQdDg1C5LxgmSuhC/YRmT3aNZBXRd2U4vIwF61Xk+c9V9qQT2jgzRbjp+R6QyrfC2ms3j08i+tp6Q7+rJmUMaOicdglm9MsNta6cxprVhPTzsCZCyWzdNrmDqVWRQA12Hy2getcEQ2JsfV7NtOpND1yNSc6ZSH6TdTZun1qDEtSYy/fQNAuS229O1npCJ9jdLEHiDTdIXC+SzI25OxSJJkWvxhrJKfCDlVElmAsGvaA4YAfFI6BISzMmMIQAU+KgQkME7Acr3yPgF/+YXiCw8Lsk4ZzAeP63Y3FWIDuqVRmgOMzg5Y6HwtCzoCKRnaIX5QfLc/f496zPozKudyw5Ai169rTkd3xFtkNjZmGiwjZ1sKQpyxSfFWb7+dsca4Q5szMIAE15IJhdI6mA9pCajfp7NzduXa7a3JFVbikakozIyuLXpoaW88Xr2wf753rH6RYtC5uSbyHv/OTxgFuutuy+mn3dCQzcIHn8S3csHEIunRee7uuRDZIhvv2Po99LRT2ygC1J7ybyYcG0ce9R2j2zAvA6GtaEia7O1cu28ifzw1jfecRuNDOtXXbU5yRLk8sjf35fDf/bDX2RdtC25XDwAc7jPPchDmSG5v7i3o4tTl1g1gCcrqulzSfRfeXB8RIPjvZAgF4kCwgJYmOqwuRq1tYA05f25SuQxqzf5nVieUk7Vm6wosqRZswFgEE+jLm+XyPLXyUFF7er4VNUcShhkPR00/js1YgU1bkzw4lnKLcK4qleS+5E3N6+iNACeJ1+9UabckjAIcvQySbTacCcUe53oVCk4oP5pacOsawcWunhTAdf4AVpbLfQYZp4cq43x4A5VRoZ/NXJyf4UZfZtQN4sWVL84MwOI+eh1QTwEZctENUAEAgBqPYhIjvAakFRnUAvRUEPo336p0SqNcjtr9TDDKFBlNpK9aOVmJJoa2j4qUNxQHzHwD9AdAfAP0B0B8A/QHQHwD9AdD/hwE9bKT304gZyuOdFm1eGWwg+YaXArkOQg7/8IA3SqOIIw8aV363z39+9+ZfNxoQgPPt7YePOMDAiJ1s/4GBRxUgNXxAsK8BDrYFD90C4nbtqRz1xVJug6TRX+xwjuSxPKLpIdZ2xTq5unQ43MFzCDkP0B1s94QQf4/47FJpeoLO1gvFplPRovjtvps3Z9+vh/bxvlsJ/zqQc2gVxjnRtCpISs2ysWWfWE321Q7Ccaj3BaF7joLbBl+Ae15KfCNLpYWglv8g6JeJor+uiLlBEzG1KnwjUzFaz5hUD/p9mvKef9Tisg+HQ1djaH/1qiGph+lvhlfBpvICdYOquvxUeYcqU2XK/2CYK/2FFjTbV7mVYIZXBKhsIxDHEkN0xWJU0j31hCHTzrWsQHCx2Dpflw9f73yUFaz9I4/v96o917YA/sZq3ZPNUPUGqdoF5Urn7USlIp74gnVSKSgjn9PLxO3zdpmcW0Urkqz10wl2emIuUWO8cEd70jv9tXdaqdsf80u2dut47yrNdFOqw/D5E6YiGera8yes1V2pttiIsp/hD7kSRskoC3EOG54/WQzErHijq8oFvVsICBIks0bBInpx/bFH/pKZ7fT9ox/Swn73fMzwSbfw4aLXdxU3ruftIuK17cJGP42uM2GfiyGooLufHBVqqUz0UpgTGB6zzBiobnq1OC4p7u/ve6nbhrp7Q/TvpbrTKQ2Zn+qmAO952JdwO/gqfYzMrWneUm39mHy5/jAWX79+HYtnxGhOabGXk6Byi/lvTmnLI/q6/AHq//aeXoZoHwTk1n7Wmdd5Nh1VYVcnGFTTPiS+JWZeIFqvZ3BtX1S82eA0JB5lH+AxgBVHi9kAj7jGcZk7Wu/h6DpPM8ekTc4iqYrHSp6Aoc25tfpk00GeW18sxo8s8Tv1cXJvQxWvGNbeFwu+Xdb3CrCNMmoiOKILx6iLv61UKBq/3pY73kCRSs1e2mpJH36+ubW/Ibn/tZHICPcAPA0sqoXxGP4GtYbEzmMVEYuMLpDenYsFkWbozdVK7MpuPkCv2OlP1RLtFMF/Ua2d5GeYuKDGn3tyt9K6wVd8R40XMQGB/wGjqysC +api: {"operationId":"createProperty","description":":::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:::\nCreates a custom property in the provider and registers it in Supaglue.\n","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"required":["name","label","type"],"title":"create_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"ticketId","label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create property","description":{"content":":::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:::\nCreates a custom property in the provider and registers it in Supaglue.\n","type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/get-association-types.api.mdx b/docs/docs/api/v2/metadata/get-association-types.api.mdx index b81127106c..4e72db05b1 100644 --- a/docs/docs/api/v2/metadata/get-association-types.api.mdx +++ b/docs/docs/api/v2/metadata/get-association-types.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of associationTypes" sidebar_label: "List associationTypes" hide_title: true hide_table_of_contents: true -api: eJy1VmtvGjkU/Suu90sj8Ujab6iqNrtbVagNidJEVUUQMTMXcDNju35AEOK/917PDAwwpatuFySSsY/v85zrWXNtwAovteqnvMdn4C+d04mMS3crA463eArGQiI8IMTbAC3uxczx3pAfgUct7iAJVvoV7q/5c1sY2X4CehptRmTLJVYaOoH+3oNngmXSeaanTBy7NsKKHDxYF80pfMBjTgebwBiURz9jmSJQkrlvAewKH1wyh1zw3pp7tEMHvJVqxjctbuFbkLbKZNPa2vTCYva/1+ZzOwnO6xxse2dwDiIFe8Jii8OzyE1GS/lqZ+KCfO3X724OrNpn/X+YnwvPgpIYdLZiMqVsphIcbtSAUrEVVpAJYzKZxHrzk1kYqxdozLbjyq/k4UQGbqqxa81JVB5Y6eEgmBGtOKOVQ1ago1fn5/Rn304DcxOtPNaAsLVku18dHVgfR64nXyHxxDtLwvCycIe+Q+ZdDSisFcQK6SF3PzeA3W8izhGPm0BHxGwCpdKZTKzGRcsaAImwqVQii8Js6JQKOQn6evBufHc9vrocfMHV+8GHwfXnAakancdG1jQ6JiPjmuGxtuOgnpReKr7Z08WQR/436LZBdnu57Ed+IhD0WHxaHAfGXJfjLM4QP8eHbu1E25cEcWAX1XAJNiNae29cr9vFudVxwYhZFqAjdReNilR40V284ocM/lTi2OVNn29qM/ATEaygQG0S7lhk5AcgGm2VVmEONXbA9Js+QxTzmoks00uWwgIyIpyLa0kCrtB8DGhD1qaaHFOyhY3zzsXrzgXfFfSqTDCeKaQjkiidMroqS6JLLiQVK9WJ+3NbpUTnuLdfxr3NI+n/gR/WV97qNCS09oDfz5AhGCgTSqEeF0OHIUeyxC4yHCjs79urDvuiA0uEYsHhsbl0EYvni9sNGGKr/mF1rMbq5KhoicOJ8DZt40XjV9sx5DoUyPDF8DYoGpc32vlcqNHLKi0bVMfgmiJqTIL3WnXcYna2QyyXy44pjlHu20J0l9o+OSMS2C61TZjgbOpq7M5CwvKMnMfS/CVc7CG7v/34oB4fHx/Uv+BniaRylxHUuviRLtuGm3avMevd5Pz5HV2S2cOz76JwZXQcWbAutTfkx9pDlcwxONpcryeY573NNhtaLm5cUiROAjHJaIBMRebgRJAvb8tZc8Z+FFGUXtMIWggidY9zuvP+B5cNI27nckQPVpLP+IrUqjT/y/n/zneCE1kdvtv89yo2vQecDODwtWQvhAJ0iaPQ+Nre0WsAdWB7Ybx/d4dYEYi09SldjOTyH+pMtaVWNdv18V24p18KphH+hoSN8//tFl7s/PDA9jYo0FSMEV543wEgZxeH +api: {"operationId":"getAssociationTypes","deprecated":true,"tags":["AssociationTypes"],"security":[{"x-api-key":[]}],"description":"Get a list of associationTypes","parameters":[{"name":"source_entity_id","in":"query","schema":{"type":"string"},"required":true},{"name":"target_entity_id","in":"query","schema":{"type":"string"},"required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AssociationTypes","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"source_entity_id":{"type":"string"},"target_entity_id":{"type":"string"},"display_name":{"type":"string"},"cardinality":{"type":"string","enum":["ONE_TO_MANY","UNKNOWN"],"title":"association_type_cardinality_or_unknown"}},"required":["id","source_entity_id","target_entity_id","display_name","cardinality"],"title":"association_type"}}}}}}}},"method":"get","path":"/association-types","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List associationTypes","description":{"content":"Get a list of associationTypes","type":"text/plain"},"url":{"path":["association-types"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"source_entity_id","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"target_entity_id","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/get-custom-object.api.mdx b/docs/docs/api/v2/metadata/get-custom-object.api.mdx index 39ba728f13..490a345aec 100644 --- a/docs/docs/api/v2/metadata/get-custom-object.api.mdx +++ b/docs/docs/api/v2/metadata/get-custom-object.api.mdx @@ -5,7 +5,7 @@ description: "Get customObject" sidebar_label: "Get customObject" hide_title: true hide_table_of_contents: true -api: eJytVvtv2zYQ/lc47Ye2gCU7jp2kxjCsa4ci2IoVSYphcAyHomibDUWqfNgxDP/vuxNlWX7kgWBpkNrk8e67756rSBfcUCe0usyiQTTl7qO3Tud/p985c1ErcnRqo8Ewah7baNSKLGfeCLeEy1X0ENNCxPccv43WcFtQQ3PuuLHlvYIvoP4hZqUabmKRgXKh4HDGacYNfLNsxnMaDVaRWxYobp0Rago3/IHmhcSjfLlVcRKtW1HGLTOiQA/g+mbGyeaeXH4ibkYd8Ur88Fwuici4cmIiuIWLhqBQZKm9IbQopGAlG2DU8B9eGA60OOP5utXwojB6DspMXJ68xg9LJbcTbRg/7sTGAqksPAomODHWZWDGW1YL6mYH716GrdPtX7CUncVnnW4n7p12aHzRu+AxpRPKUppNehRQY5QNt4VWlltU2O108L9dX/ayiWnlIAYo1yC7/d2i8OoQnd48BD4gUZ0IpsDNJz3odfvn7yfnp/FFv9uLe/3zTvw+PTuPOUuz806XnaUnPeQ9cPiUJifYPXcHMTp8oryUNMU3geitiptSBalcAU0gx6V93ksLmr2k5mmENzXCQnpD5UukLYSvmRvDra1azQgkoFRk1kRKjaFLTDHH8xd4kAlbSLocP89zRdLlJ3QE+sgLnoTQhJTfTbpLRa7r+mpBrQtLckhEwlVGFsLNyN14zO4StCXseMtDbS7VWnKqmvYmVFq+4WQc5I7AUz4v+dzmRZ5CVxg9g3Ex4yoAhV8LTDhN3gQlb1plt8rpA5FcTQH9QkhJUr6R6/b7JF2SjE+oly4hx1QL11QcQFWKC8OZsICKUKDHMni6b+HkorzrtAhWPERazKGfJgdZtBPvRhx3ad7hEIhxwsnDVlbKgIU9E2W4K6VNRuuyqrP2Mc2oc33QdD+Dp2y3WcH8mulqKmJqY0cdRO2gxbaDdHu134HXOAK4mW9mnzcSp4NzhR202zAnE+sLOpWeJ0K3wQjNqKPtefcgj68rOfLh62W0bszca+yTocQak3dbpYX4ky83PA0aMvujatcemCEghRGnUuoFpBTEGQvalmeMcRtGZwkIq0dNNBpGZ4OOTnJympxEW+6/VA6Wb8IEoKycABW6jZdYPTkVSFammf2tZonpHO52ady5PAjmz/ADZeCMzjzDs1v49w+XIMzRE3ShiYuAQZ/DYCrHEYHCIR+vviTkX+0Jo4p4y0Nxoiy8D0sTJyC7iR+wY7TFPiOdgIaB8iaLYQ9yy3qa2wSBDH8aXnmFW8dXbV1O1ejtxi3jVVLAmcLUSL1zWiV2Pn23lVgsFkkRnqHvNRHthTb3tqCM10dx4VMYsW0N0ZkLvniHxktqfqe2jCH5dvXXrbq7u7tVL8jPSrIcNQFBI4pH6uf4xHT8wbWhS4hSURnVVVVbw2qOYBEHXfBhcLDhQCHMwD7Kr1YpuPLNyPUaj2HNM+UK2orm1Igwj4flHMLPWdXFD6DVa0n09qrqNe8I5vAxyJsiU1hOc4qZO4hCtzu2j61xkFYF92os/+dee9SpAH5/P6+9w4Xz1cD3d9knAeyv1jsQgtAH6EOFa9wdrJLYK+vu/fmPG5ClHjOs2SJDP6w+YGSOBrbZO4N5/Itgjor/glUFzffXWjzcPPqgbsVBGskYwXj6D3f5qoc= +api: {"operationId":"getCustomObject","tags":["CustomObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"custom_object_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CustomObject","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"42579f73-8524-4570-9b67-ecbd702c6b14"},"name":{"type":"string","example":"ticket"},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["id","name","description","labels","fields"],"title":"custom_object"}}}}},"description":"Get customObject","method":"get","path":"/objects/custom/{custom_object_id}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Get customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom",":custom_object_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"custom_object_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/get-property.api.mdx b/docs/docs/api/v2/metadata/get-property.api.mdx index 7993fc1549..692e0bcde3 100644 --- a/docs/docs/api/v2/metadata/get-property.api.mdx +++ b/docs/docs/api/v2/metadata/get-property.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get property (preview)" hide_title: true hide_table_of_contents: true -api: eJzVWOtv2zYQ/1c47cMSwI+k+zIIQbCurwXrI0hSDENsuLR0ttlIpEpSTgzD//vuSEmWLNlJi3bA8iGmyCPvdw/eg+tAZaC5FUpexEEYzMFeapqyq6AXxGAiLTJaxbUwDKWyMJI3C2HYDLjNNTAcKpmsGF9ykfBpgjOSXWpYCrhnVjEDCUSWRbmxKgVN1Ezlmr2SFnSmhQGWJVwO2O0LJS1H0tyMj1I8zKrQAk9/N3nG50kOg0ilx2ymNEsVMZY4TB30wUgiuJFEyJbPTRDeBoUUAkww7gUGolwLlCm8XQcPfZ6J/h3Q13iDqxpMpqRB0nAdPDs5oZ+m6G/AsmyrlwiRgrREx7MsEZFDMfxsiHgdmGgBKaeRXWWA29X0M+oAN2ZbVLgq4hqNsVrIeUvpNwtgKY8WQgKTPAWmZsziXImGccOEZQgDOCoXdU+rdiF03M84EaAmliIGPcCz4YGnWULsXgtt7Hs8MNigPM44Ezr/cUQfnLW92GRuMog/gG3FGzDnJBoyVC6qyjhYuRRfcrRcjDNiJkDjLEff4JJNcdVATB6jYUYriqQwNUEjrYxhPEm2zjQg9Oh1kDxNk4s85bKvgccO+j6FZl5lMZuuvkadrNRng/FjuJ6z2neJBpWTxE46YSYavuRCQ91bpkolwGUdw4wnBnDDXKs822vLLeTyWj3JwH/mU7wjdsAuZsxkEJH14h67Ls5g9wLNwq2FNLNkOhyi025Fqczp0DExI6eFB2Gs6TFyILSJBZr0S7ECI3+xTgNehA5RZJ7SVbfwQHeLfjgeg0NcmIKm+yaiuwSZ4DDNEytq3zHyK36sSGlY6nTc8hxk3DTMSI4kyp4pbUMan1nS1PlIMnaGVDx2Q/rQ1Whx/pr2ng1xtJ0rFMuOSLq+O53YHe+QXfMEDBoigp2FS5FBrMWyMT8s2NJcCebMTlW8auHCYXxOqkPaErWf9Hrud67ddE0uuY4WXE94blVtsULTYFvxJZMd4t25/lbJ+d7FHcQH+Hs/aR3gp/t7Vt93T8cqRxd4Gt/SDVuHkEsX6bjvE2eL5PLQ3qexb1yFgxgwkUV3U/XQInp38AgDTzQA3b62JnGy37nych/507nRXe88ghb2c9277THORFcEltb+Yr5f/O5V9ot9C/tMjoPqsuO4iE0UI4V1sb9MdhMXUzdUmGBMN818VUXRw+kBS45tdHIJAqtENseQJHs+L8Qw4+gvlANOf3Mh3UQ8gR/M6sRxUu4sU+PFtebt4paqA/JlivPFHpf4OCu9fNi4NmWGxgSNSc88XuztrVK2GfmDLwFOCfeSU2o+SO5hTk6/R8VBVbz7dEpbiBhLtM5yo3nSS69uQ/p29Qdu31BBXRYst4XcpUDjmg8Wmpx4xn4jv5/EYLH479Ro22S4gRUbvrWQ61HJUXUvZFEex4J48KTWRYRW51BT/3qzKymW871KXAd93HHjsAam2gnFdQcgFqzUsBUyrjfxZRu2KGWJ23enCpKXUrm7JK3+osM50tX2iLaHON2V6+zipa/DfXmOV64q0H3ZXhHi/VtR71ZreoK6DkhFm15NikL/mEu5K7G+Xg5T3fduIUoOrOCwF4x3okkdSMbtorXlEKw2+3oH4Tk0+4LI97Tk3BWSyhV+IJaSxz406JnodQtV9PwUrQhAGAy3UWu4rulsM1w3cG/IfqCXpePmOiHTWpuZcDjEBntQte1CDZEXtlyWD5fPWtCrHuL55UWwqTXr1yS7D561ln0bxzPxF1Agr7ytpNn1s53od3nBkMp1KUmiKH4sISHRXBjjUQTG+70DRC2YnCliTML6M04Gp78OTmsJ9V0hoNvTqxQdVka/3nZbQI8bOBWryDQeN3CtqcbGYsv9f8Y/diGtVnEe0Rx1In9DgsTg+y1gdVzYVEVY2iEyF/cpu724ejdg/6jcteDYf/tMQLS4378MAT3YlPYrm3CfCpNmQC2vonHt0e1Pt1e5dI9Bylhsu8dHpVg6l4MM5yS5xjS3FtOOWc6PtxT39/eDzG8j2StFDO+VvjMZj6Ca6mdYd4toqNA69OZ0TMydav7gxtmQfbx6O5KfPn0aySf4Z0HpiiKPoGbF+jsQO8r8K9fxrouttw9E/5NHM3+jqHEa4rnCSe9ccV3Ehdt6NdMLwmY0DZshDe/wAlVHu9brKVrho042G5rG9KLdsxvVA1qQ5C56xMLQOC5eMQ7o8+iqiJDHbB/wMj7IVVV2hAEOXfho5AEKyv8h66aWNmOqtHyM+mYdfM883imRR75bj1SifbMGu3L3QQC7pUQDgid6jqE7s7W11uNsI++9eXVDxV5O/l3PKj6FFAOyTKdV6+nGs6f/BKaT/IwCEear84rcr+zdUGUvT03KGGPF+C9+KA6f +api: {"operationId":"getProperty","description":":::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","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Get property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"get","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Get property (preview)","description":{"content":":::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","type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/list-custom-objects.api.mdx b/docs/docs/api/v2/metadata/list-custom-objects.api.mdx index 008aa0bfb9..f97d8614b2 100644 --- a/docs/docs/api/v2/metadata/list-custom-objects.api.mdx +++ b/docs/docs/api/v2/metadata/list-custom-objects.api.mdx @@ -5,7 +5,7 @@ description: "List customObjects" sidebar_label: "List customObjects" hide_title: true hide_table_of_contents: true -api: eJytVW2P2kYQ/iubzZechDFH7kKDoippWlWnJmp0SRRVHMot6wE2Z+86+wKHkP97Z9Y2GLieoqhGAjzz7Lw887JbbkqwwiujrzI+5rly/m1w3hR/z76B9I73uBcLx8cTfiif9rgDGazyG1Ru+X0iSpXcAb1NK9SWwooCPFgX9Rpf0MF9IqMZsInK0LjSKFyCyMDim5NLKAQfb7nflAR33iq9QA3ci6LMSVRs9ibOedXjGThpVUk5oPrTElirZ1e/M78UngWtvgfIN0xloL2aK3Co6ACVZhsTLBNlmSsZ+UCnFr4HZQGJ8TZA1etkUVqzQmM2iZKfycOJHNzcWAkPJ9F6YI2Ho2CmJHGl0Q4cORoOBvRzaKdbMjQhjfaYP+E6iabfHIG3p1ELa8WGkvNQuI7ctAYxRmwfr+oQsKCPZnwxvBy9nI+eJ79cDi+Si8vRIHk5ezFKQM6y0WAoX8zOL4iLmuTHLHkl78DzqurSMuGxo+JpZMcrX/Os6NDXutRfm9Cr+BzT/g67v+mJfftjDy8NzcYCYsrCL/ElrQ25tIZTzcGu2mYPNqd28L504zTFwei7UIpFHqCvTIoWRSa8SFdDfhzCxwbH3ny44lVnyD5ScWqeO6O2L1Wp/oJNm/64gznuzUN/6IYhinnDRJ6bNctgBTlV1UWZlODqWYkBVWRtbsgxJVvbGPTPn/fP+Z7y902C8UzddkLGtmuia7OkohZCEVmZke71jiUZKT2k8UB5Urun+LAr7a3JgiTZDX6+QI5goEwohW5cDB2GAqchzgDDQWRvr9/32T8mMCk0Cw6PLZWLWDxf70lgiG3rh+xYg+wUIfcKe4zwNktw8fnNbnxdnwKZPJlcB01r5oNxvhB6+qxNywbdL1GmqTVmwXuj+261ONsj1ut1v6yPUe47ItK1sXeuFBJ2oqQMM5zr1GB1VgrWZ+Q8UvObcLGG7PP1uxt9e3t7o3+gPxsk0d1E0Knig+NyUJVde3q492mZCxVNxbpum1GaNOuEDjfDhG2/RG+k225nGPhnm1cViXGL23jD9PhKWCVm1G943/Ta/qbpy5QjBc7sXOQOTmLarUH+7LrZHmfs/7w3Hkw6zuvJ/bcSNAZjzul2+enAj++KRwM4vroOQqhBb3DsS9/RnVwXtJp2m/HPPz4hVgQqZ3cj1eun+UOVaVV607HdXVW1e/qmYB6Ev6Imxl336w5ea/7zwG7z1WgiY4rL/1+M5xWC +api: {"operationId":"listCustomObjects","tags":["CustomObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CustomObject","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"42579f73-8524-4570-9b67-ecbd702c6b14"},"name":{"type":"string","example":"ticket"}},"required":["id","name"],"title":"simple_custom_object"}}}}}},"description":"List customObjects","method":"get","path":"/objects/custom","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List customObjects","description":{"type":"text/plain"},"url":{"path":["objects","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx b/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx index e0cea71c3c..c6364429d7 100644 --- a/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx +++ b/docs/docs/api/v2/metadata/list-properties-deprecated.api.mdx @@ -5,7 +5,7 @@ description: "List properties" sidebar_label: "List properties" hide_title: true hide_table_of_contents: true -api: eJy1Vm1v2zYQ/isc96UBZDnpvhlDsa5dh2DtFqQtiiExGlo6W2wlUuWLHcPQf98dKclS7KZptsVAbJLHu+eee+OO6xqMcFKr85zPeCmtuzC05yTYl1AbyISDnCc83y9mznhIuBMry2dXfH+BzxNuIfNGui2e7PjtRNRy8hloNW/wtBZGVODA2HCucIFm3bYGNCEV/v7iwWxxYeCLl2ZvzWYFVILPdlF6xq0zUq1QEpSvCId1QuXCENjMW6crPm+apDcSvh5tJAebGVkTU7j9rgBG+pheMoe/9eITZI4ttWGbQmYF22rPNkI55jQjUlndk5TyIarbScQKZiLzDl4BIgfD73X6VlR1SVvVdq/ijDfHoHbn7PwlwhWOeSWRgnLLZA7KySXCCn70glKRC4aJui5lFhLkgK6RF+jfGpWZyZDm7/LDihIsMpjBcSc6C6y1cAfMnHZsrZXFPERDT09P6Wus5zWFAmO2jwYli1YOWSDpgbvTT5au7A6xx2DjxYEWPB2vWllhjKBEkw4q+20dmAIPyr1KZIVU4xxsNW2ZsEw6ihwIYymSdOoKafIJlh8KXLRMpiP+X0lj3Z/ELdJfigWUD8NS+EqoicFQi0X5dUht+HK22H4PINYhikAeAogkHo2AoQYbdVgmDPqjQ7lgiYSLb30tVqWHlL3CYj/HzDGZrhJShlxbFnElSLuDFZiELbQuQaiEoXiMerz6l3fIWVbsrx5ewca2oI2QRUFDVD/mqaUCOTJi8zEHJ2R5NNcOqcILrL3wWMbQ1SUTa1RB4SdkIs8l2RDlYDK0DbZHvWuaZljDVzy0v5h3WMtOuuBcB+fjYP4cXB0UEbb8cHyk7kdFj0Oo0DTyVhDKULgCF9ORjAWz7iaVNyU1NOdqO5tOcaqltssEqaeoDdPfien66QHPXcaw5xfnvBlMyLfUWGLdD+bkvnXU8g+g3tH32E7mbncd20MzDKVo8oiy1BTgNZTklg17WQY2dvsAqCFtS02Gydmo4zQ9+yk94/swvGkdDHdiyxRZaJktus5LyswKkwG3cp3ZX3qWsErwbEzj6PAgaD/iH1WY0bnPaO8aPx+gRGEgT8iFIS6GBn2FnTz07zCMX1y+SdnfOIszoZi3EGuNZPF+fPpgq1Csix+yYzSyU/nSSczTUcZ3A8imBOTqh6tLr6i9XmjrsAXOn3RuGa/SGvcUpcbCO6dVaterk73EZrNJ63iNfO+JmG60+WxrkUG/Nan9AmfSVGN01hI2J2Q8UPOrsCGG7P3l62t1c3NzrR6Qn60k0d0iGETxsE5GIelz08Gtm9alkEFPCOquraFxNSa8QCO0u9stEO97UzYNbccXGFVWLi11DqzFpSgtHJjsxzN/ctnW/AnjyXEooYS69+RaUELOOKeXyv9gpn2I7M3MaWEk2QkP3qSr0Uf7+V++3u7x5O4r9N8zd+zFdi+Auw/IEYQo9BxbV+0GZwfPNYpA39l//+0dTSNPWTnsqrGFtj8oMt2R2g50D9ttNE//CcxR8Z+pELFfP+vF48lXL/TdO0oTGTS7/gGusbW4 +api: {"operationId":"listPropertiesDeprecated","deprecated":true,"tags":["Properties"],"security":[{"x-api-key":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["standard","custom"]}},{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"The name of the object for which you want to list properties."}},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"type":{"type":"string","description":"The type of the property as provided by the third-party Provider. These types are not unified by Supaglue. For Intercom, this is string, integer, boolean, or object. For Outreach, this is integer, boolean, number, array, or string.","example":"string"},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label"],"title":"property_deprecated"}}},"required":["properties"]}}}}},"description":"List properties","method":"get","path":"/properties","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties","description":{"type":"text/plain"},"url":{"path":["properties"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"name","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/list-properties-preview.api.mdx b/docs/docs/api/v2/metadata/list-properties-preview.api.mdx index be1181dd4e..ffbd6d948a 100644 --- a/docs/docs/api/v2/metadata/list-properties-preview.api.mdx +++ b/docs/docs/api/v2/metadata/list-properties-preview.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List properties (preview)" hide_title: true hide_table_of_contents: true -api: eJzVGNlu4zbwV1j1oQngI9m+FEYQdLtHG3SPIMmiKGLDS0tjmxuJVEnKiWH43ztD6rRkx7vYPjQPMcUZzs05uAlUCppboeRVFIyCWBh7rWnPCjDXGlYCHoNeEIEJtUgJD7FGo5FUFsbybikMmwO3mQaGSyXjNeMrLmI+i3FHspwEs4oZiCG0LMyMVQlowmYq0+yNtKBTLQywNOZywO5fKWk5omZmcpIgMatGFnjyq8lSvogzGIQqOWVzpVmiiLHEZeKUGIwlCjeWKLLlCxOM7oNKnWDSCwyEmRZ2jZBN8NTnqeg/AH1NtgjVYFIlDaKONsGLszP6aar+Dg3E0opkLwhRWJCWUHmaxiJ0ggy/GMLfBCZcQsJpZdcpIAU1+4JmwIM1KghtfuW4XGu+RlRhITHP0xBRDcdYLeSi5bu7JbCEh0shgUmeAFNzZnEvp4TuM0xYhqoARx+hCwlql0JH/ZQTAhp0JSLQA6QNTzxJY2L3VmhjPyDBYIs2cT6eEv3nJfrogsabjqKG/OoJ1Aw9YC7WNKToIzS3cWJlUvyTYQBEuCPmAjTucgwxLtkMoQYiCjwNc4Io0sLUFA21MobxOK5ickDSY/BCfJwll1nCZV8Dj5zo+wyaepNFbLb+GnOywp4Nxs/J9ZLVvgtp0Dhx5LQTZqrhn0xoqEfLTKkYuKzLMOexATyw0CpL9/qyErm4nUc5+I9shlfNDtjVnJkUQvJe1GO3OQ32KNAt3GLcp5Zch0sM2kqV0p1OOibmFLTwhLfT9BgFEPrEAm16UKTAyJ+ss4BXoUMVmSWUMSw80d2iH45kcImAGWi6byJ8oByJyySLrah9R8gv/7EioWVh00krcpBx0zFjOZaoe6q0HdH6wpKlLseSsQvE4pFb0ocuV8vLt3T2Yoirai83LDsh7fqOOrE73UG75TEYdEQIO4BrkUKkxaqxP8zZ0l4hzIWdqWjdkguX0SWZDnELqf2mt3O/E3bXtbniOlxyPeWZVTVgKU2DbcmXXHaIdyf8nZKLvcAdiQ/w93HSIuC3+3ugH7q3I5VhCBzHtwjDFhEK6by+9339baFcHzp7HPvGVTgoAxbD8GGmnlpI7w+SMHCkA+j2tS2Jm/1OyOt96Mdzo7veSYIA+7nuPfYcZ8LLE0vrfL7fz3/3GvvVPsA+l+OivOy4znMT5UhhXe4vit3U5dQtNSaY002zXpVZ9HB5wJajyk6uQGCzyRaYkmTP14UI5hzjhWrA+S8upZuQx/AfszpznJSj1dWktbsDimXK8/kZV/g4K6J82Lg2RYU+utnb26VUFfmjbwHOSe4Vp9J8EN2LOT3/Hh0HDQPu0xltKSJs0TrbjSal197chuzt+g88vqW+vGhY7nO9C4UmtRjMLTn1jP1B/jiNwOIM0WnRtsvwAMsPfGsj16OWoxyCyKM8igTx4HFtGBlZnUHN/JvtrqbYzvdKdZ3ok44bhz0w9U5B63gtXCbbrQOjoNjG4bhl3Pzjezocg4r+t+9YCjIG1Xl3g1oDTEfkJOuKRDt8nGELOLt67Zt037vjfSy7d9/Tl4h4Odc0H9amqqCuIdlv26tpkTsHCy13/dfX62HKZNCtRMGB5Rz2CuMjbFoXJOV22TpySKw2+/p44Tk0h4bQz80YChgo6Oelopl+AS55EPtRMKyiYripSbklC4FeFaGR6ZiMZ21qRsMhjsmDcvgWaoi0ceKxfLh60RK0bOFfXl8F29rIfUua+txVG7yrNJqKP4HyaOnPAmfXkzvJ5/qKIZYbEuJY0fVdQUxKuizCwxCMjywnEE1Acq6IMSnraZwNzn8enNfq2ftcQXemVxp2VDr4thp2gJ4ocCtSoWk8USCsacYGsBVgP+Ifu5JWqygLaY8Ggb8gRmTw4w6wulw404TYWaFkLu1ScXl1837A/laZm4Bx/PWJmHDxvH/pAXp2KfxXzMC+EsXNfFYEu3HTyf0P9zeZdE86yliceicnhVo6k4MU9ySFxiyzFrO+WS1OK4zHx8dB6o+R7qUhho9KP5iUh1Bu9VNse0U4VOgdejk6JebONL9x43zIPt28G8vPnz+P5RHxmWO6nsRLUPPizmsOO0n9c9XpbpRtqmee/8nrl79UNLoMka5wBnDRuMlTQaNA9IJRPWXhrV2isQhps5mh3T/peLulbUzZ2j2XUQHWghR1+SIShtZR/mxwwHwnN3kGPGX75CwyglyXdX4U4NIljEZu3U6ou/CJ4ZvF+J7lqVMfL/dumS0Vo7rxzYLvlqSDAuxWyIYIHukl5svU1mCtR81Gcfn9zR01OBlFVD2V+7ydL8gznT6t53jPnv6TMJ3oF3T7sUhclugesvdAWTI8NhmDWqF/Acg7z+A= +api: {"operationId":"listPropertiesPreview","description":":::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","tags":["Properties"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"List properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}},"required":["properties"]}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"get","path":"/properties/{object_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties (preview)","description":{"content":":::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","type":"text/plain"},"url":{"path":["properties",":object_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/list-standard-objects.api.mdx b/docs/docs/api/v2/metadata/list-standard-objects.api.mdx index 46700c2b20..da78a30642 100644 --- a/docs/docs/api/v2/metadata/list-standard-objects.api.mdx +++ b/docs/docs/api/v2/metadata/list-standard-objects.api.mdx @@ -5,7 +5,7 @@ description: "List standardObjects" sidebar_label: "List standardObjects" hide_title: true hide_table_of_contents: true -api: eJytVW1vGzcM/iua+qUB7Luk+2YUQ7sXDMFarEhaDINjLLKOsdXcSapE2TGM++8j781nOy2GYmfA9pEUXx4+pPbSeQgKjbPXhZzJ0kS8RWULFYo/l59BY5QTiWoV5WwuTzWLiYygUzC4I/VePk2VN9NH4LdFTVqvgqoAIcRGb+mFgjxNdYroKghTU5B7Y0m4BlVAoLeo11ApOdtL3Hk2jxiMXZEGnlTlSxZVu4OLK1lPZAFRB+O5DlJ/XIPo9eL6V4FrhSJZ8yVBuROmAIvmwUAkxcjQWLFzKQjlfWl0gwkFDfAlmQAEDoYE9WRUhQ9uQ87CtJF8Tx1RlRAfXNDwfBF9BNFFOElmwZLonY0QOdCry0v+OfZz3DRyop1FQoAtR6XmnyOb78/zViGoHZeHUMWR3PUOKUsiEZo2iRaeb1WNRj8CyroeFzRvD1JJaLAFp0v8ny5Q3TynML0jxop4Rlli3doxo1fQpKhwTS956yrm/QHuE4RNT9AUSm4hoo+zPCcyZzF5tSoTZMbl5FMVClW+eSVP07jt7MTbD9eyHg3GLcPZIjMajwO43vwBjO7Aqt7mlE/H8SiMICuBTqiydFtRwAZK7kNsZFpDbPndJFSztwfHgbnY1sdldvVjdiUPiL/vCmzOtERRGg9NHarkdlbKMFiF0/HNgJJ2FemOYTxSnvXvBT3i2mJwRdIsu6PPX1CSMXAlXMI4L0EBU0X8bVgraHjELzfvM/G3S0IrK1KkY2sTG1s63+43EGTb94/QCY7QqVKJhijJ9qGY0rLC3TByMeNE5j/Mb5Ll1fDBRayUXbzsywrJZp5klqmxTIjOZnGzujhYbLfbzLfHuPYBiHzrwmP0SsMgmvq0pEnMHXVnY2B7wcEbaH5Wsemh+HTz7s7e39/f2f/Az86S4e4yGHXxKyNz1JeBoAhPmPtSmcZZ09l9N07zbgXw4WGgiPprisja/X5JyX8KZV2zmLZvaG6GidyoYNSSOUf3xKTnOE9gYSIraHIfVBnhLKthecmXN93uuBD/575/tuxmZs/urY3iUZhJybfCdyd+uuO/mcDplXOUQmv0lkbf40h3tuR5PQ378fffPpKtStzQ8VZqV1D3hzvTq+xu5Hu8rtrw/M3JPGv+molM++6nwbzVfPXAsP1aawZjQZfAv8+wAuc= +api: {"operationId":"listStandardObjects","tags":["StandardObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"StandardObject","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"ticket"}},"required":["name"],"title":"standard_object"}}}}}},"description":"List standardObjects","method":"get","path":"/objects/standard","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List standardObjects","description":{"type":"text/plain"},"url":{"path":["objects","standard"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/metadata-api.info.mdx b/docs/docs/api/v2/metadata/metadata-api.info.mdx index d72916f4fa..a85ba80a20 100644 --- a/docs/docs/api/v2/metadata/metadata-api.info.mdx +++ b/docs/docs/api/v2/metadata/metadata-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.13.1 diff --git a/docs/docs/api/v2/metadata/register-property.api.mdx b/docs/docs/api/v2/metadata/register-property.api.mdx index 5e0708f11f..a5b3f9e6ef 100644 --- a/docs/docs/api/v2/metadata/register-property.api.mdx +++ b/docs/docs/api/v2/metadata/register-property.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Register Property (preview)" hide_title: true hide_table_of_contents: true -api: eJztGW2P0zb4r3jZB+6kvnDsy1Sd0OAA7bQBpzvQNF2rnpu4rSGxM9tpr6r63/c8tuMkTVoKYtI0DSTi2o/9vL+yjWTOFDVciuskGkWKLbg2TN0o3DebqBclTMeK5wgCAKPRSEjDxuLDkmsyZ9QUihFYSpFuCF1RntJZCjuC3Ci24mxNjCSapSw2JC60kRlTCE1kochrAbhyxTUjeUrFgNxfSWEogBZ6cpbBY0aODKPZL7rI6SIt2CCW2TmZS0UyiYgFLDNL/2AsgLixuPUsaEI9QpJ7bpCqu/Ihz0JGN2TGAB+bF6l9uHmJM03MkhqyZoCPporRZENi+BiW4INmyciVZ+yJxmsrnjAF778eLAYVEXPO0oQsqSYaQAFvvOSCketXFiklOQVkcZFSFeTkEG9kQdZUGBRkRnP8PGSbqQOa2mcfABuoytCFjkb30U0gPZr0Is3iQnHQ5eh+Gz32ac77nxn+muzgVLG/CqbNS5nA1tb+5IqBLRhVsF4Ugz6YMHhE8zzlsZX18JNGa9hGOl6yjOLKbHIG9iFnn0DTQEslPjzlSQ1GG8XFomVaH5aVVAQFEcm5FW7QHoiOGwJkMAra9aI3S66SPgpvAxbnZQ9vs0ea5Smie8OVNu/gwWjXi/Dh00gpBAfJEHhPGA5SVih4ZykJLhWbuz2DZlQRGSupwfbStDL3QbA6suZwAE+4W3Ab2IGrioM5gQN5/Xq2LTPecK5fOR1XfIG1fGYG3Ha369X0du947KHMJ7udO9S5FNqp4tnTp/hpMlw6Ddph5fr/NeV7lznNBt7bgObYxojWGRoGxAYRxXKQMYhKW7I6TAcdOabiWw0IqYfAytLTJLksMir6GKos6YcE6k0sIbPN14iTlPJsIP4SXS9I7XdJjbVtyx3X08qGw1szKVNGG3Y/p6lmcGGhZJEf1GVFcpk5TlLwr8UMXMUMyPWc6JzFqL2kt+e+1BiW5TYewxKMtmIlqNNSR/gcjZY9gm/pHkEDsnkDN91RIpkWT4yVgGOhgxVRZOjWhj2ib+GHwjOwhIMZU+hvEApSQALLrEgNr/1OAJ//GG7jQinTSctyAHFTMWMxFsB7LpUZ4frSoKSejwUhlwBFE7vEHyqsls/f4N3LIayqPS9Ycobc9e3riO58D+yOpkyDImK2d3DDc5YovmrsDz1a3CuJuTQzSGUtumCZPEfRAWxJtdt0cu53nn3o2lxRFS+pmtLCyNphoKaBNuBFlR3D3Xn+uxSLg4d7FB/B7+yk9YDb7h84fde9ncgCTOA0vKUZth5Bk/ZlZ9/Vhi2Qm2N3T0PfcIWjNEAiiz/P5GML6O3RJzQ7UQHofW1Jwma/8+TVIfDTsaGvdz6BB4exHrz2JcwI5wNL677f7/vvQWFfHTo4pHJYBGeHtY9NGCO5sbG/THZTG1N3WJhATNfNfBWi6PH0gL1DiE42QUAjRBYQkkTP5YWEzSnYC+aAi59tSNcxTdk/jOqpxSTtW7qGiypF2/0bVgdoyxjn/Z2y//BWPmy4TZmhIUFD0tNfLvYOVilVRn7vSoALpHtFMTUfBXdkTi++R8WBjar9aYW25AmUaJ3lRvOlV07ctmC39cegVXQ7vkuGJjUb9JKcOsTuIl1PE2agv+2UaFtlcIH4C99ayPWw5AgNOmqUJglHHDStNYy+7wvi3+72OYVyvhfYtaRPOjwOamCsnaKda0GAFqjUsC23bagr26AbLUvcvn2VI7+Yyq2TtPqLDuPINtUTbQuxsgvdNLTatg535Tm4XCjQXdkeAMH/NjieqDU9UW+vNd71alyUvVq/bL2+mg8d/L2bidANegwHiXFGNK0TklOzbF05RlYbfb2DcBiafUHsxjagbbAF0PNS4jQpl7YEtfhH0bAKFMNtjczdsJw6oayYWpVGUqgUxWhMrkfDIc35IEyBuBwCFmhvDB2unrVIDvX6i5vraFebgdwhzy5Q1SYhVczM+W8Mg2bQbAmzr9O9SHNzTQDKdgRpKtFXVyxFbl2PH8dMOxuzBIGGsYe+rUYvr4O72W651rYGWqp2H2mZS4RFUTkKng4ufhpc1FLfWy8ei7EXFDQKhnJX9UUMJ22wlchYNyZtcNZUQuOwZag/wh9yLYySSRHjHvYMf7A0xoGXH2vU6YL2J4YiDCizERrz0NXt2wH5Uxa2WQ5zEoSF+25WyXB6WGq/bJdd0kqboa90Gm0bmfsf7m8LYSeTYJfQIE/OSrZUIQY57Ak0rFlhDCQIvVqcVxDr9XqQu2vIexDEcC3VZ53TmIWtfg4VMo+HErSDA9BzRG5F85JqawHk4+3vY/Hw8DAWJ1i3h7Tli6OgpsUwuCkntuQsd3PX830r3VbznP/HuP/qMa4LRtjfDUGe3Kre+uHWx9L7etHVi0bNoB/CKQS+JYZggN9uZ2B8H1W62+E2BB5lR8BYsCiOurYhN+Ea14kfsxyxoLNbn07OySGSy6AqNqEuGkWwtDG3kah2E6zGXGz9ZjK+Z67v5MfRvV+zBMYwCX8z4fv5/SgB++VGgwQHdOUQ9XHIUoNojXGrGy8gSeXmKGw9t9+8v/tgh0nu/w0ymeAdqFMjW97Cegx/o0ZnYvexRRCLgi4Q3r2LCZEWaNj1TOzSrl+gVXTaUz1FO0bwX2SrE/wSwy/k+OcB3J0cvBAyvoNGReBU/W9IVla0 +api: {"operationId":"registerProperty","description":":::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","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"name":{"type":"string","description":"The unique identifier to be used to refer to this property across all customers. Supaglue will use this to appropriately map to the provider field ID.\n","example":"ticketId"}},"required":["name","id"]}}}},"responses":{"200":{"description":"Register a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}}],"method":"post","path":"/properties/{object_name}/register","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"id":"FirstName","name":"ticketId"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Register Property (preview)","description":{"content":":::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","type":"text/plain"},"url":{"path":["properties",":object_name","register"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/update-custom-object.api.mdx b/docs/docs/api/v2/metadata/update-custom-object.api.mdx index be21bd7f49..6068ddb72e 100644 --- a/docs/docs/api/v2/metadata/update-custom-object.api.mdx +++ b/docs/docs/api/v2/metadata/update-custom-object.api.mdx @@ -5,7 +5,7 @@ description: "Update customObject" sidebar_label: "Update customObject" hide_title: true hide_table_of_contents: true -api: eJztWntz2joW/ypadu70dgaDgYQQut3dPHtpm8dCcttOkqHCFqDGthxJhtAM333PkWywgaTZ7u1/STttkI6OzuN3Hub4oSRiJqnmIur4pXYpiX2q2UGitAjPBt+Yp0vlkqYjVWpflfLLqnRTLinmJZLrGWw+lO4dGnPnluGnmznsxlTSkGkmldmP4APccO94hg2TDveBOY9gccyozyR8Ut6YhbTUfijpWYzkSksejWCH3dMwDnApnC1Z1ErzcslnypM8RiVg+2LMSLZPOodEj6kmScTvEhbMCPdZpPmQMwUbOUIekZlIJKFxHHDPGAQulewu4ZKBZbRM2Lyc0yKWYgLMpGNWfkYPRQOmhkJ6bLMS2Q0kveFRYawSfWEc019aNaZ6vHbuebK59e2WN/CaTtOtu85Ww6VOa6vFHEqH1BtQf7hFQWr0MnJnSu8Lf4YsVy/zRKTB4riVM231m0I1H9ZlERnoQHtApgZH4W66/EM6lYxGIA3z+9Y2T+mouXfLkMW66fEw4uGVTwJ+y4gWJFGMgLNyqCFWhgo5huXewpllMmVkyoMAscQin3zt972vhA9JxDymFJUze+SPZNCLhS4Tri19TBWiUopkNCZUOVxV1pCxrlCUBAEdoEbW4ksFL4yCqZjICehYoJ5hReCcBFQ+bT/LHvnGQSJp8BxqBaDJI/JqedeCzQ1ylDwEQ/UhUAO/D0nlUX+uOw+orQPF0HjrOuN2XSKGnzV/KloZQ3/hCj3minCbGwytTR/GPQNGfK7igM6Yb6BAiWSekD5ywAOXHTKYEZ8NaRJsgIXhnXGSbMgkizxgRVUq5ikIvZBxA1QxtME2Zj/vRSolnWHQaxY+w7upEs+IkBRAnUO89iknbJJ01TWdaN0aIQQSwRiZcj22gWIgz1V/iZHFdQMhAkaj/H1DGiiW2aRv6TaIFyWhwdoyZsIB5OmbH8g4HbNoAQkFloA88MoyeVU2TgvpPQlYNALpM8+mdPXt7QIaNrGGwM8xtkKljGOAFlcgFaFgHuXB0dUbai2z55YBTCoGT/MJVLjKWoQV/J3zY9HMBRuCYTTXwXpxMTRww2oQF9Nu0ayLvPNoWC8wnb9XMuhE+rYh6RekWNMwXb6Zp4KpWETKgr3uugbzBTfnGxlib0AD/EW1ikkp5P8Tn0xTvjGbrue6ISR/Yi4kIdaWESxJKE0IIclCoRk5T9uICsEDVgkDnIABXjBJ2gstvCbgHsTt4lQhuh+uwUg+JKn2luuWryEifciqbVhWmupEwe/XVv/rEmynIpnVc6vjDG4IoGGAIimhzgqNn7nfJlcP1/gDmPwTF+wHG99l+yHjZnfsfwuu1/mfUr9PByLRfZCosE58AVfjreyeK20XU/ZW7ALz7tn5UffiS//w7Kh3etE/+tzpXRTOIHoLR1YuzugCAQHMvzP/CC85+UWKzG+M1aEkSRakPb2xPfV2t+rbdc/ZdQfbzta2X3eoX/OdXbo73Glu1/wdv26PQiSMBFZKOPXn3sfO4d5F5+y0f9TtnnXhAiCxLa6yXqcedjQOBo4UgUODQEwdiFzTZIPrDB/jQ8t+6HgUAOjk0HL45XTvpHOQ7UOkmOWWu93wazuDXZ+y3WZzy+m9T2lEFGGuE5Gh8wKRMbfR69h0bDYbzVphC+PJGmQlvN94Yyohrb5N9NBpmTOYFAztiYjKpFYjPRaTultvkHqjvV1r1+vk3cmFIY1YYChTBKvEWKU/lNTKaf3sVtxaCgfJYiF1X4sCBEB75JTHDZSX/hIpTXer5bpzc6dl4QCL3M1QSWPBI52Cr53FVCKDwk1jrWPVrlZpBS6sgAkTfwgtGKt4IqxaztVJ41/q7fFomnw+G5z9Vj/+3qTjy/cf1P23w4/088Wnb0K8b+l9d7r1W30f/n6AMveup+/d43e3Ue1cvBdn9/UP8vhkyMffT/3h3h2/vds5CEcDPwinH/Zb49swbrCLQbN1F49q7sfPx0F3xHt33fHg08nO7EtvKFoHn8PzfS9Dd2qUETTI8c9bTjE5YTIDT6q53YE864FNJY2UsW72fGuIgaMDHN82atuNpuu6b6Dt84LEZ71kcChCyiP1Bst2IKhv2E1oGkhC8hEHEO0BLmLtHEWQQyGhG6J7Jw9OR5jkbiMjEiriw2FKxqKJmDlJDEIyGjqoBfeYo3loYbpbywgnM1QB9gLIDCxKdc0+9I3z12jBppqhLEM+SuwXAhuOVSHCHzmaCWRSoikDKDDElLUn5KO0KOSPGl/4zmDmxMKmKk59t14dJwP8MkH7Vas2FMj7mdOENLbbanrbTWf3Xo3ra+wmXOqEBs5YQEo0cb4QFziCT7WTS44O/x+z45ILGIgFPOTagWgDHeDOEKonB8CIyLfuqwFG3EfPAZoyqkdpoIADqgxS0MG7jxLaa4NZyvGHdKuc0wPpo/xP2MWY3xyq79f2txqtZqNZ39ne3W/ubR00IPbqe4e1Zmu/5TYODw9q+0c7O+76D8T4/DoyD5RSwBNt+GhDv94I9ZKYjqCxSJsh7FLgwUoJj2NzZ58vsCky28Wm5qTT63VO3/W7R/+57HSPDvvHnaOP5pEn7UV/dP8eGUjOsI9arGbPnva61c4L2SFF1rI9o/N6un1Cq81z5FfLLvKlZ3vp2V56tpee7aVne+nZXnq2l57t1/Rsqy1baX/v0DRUR70LW4lKy6/2ftzL3Cybr+zrNFiZUon6/4Kv1n7Ycj7eDJqvHDNZFxLO7c9qp3hpvmtM50eL+WrI9Fjg9DVOjMg4tmuXqlYHVbXU1YfVMd8c54wmMdoBK1QMHEFmdSLmFZU2xRUuqnAJhctpdVJfa2AXzfPeeQdz9mKw28Oe1ZouN95dWj/mHxiafzEVzWhW56ErDfN5x0xptCCm/YDOeQI5GBylzJqpxaZ/NgKBGbHgd5eTxqOs0c1PBldnf48O+ApjsfxUbDn3yoZby9nWcoD1+HSqMP3IxjRXqxOX3FglP1UpHC4MQGxDXZhxLNB3g9bh0VCg/AgFq6NbqTUqtVzMnaTuNxa1X3VTa7b09gwD+NQR2icHX3jq3wsMQZ8Be0WQFTbX0P53+CEdbDP9xHZV8OcTC4DYjFTRwXm5oEH2khDqqkn1ZsR20D2pkC8iIR6NzAjWTGOQFs7bVxfgSSoiGboBO1IoHCwFmgNCkF76Tkwx3WQDdVVBQa7+dtVNIpzdnUPpCWl083umlkyiChTtMMLAGSRai6iiJqPXS4rpdFqJ7THTgGWGqE6FvFUxZNbFkhMnA2hcq2KC1ZZNX+PlxjT7VBmEk8vux+vo69ev19EzojelNDi0EuS8uDnBbJ4ga3avq4BLbngZxz6kyScbqeDMxvKCX9pr7xlApsCyjfQPDwPQ5lIG8zkuQ6RK8yJIGVsqbufTNhLw9yWoV0RbjGBKv3dT/L8mCONNImdZKMJ8Y2oJfLIxtemtCFNV0oz007L8lW+XbFTKCr/6lsxCO3zt46cFX32j5EkBVl9wKYhgiQ7SNvgC+Swp1oZnyxO2nX6S9iZXEM8vL4B2kL5bEgofj0g6xbda4N926Rr+wIe0BTcvoOD6AyR1SOXQ+gONZYt5kiYI7nz5srUq/QVBsRFT+bpm9cB/UauN5P/AmIbC+M8Fud159MCiTFpqbjqg+fy/IUfbPw== +api: {"operationId":"updateCustomObject","tags":["CustomObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"custom_object_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"200":{"description":"CustomObject updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update customObject","method":"put","path":"/objects/custom/{custom_object_id}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom",":custom_object_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"custom_object_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/metadata/update-property.api.mdx b/docs/docs/api/v2/metadata/update-property.api.mdx index 62ec11bf68..ce38b1339c 100644 --- a/docs/docs/api/v2/metadata/update-property.api.mdx +++ b/docs/docs/api/v2/metadata/update-property.api.mdx @@ -5,7 +5,7 @@ description: "Update custom property (preview)" sidebar_label: "Update property (preview)" hide_title: true hide_table_of_contents: true -api: eJztWutv2zYQ/1c47cMSwI+k+zIYQbA0XdFgfRhJimFwDJeWaJuNTGokZScw/L/vjpQoyZLcNGsHDHML1BTvyHvwHj9K3QQyYYoaLsVVFAyCNImoYUOFs+Yx6AQR06HiCTIA+aMlkzDVRi5JkrGRo0SxFWfrY1hg6FwHg1GQ7cGZDsadQLMwVRx2HIw2wUOXJrx7z/BpvAWqYn+lTJuXMoKpjX3kioE+RqWsE4RSGCYMkmiSxDy0+vY/a9RpE+hwwZYUR+YxYaClnH5moQFdkkIHoMZ0yuISmzaKi3nNxtsFI4t0SUVXMRrRacyIoEtG5IwYIHmjqcbxikcsItNHSzMLrqJuQpE8dDTVAwHsgS6TGGW+5kob8h72C7Y7gr+k1wUpPefazDiLox7uxfWk8JvfayplzKiobfaKzWgaG02MJDMaa1ZR087AnnMl02SC1jepV1il04TO45TVxHwQMTjKnRk6ciYVeZNOdSJNj1zNiE5YyMGGqENusj3ImscxocawZWJQPRjScFFYi3PgaE2sdoTPCDeEPXBtdIfA/iEcG8QoTDpSJJkWPxnrJGdCgykiXWLQGvaAcYM/FLaBIRCmTGEs8fA+BiEwXILneOkZcyL7MXyJw9zt41pwgeDq2d2JOwG2J1KZAY7PDHrq/E4QcgZcNLJDfFB+tDh/jWvP+jAq5jLHkiO0rmt3R3HHO2w3NGYaDiJkO4QhT1ik+Koy38/E4lyuzJmZQqbW9IJhdI6uA95cazfp/NxtpN02Ta6oChdUTWhqZInotamI9XLxyPbJbqS/lWLeStzReI98Fye1Ddx0t4X6vnk6kimEwNPk5mFY2wRDOqvsXc1iKIg1luG+tU8TX0mFvTpAkQ7vp/KhxvRu7xaaPfEAMPvqnoTJbiPlVRv706VhrjdugYR2qa3LviQZ+bLCUlufzXez31ZnX7YR2o4cBj7ZYZzVJqyR3Njan/fDia2pW2y6UNN1taX5Krq/PXBBiupkG4SAejaHkiQ6ri9Erm9hDzj9xZZ0HdKYfWdRJ1aStHvpkiyqFK2DJAQQGMtY57M1tvFRkkd5v5I2eROHHg5NT/8DIFN05A8OJZyi3iuKrXkvu1NzcvotQAl0ZredddqCRxETz0Mk222nhAVHmd25QeNSDGaenDjBsHBbEB2kneRxikS7L/RKoZ1DX5yc4E9VoUuHI6hHfME3Q6I8ehoMXQLw4aIdfwK6ATUYVRrj+SsQaA5AHZBvRXhfBnPVmwCY1yO3GAGKQRnQ4Cpt1UoFB4RPQBthEO8pmKWGhFSQKVA1s6hOsRlSMnhXGBoqqTWhkJNOHFPaxtb/G9Af0PoBrR/Q+gGtH9D6Aa0f0PoBrf+H0TospOtJxAzlcaNH60cGC0i24LlAroOQg65gC4wxPFEaRRxl0Lj09jp7Ce3dv9nuWgpwvuPNtaqPGzIOMDBiJ3v/wMSjCpCaASxr34k72BY8dHOI27W7crQXW7lNktr9oiE4lo/FFvUIsb7L6eTqlcPhDp5DynmA7mC7Z4T8e5SpIqVLT9DZeU+/7ZSsyPwPvZRaiPX1dmif781G5BJIJqFVGRdEk7IiCTWL2pJ9atXFl28QTkL1XoA3RQqxuy1p4kPhO+qSy2jTBiITom4hIyc6RNlWhUHQL+pWf1Py2ra/qWi+xRNkapWHbqpiPFxjEj3o92nCe/kNo8dlH6TBpcvQ/upFTXl/i7gYXgXb0meiG7Telc/Sx6Kikif8d4al3MdbzrMbaTv1b3hFgMveU+JYYgVZsRhNs4WMhiHTLvKtQhB3eLO/Lr5O/eaLQF7WyxfAXXH+yCpXOVsuq7e18pUsMzG725Ta84nvniel7jYqNPFdxDeRolO0qpZXfJs0Y7x2iplE+/B4He9J7/Tn3mkJRLzLjtR6qeODa+AD/aYwB4KYo3KRDPWvPi5CuQRaNXAqxFrK/wh/yJUwSkZpiHN4+/qDxcDM3B2TkbJecJEMAc6CZtYp2NEvr9/1yJ8yta8dUs1c90NeWO8+g0IaCZJHbP7iwbX/uNpE8vKj7ZVw9MPoOhVYJodSmyUV46PcLJWKXgJzApNhmhoDrVav5scFx3q97iVuGdruHdFfS3WvExoyP9VN4K7Bw76E07EfXFG4dc1Lqm3Uko/Xb+/Ep0+f7sQTMjLjtEDQaVA6xexjb+NX3h3Y4d+LPekLcRHh/SSm3Iq3sbDJStGoDKE6waBawgfVOgplYwG646rNZgpu+Kji7RanIW2V/caMCaE4dnmbMBHXOC5ysdWao+ssbY9Jm+J5SRKPpbyDoa1YleaDneBfFF31ks3trCw+2wffEjw0WuQ03wVB3rRne7AJMOxVYBe/VFRwTJdOUBff2pQ4au+FixUX0F8Ss5e33J6HF7eXb+zrKfffIpYywkWAfAMLmGF8B3+Dyl3HzmNPEPOUzpHfbYzNjKaYXOUu6lpmNsCwaAypcnt1luC/aFcj+xmWIejP557dUVoX+G7tuPEkxqDw31D7o4w= +api: {"operationId":"updateProperty","description":"Update custom property (preview)","tags":["Properties"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","description":"Defaults to false.","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}}},"title":"update_property"}}}},"responses":{"200":{"description":"Create a property","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"custom_name":{"type":"string","description":"Only applicable for custom properties. This represents the unique identifier that can be used to refer to this property across all customers."},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"description":{"type":"string","description":"A description of the field."},"is_required":{"type":"boolean","example":false},"group_name":{"type":"string","example":"supaglue","description":"Only applicable for Hubspot. If specified, Supaglue will attempt to attach the field to this group if it exists, or create it if it doesn't."},"type":{"type":"string","enum":["text","textarea","number","picklist","multipicklist","date","datetime","boolean"],"description":"Type of the field.\n\nSupport:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
    FieldHubspot (type-fieldType)SalesforcePipedrive
    textstring-textTextvarchar_auto
    textareastring-textareaLongtextareatext
    numbernumber-numberNumberdouble
    picklistenumeration-selectPicklistenum
    multipicklistenumeration-checkboxMultipicklistset
    datedate-dateDatedate
    datetimedatetime-dateDatetimedate
    booleanboolean-booleancheckboxCheckboxenum
    \n","title":"property_type"},"precision":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 18."},"scale":{"type":"number","description":"Only applicable in Salesforce. If not given, will default to 0."},"options":{"type":"array","description":"The list of options for a picklist/multipicklist field.","items":{"type":"object","properties":{"label":{"type":"string","example":"Option 1"},"value":{"type":"string","example":"option_1"},"description":{"type":"string","description":"A description of this option."},"hidden":{"type":"boolean","description":"Defaults to false."}},"required":["label","value"],"title":"picklist_option"}},"raw_details":{"type":"object","description":"The raw details of the property as provided by the third-party Provider, if available.","additionalProperties":true,"example":{}}},"required":["id","label","type"],"title":"property_unified"}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"object_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the object.","example":"contact"}},{"name":"property_name","in":"path","required":true,"schema":{"type":"string","description":"The name of the property.","example":"contact"}}],"method":"patch","path":"/properties/{object_name}/{property_name}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"label":"First Name","description":"string","is_required":false,"group_name":"supaglue","type":"text","precision":0,"scale":0,"options":[{"label":"Option 1","value":"option_1","description":"string","hidden":true}]},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update property (preview)","description":{"content":"Update custom property (preview)","type":"text/plain"},"url":{"path":["properties",":object_name",":property_name"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_name"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"property_name"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/metadata/metadata-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/connection-created.api.mdx b/docs/docs/api/v2/mgmt/connection-created.api.mdx index 562bd0e8ad..a5b456d3f8 100644 --- a/docs/docs/api/v2/mgmt/connection-created.api.mdx +++ b/docs/docs/api/v2/mgmt/connection-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of a connection for a customer" sidebar_label: "Customer connection created" hide_title: true hide_table_of_contents: true -api: eJzVVktv4zYQ/iuseukClh9x7GxyajfIIehjFw4WiyIbKCNqbHMtkSofdtLA/70zlC1HqZPutfZBIjkz38w3D+opKdBJq2qvjE4ukj+MV3MlgZfCzIVfopAW2zUIabRGGddzY3kjOG8qtEkvMTXaKHpdkK2D5CVbwIIkHlJco/apf6yxI9KXrYyHhUsubpMvmC+NWYkr1nDJXS+x+FdA5z+Y4jG5eGJtT0f8CnVd7twefHMcylOCD1DVJfLrpjGVRfDsLfB9NJniEHA8lHl+Pk4n+XCSno7eT9N8WmA6AilHw+FofHY+IaXamrUq9koTOC1ykNN0DJNpegrFefoeYJziWX42Hw5zHJ6cMhIhLox9ZE9s9dyKhor9c1CiI44lJhy6CyWFmtx8vry8urlJtr3EySVWwPHtIjL5NwqoMUWp8Arda9G3Os5bpRekgzpUTPsRWoj6lsxj59sXvB0x3qp/F6XbF5y+ZfC76N4+5/uN2GMiUC9ggRWXFi+sksvdogK7Qk86GQQKN9YbbWuTtda7XEV7XvlmtZfZ/ivZr7u0DLmrDYN36qFWNRZWrfn9b9TUxavMYVmyky4rHsmski4bTydZ1GMxsyQ/o0cSaion1jXBUxLlkl4XJgJDbcrS7PFKM2dsRZ1mpWHdUmkE7nZZ0jNXfDx1qB22BJmOt9mBNVmaUGSUaROoEjs8uxLkqsveIfQ9g13Wtoe2eJ2/fb/0kqvZ7OMsudtum0GiLFUuCRzpjm45d2vxWSG9zGLrDmE0KOQ+8RKb8GQ45Ed33M7QB6tpiNKpcB58cMIboXTBwwxp/IKPM7gAD2IDTliUSFkvhAtSonPzUJZUUFvmjYahI7s8PJ+SFfJk6czbXrKGMrzWw0R9hX5p4txbN0mpwS9puaOIs4R2jbZBCLbkJHlfu4vBAGrVd6GGBSH0lRlUi8oP1iek0w35Zicjfvl0HUEdymCVf7zhadZw9ZCStTRG0CaWdn5F5nw3HQ8yXJ3sCEIRb6EuHsEIkmJagep6IwoKruTxGKmGyGLkODpERPL9MTvcNFf/82vk0EXH7hCl54ZD46w2hA37o2n//FnT/Q5616aRol68d0HGrtth7JPKfVeB4roojHQ/twXRjI5uxXQOty/z9iP9xLX21hQhsvuV/l+wJGHkxHHGup4Jggy8iGO5L/40QUjQIjhuJOWiDGlWUav9bhE82xbNd4sToItnnziuz6i3P9zOgiY58ck4T+p3P+1jsEH3a9rTXPJ58J6A3Xrx7iCx2Wz6daPGgbZRDzbGrlwNEtuttA45fcUMDCVjrXDzjsEjDx/AxfoUn2e/8eb9/f1X/R+dt5Oikv4HNUFkkg== +api: {"description":"Notification of the creation of a connection for a customer","operationId":"connectionCreated","x-event-type":"connection.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.created"],"example":"connection.created"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/connection-deleted.api.mdx b/docs/docs/api/v2/mgmt/connection-deleted.api.mdx index f30e0fc61c..9d64f599ca 100644 --- a/docs/docs/api/v2/mgmt/connection-deleted.api.mdx +++ b/docs/docs/api/v2/mgmt/connection-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of a connection for a customer" sidebar_label: "Customer connection deleted" hide_title: true hide_table_of_contents: true -api: eJzlVktT40YQ/iuKcslWIVvG2BhOyW44UEk2W6a2tlIsJVqjtj1raUaZhw2h9N/TPbJlxALhHjhYM+rn9/VDD3GBVhhZO6lVfB5/1E4upAA+RnoRuRVGBZa4P0MktFIownmhDV9463SFJj6KdY0mqF4WZOsg+StbwIIk7hLcoHKJu6+xJzIoOhkHSxufX8dfMF9pvY4uWMPGN0exwb89WvdeF/fx+QNrO3rFj1DX5S7s4TfLqTzEeAdVXSI/bltTWXCeveb8cJlJTmKap5DDYpakp9MiOZnhaXImikWyGB2L6QxnUzzOWW0HQquE41Tk+dk4meTpJDkZzaZJPi0wGYEQozQdjU/PJqRUG72RxV5pAidFDmKajGEyTU6gOEtmAOMET/PTRZrmmB6fsCdwuNTmnhMw1WMrCipOy0KJlqgRGDNi1peEUHz1+cOHi6uruDmKrVhhBQzLDgidf6OUW1PEoJNoXwKt07HOSLUkHVS+YraeQZMY6zh47n3zHdzPmO8MvImJ5gkVrxl8E0vNE5peM/gmBpvHFL4CZ+AW1RKWWHGR88FIsdodKjBr6kq1zMBTuqHy6VrprLPehz/Yc9K1p71M8139vBzSyue21uy8V2K1rLEwcsPP/6CiebLOLJYlB2mz4p7MSmGz8XSSBT0W0yuKM0QkoKYKZV3tnUEQK3pc6uAYal2Weu+v1Av2LannjdCsW0qFwHNHlPSbS349tagsdgDpXrTZATVRal9kxLT2VNw9nG0JYt1H75D6HsE+as2h017Gb9+CR/HFfP7nPL5pmnakSUPNQALPNNzTDumXd782HxXWU1a78Mhn65XSIZxCnx+nKf/0F8EcnTeKxju9jawD523kdCRVwWMWaTGAa7cDOIi2YCODAqkKish6IdDahS9LKrCGcaQxbckuj/WHeI08vHqb4CjeQOlfGhNERYVupcNo3bQk1eBWdNxBxqyh2aBpPXhTMmnO1fZ8OIRaDqyvYUkeBlIPq2Xlhptj0umnfLWTiX75dBmcWhTeSHd/xQOzxeouIWtJyKAjmm5+Q8Z8N4APMlytHAhCEfZj3x+5iUiKYQWq8y0t2g2WPIED1BBQDBiHgAhI3mzzww68+H8uuEMzPrfdpFpoRoSLocU5HYymg7NHvfsHqF23B2QDJg5EaN6dj30tcPtWILmcCi3sz10dtROoX2i9l81Tun+kv+hSOaMLH/D/Sv9fsCRhZL6Z6H5kEbn0fAjTfRD9pX0kQEXecv9JG2RIswpa3YdYxCNy2X6I2QhU8eibzQ7Y6/UP13OvSC76pK0j9Zuf9jkYrwY13SnulNw7R47tZvnuILHdbgd1q8aJdlkPt9qsbQ0Cu6uk9jl9lg01kbGRuH3HzgMO78GGso4+z3/ny9vb26/qPxp2J0Wd8C8K96UW +api: {"description":"Notification of the deletion of a connection for a customer","operationId":"connectionDeleted","x-event-type":"connection.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.deleted"],"example":"connection.deleted"},"connection_id":{"type":"string","example":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","connection_id","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/create-connection.api.mdx b/docs/docs/api/v2/mgmt/create-connection.api.mdx index f9a12977b5..5569eb7453 100644 --- a/docs/docs/api/v2/mgmt/create-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/create-connection.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is for providers that use API key or access key for sidebar_label: "Create a connection" hide_title: true hide_table_of_contents: true -api: eJzlWW2P2zYS/iuq8qFZwLK9Xr/IxuFw1yAFgmsviyRFcdgsFIqibHYlUUdS3vgM//fOkHpf2+tu2/twl0V2JXJmOJyXh8PR3hU5k0Rzkb2L3JVLJSOavRFZxigOugM3YopKnpu3lftpw5XDsigXPNMOPMdCOrkUWx4xqRy9IdopFHP+fvvOeWA7B2YJpUwp84bEpNAblmlOzapD5zZhBBiQ6e5tGrIoYpHzA88e1P3rjda5Wo1GkaBqqIqcrJOCDalIR3lCNEhLRynJyJpFHop9JfC3NxlfHVML+HMhtfMeiSbHdIHdarJW7urObUyg3PuBmxNJUqZBFkzu3Qxe0FqF0iJlMuARsHK0T070Bp4l+3fBJQOTalmwgavohqXEXe1dvcuRVWnJs7V7OIBwxWghud4Z0V89knMPjAVv9ziLopjS34loh/x9yVRkGraAUyTPk3Iro18UumvfWlhk7H1slihVEOEvsEPcM9cJDpBcJImAATAcRIXmTCFjZcbA7rq/hYHLsiJFm5X8oDP7StK8LfMwKLnOcfMAt91jt4PAXz0eEdEN0Sr00MHgXodaV0JUVf5CRzdrsDGdzaazyFssQt+bzvzIC6dh7MV0Mb4mS8oooeCotlPvekYpd9coeX8YnLbzWhitX2hlw90xkhm5xMImEVG/AEJOMt2z9ZNptHo9eIHhu4n+x9l+cES336KNZblYqcnMJ/6YEG/ClqE3HYdjz48W8OrHPk7N5vHNxQHR2O/YLs7GiSIJU6A0ZS+PlpaMjrNb4xdEjsHVSVdCOWbMEEumNoEWDyw7gnEIjUqTjLKgkMlRgkSseXZi9jJDd5XoLXnWzJsiVLnQL7dxJaBjnmrwT7fuS8wDB8vhYDlByUzZDU/GY/zTTaPmIHRscYBH3cWHTt/mXQvDsXnMLA06+L5PWRR7bBmNvemEzrzl1J95k2gxWfrTmLB4Yo+GWofgOZkRSAxv4tjzw0XsgYyFF/oR8/zpcrKcxHNK5kuU2T7bzwpMd15F610jZ+2B5zjni0VMY0o8GvtLb3rjLzxyDU+La+r7s5DNFyHtCLw0EAc96OA5iyTf4vN/oHZj6gHwJ0ngNVVBtAOxnKrgZj4LDB+SiY0IqEzR1yRXRYK8otAQARTrm/IIqysGw5eIWJvMgzoJajR4THjGiEQhUOTJkOP0XDEIOFybyAemRUfbwA7CtgKaiCIKADJFkemAZWso81IMOqBPCH04nm5NWnethh6F4F0LefQgqyxot9xZjGWS00350qgH+SlSUtbIGRirkt5Ry8qrVKppnoXEztbKIhiifFhu05TAmISEajW6ntxMZ/MnB+C7cgXnpw8/nD37DlV9CtbPc1heBUAW8/VTNDDlf1n1x5wlkVOxOI9QSTs7UTgR0cRJRcQSKOphyrl7b9L/snreQoUaiS2TW84eX1nV1NXQ+QT69xbdMMkcAv8VnO/hDteX9c5UuT7u++57w/hjxQhF4jl1oI4bbSejdJ3qUZHDjphnFfOMAl6lwNWwgtiTIAfiUsClcl8tVxMpCVYFXLNUPQ+W5fDZUHljQyIIDG4YVWufvnzlMjiMuPPrGzxASql0nXeoAIsuYf8e+f5p2HqnWkeF+yajrMZBZ6fuoc9d76tnkXskxCSJiIz+qx76v3dPLTUrkuRibxlOuK/r3Tm7nYYsK3p0OXK9xcXAzhdBFyuJG+yyulZoUULYcSUuRzKj0+6FUKYgbry+WpfHWmn8Y5UNuOZJApyQ8lxBXKWkW5VhWMC7x6uffiiW9a4hbkVik+UysDLLfP8jM7G0zslU6gcmc1BNR8TGsTYgeGZd36pph78/iX/LylXQfYt9My4jLycS4u22rKccLUTivGbD9dD5WBduV8MLoaJjo57iLX+1yU4DexOOLVZa31iCLla4bdy5u+8LM0283lVi0OvxtWv7fmHeqjD7189jyuFuUIWU6Y3A3msulAkp7CCu3FGd+6N9S4fDiLY6k9g7lNuqK2kqyVa5yBsg4MICwHbyJBg+ljSII267HfkRQd0Gdqsp2eRGzv9huhplM7ShKVuhG0bANifbc1o4BC4Pj07EtizBNFJmzLZtMCyNQmAhvFZ+aLqgbysXPrmiN/eRRseq9VJ1Dy9uOfEsFrgGmtdqPh5ez4fLVj3/o+k949XA6GrvxcQiYKlRZV3MjpRwdBBC9N/aEA1zXdd1Jg99A76Cf867TEsRFSYOPsPPzywBYoYWRNN1NXNgyQJfypb7v+CsoyQzPXeNxyPSAKftpdcA4OBNbm2/DigH8NNpxd4QV7375u5DkSFy3ELwAntzEMkiG+YwlmHshYXWsLDarq8aisfHx2Fu2cxBVe169Cjkg8oJZfWQlxchpGV9sF7h4sYO35HyYwNccnDwy5cvn7NnUqCkMldru37LYW9Mk8Mhrb32Q3jf9D/+97+H2ETS7KvGNbixWnlltUh1V0Mk4tGqi5e0+xllgxAHHPt9CHv8SSaHAw5DakvzvWPgbonkJDQADXdPrvAZwDEmiWJn3PD6QwnkV84ppStIyBAOtgRzcuXCo0WFttoHrDZK9EI1LMUbu5j3yRYYlYQn/S9sNVoO7EDn+iztfQv/b99//ATEYfmhB+tQGJXkEdt38HvlfoYf7MPk1qD4NQjH925CsnUBbgcaKxdhE53ZxesaCu3npf1xm7SB3G7EfoE5Qf4XDG04Cf5ak9uZkwz1uWCp0TtY2v8KLKfwNw== +api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,26 @@ This endpoint is for providers that use API key or access key for authentication Connection created -
    Schema
      schema_mappings_config object
      +
      Schema
        schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
    +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-destination.api.mdx b/docs/docs/api/v2/mgmt/create-destination.api.mdx deleted file mode 100644 index 1198cb760e..0000000000 --- a/docs/docs/api/v2/mgmt/create-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-destination -title: "Create destination" -description: "Create destination" -sidebar_label: "Create destination" -hide_title: true -hide_table_of_contents: true -api: eJztWW1v2zYQ/iua9mUFTDmW7dgOhqFNGwxBlzVL2w1FYrgUSdlMJUoTKTuu4f++IynJktPYSRYMHRAbSCzyyHt77nhHrdwkZRlWPBGn1D1yScawYm+YVFyYUbflKjyV7tGlWxuV7rjlSkbyjKslzK3cG4RTjr4w/TRew2yKMxwzxTK9Fp4z9ncOGxwnFEhW5pFnDHiqLGctlyRCMaH0FE7TiBPDp30tQQQYk2TGYqx/JYK9Cw1LtUwZiJwE14woLSdXkR5IE6mmGZMwlGZaPcXh4ahcUC2UKuNiClRM5LFWUOYpnkY508qxGxynZrtqdL1u1cS+tNuM161HSCLANN+UpOJ6tnTOi9VO3R0gwz41Kq4NNarRtTF2yKe1PSrJm2LOYM1uMYGe5kRLhmiABFt4JMoleB0ROhMiVyIi6trLJVqAEsj3Mio9HOOvicAL6ZEk1vKkSVbnA3oELKvz6fe6PtBRrHCA5R7TlZpOtHATGmgOG/zsWJcHgDtNnUtgv5M2XhoavbOMJnFCd3qEcokDWNdycRQlC2NnFhoVC0A1fVXSa9NgKRdJRveJI5mQXPE5qxZsw9U4s7B1zZSVbQq1ayzHt5E8sdCZ5ELi8HZIGFwXCK1gtjNEAj6FvJAtHxcix3z6h1790BCpuDbMXo0+IETgSY9P+F4PoSlJUUGOgLzAs2R7QixeTkrBJuUCLSCYHBImx5HcLyWJONBOwM08uj83gMOcEzbBhCS5UC9hrpDf4zj2psV8MV0Fc8bncIZMzFmwixXSn+OTX09/d84vTv989eHEeXvyyYxeXYmz01PP824hrKFJk9l4m7bmm42tm5Yb30bik0M8TsQ0gTT0KISf6cVvjh8K8JJnA9/l4JOeAADsIuV7X7udBYmvvYKPJyxS75e1N/s8NAM/eYqs5cYdKbHQ8nFwqe1jS64JrTt4bbeRKZRa1hH+QUf/AyqS8dRQHdUrMsduQ90HlFKVcVauTl+uTwjrY0YRG4YE9TqBj4IwPESHlAakE45G/rCvz7DNpibtuazv+8NDMkLdg+4Q9ULsI+wHQ9RlZDToj6h/QDT6Ld7vrGxKUNerpg1MLRCfot4oyw1dU9TBebtu2JQNZW1QArNCH7hpf0FaVZDb0bXv0KC9fh+sF6DwkIJDAtJFOOj0UNAL/Q7pBb1ht68jYNsju/Yc+IdhMBgNER32e6hH+iM0wn4X9Qesy/xw0GWY3SfD7CuWW+4can9uMdcs7LZjxOTnLR2qkCl3eVyh/T1b+LkJeG4C7tMEPK6O31G824PqXwfoN4+2ewbsnWX/vuBiw+GQMBoiNqIHqOeTPhr1hn3k04E/GsLZw0L/oQE76g98ejCEJNAZhag3JARhOOxQhwWDg26HdsNDfO+AfW5JvreWZFcH8cQ9w3cQWXd1G//7wDKd0HMfdNchdL9W5u7+5b+Cbk2C7ZZH26jR37w2PY1DG11CzNQsocWxZnozNYOnNq1fT+vb6WxuL59Xbp5BinFnSqXyqN3GKffKOtXjSTuexqo9991t7u8LGufV+am7rl14v9cHrcVF7dq7sheMvGXLTcOzoWm5XG88Y5iac7/JD9g4QOWoxDEVAug9Z5FGoTRj0J1J+DUrBAJr6ZbuYnOvfrLp50q81MpxLsJET1UOdg+8zqE3quWOMyzwFFQTyrCwrSQmanNbURlFY9CmbpcmRL6sDGpbrKbFG5O3vPwjfJxToaoq8gq+f7EIiJlWXGvclMwBlrl+MN72nE9J7hAsHIA4UHNpaGBlbFY5BMIJ9socDo3x1L7tkA4W1AH9BDM8pae5Xv5weZELoDN1Nywf/1TqkOXCS2FMaMgEuVLAWM6nLzYUi8XCS+0yrWildXuRZF9kigmrhpAtM9vJXJ9XbPFCMzd2OIZgNeJ/vPhND37+/PlK7EFuQWWLaMO/5rBvxlDDARVaFLtR7TTC3GxlXLgqwuvSpVtvf2xGvHRXK51fPmbReq2HbbVi3vjMccZNBavfCLVK1Ot4NPHivrb3FOhD0ehhDauj23cW+rSzK15BCKRqJ+24liDO373/AMRB8crJFuhuhnXtrf8euVfwhYcktWrp91J6fOVGWExzwA7Q2H11uOFcm6Ie5zaoix+1KwAsljUp6wnAKqL/1g7xJvnP2v2QQX6pyO3MnQuqfGKptfugrln/A5fXhX4= -sidebar_class_name: "post api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Create destination

    - - - - - - - -Create destination - -## Request - -

    Body

    required
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - -Destination created - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-entity.api.mdx b/docs/docs/api/v2/mgmt/create-entity.api.mdx index 6172a45cc3..48849a3ecc 100644 --- a/docs/docs/api/v2/mgmt/create-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/create-entity.api.mdx @@ -5,7 +5,7 @@ description: "Create entity" sidebar_label: "Create entity" hide_title: true hide_table_of_contents: true -api: eJztVltv2zYU/isa+7IClp04hm8YhrVFH4JtaJC0GArHcCjq2GYrkRxJ2TEM/fedQ1q2cmmzhwJ7mQ3Y0rlfvnPIPcvBWBDcQ86m3lbQYdqA5V5qdYkkJiwg873y0u9Yh3m+cmw6Y4EgwbF5hzkQlSX2dLZn9yk3Mv0K9DavkWu45SV4sKSH7xb+rsD5tzpHkX14lfbkXWjlQXlicWMKKUIovS9OK6I5sYaS05PfGcD4dPYFhMfIjKXAQ0zIVeizJeW8lWqFUnDPS1MQqdylELOqg9elXL1sdimhyF1LjlvLqS7SQ+l+RFjc6KLgi6W0zi+CeF13WlWaRRtzovKi0NsFz3NJNeLFIoS3KLFwaLYdTqZ1AVw9sXXI52VT2DisVYgwVm1xKNmz0R0L2lKLQFpUJqe/pvR11HdGKxdL1D87p78cnLDSUDSoHPGXRBs5+2Ewkfn3uzEcTLJzGEzS/qjfTwdDfpHyEYzS8zPBOYzGfHCxJPy0Yli8ZDMfC8gulst0nI2W6WDJR2k2ziEdDyb9SX85FHw4IZv/Q/g/grAkgD3qaOfbwG5BGQ09xO27ANgEmvWJi3Ctaa0a7UJpuV/jWw+adUrb1G7istyzyhbIXXtv3LTXw8XadZXhq6KCrtS9clX63qbPHju9Ocgkb64uWd1a0Dc0FbGLrTV9AoKRv8OuSXXakkFwkOE18BzsE3/oJkGpxOsk9CDJYQMFYcYFmhDg8Gl9CAiLRGN6fToH3jfQadDVQnYb2A10Z0e5Z6A2/xegoqOG4pBqqckwFTzmctY9H3Yn7NTdP7niK6ya8iH6uHm48K1gm3rTEJRcUstyLdxvx14JXSLvYTMfMJ/g5hV+kkvlrc4rQbRb/P4FBQoD1ZSK+TCyBF1W9BIg200+6yoRXCWVQ4W1dEEGNcuglYjKebRlE4l7dBXPe5dwlSeYn4Lg03XJ6+yn2XWlUC65Qsyi+vznJgdbqa5BmiI0ZpX36NhtVq9PEtvttmuiGiV6zLq31farM1zAkZSaKsOJ62lsxkbC9jU5D3V4y12ATvLp+g8i3t3d3aoXhuIgRZU9+G817PFUPqj9cRw83PueKbgMVkL39oeBnTFo3X/WNMtI2+8zjPSTLeqayAhvu4t3ng23kmeEJ7wTdZo5IhyHCWTv4mmWfiTPJE5omj492epOo/EGh8r478rOW+vm6sPNRxTODpeuUuekY/kWifQ7Zbf4ZXT5C50PNzOi71nB1apCyKBMtBvWdkVlaG+OuCYOD5RZw1K7VpTtlRIToV9K61nxX6jruJN+PYpHzjcVjhsqSlPr8Jip/wGeUsQn +api: {"deprecated":true,"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,9 +38,9 @@ Create entity ## Request -

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Entity created -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx index d7836375ad..0637d836e8 100644 --- a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx +++ b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Create magic link" sidebar_label: "Create magic link" hide_title: true hide_table_of_contents: true -api: eJztV91v2zYQ/1c07WUFLFv+iO0Ew7C26EOxFg2SFMOWGipFnWw2EqmRlB3X0P++O9KK5Xw0fejDHhYHMnW84x3v7vcjvQtVBZpZoeTbLDwLuQZm4T1bCv5OyJuwF1q2NOHZdehkAQlNuOiFBnithd3i1C68jVglohugt0WDsxXTrAQLmkzxXcM/NRj7SmWosnOvQgM6tLqGXsiVtCAtTbGqKgR3AQ2+GCVJZvgKSkYju60Ao1TpF+AWg6s0hW8FGJrltbGqBJ2IrKNsrBZyicpwy8qqIFG5jVrdaBg2bp21yNBSYtiP2sq6pCys6tRUilwbVoDJleZAcYgKMi3WNP4KMgNzkxgoCnwtTZJtcVnBTTKeniTOjtTUSiVclzjkrDJ1QbaqtlgAvsLhUjnHrFJFoVp/hcrJt8B0aa7IthASmKZFCvxOBU1PDUhDy5VM34BVR9EmXojbSnih6ixhnKta2gTkki2hpDqgfsH4DdX5kLTD1q2wTnKctYbKbGstk1oXj+UQs8K1qKi0KP548S6wKsAuwE7glsYsx20FdgUBNoREIWoGwgSstiulxVfI+kdlXFlbmbPBAHumX27piTkZHGzNYDgaT06mFBrcVsL3ORaGm058WNkUdHfh4TyO46bpdfr0+qi57jfMw+WPcrE4pMzjC2uAYEoKQljTeE+YWyyaC2wUD+nrOF9vJK6xDfwCFMIPAs1zWAE+iueTeB5l6eg0mszikygdn0I0ycbjeBanE8hdgo1ltjbfXqsNvul1Q34WrtmcQzrO82iezvJokrNZlM4ziOaT09HpKJ9yNj2lNX8A/p+znM5mOc85i3g+x2yM57OIDXE0G/L5/CSF6Szl/xPKDyOU72KSKyQMB6iAABUgsTxNE3ufLVFYxm2XJf7rBAYmYfax0LASJc2EGQIssmJPSq2jUTwaR/EoGo2v4vjM/f8d3mc4R2x7GD8AaO8pAnyaDn2wvohP8eE9ImzuJ/m1Y4xOeakJAbNJl5VKGcdnzK7wbXBYi+I3oNf+/rHzbdTJtuibumLLooa+UINyWdrBevSgwJd7neDl+duw6dx5LolaPXt2bj53RUHJHyjohR77HR0CGgUCLHMnzrE/dBOglmskhOgmyGANBXG1cTLOwRjXXS4gzBVx/cXhavWmrfe9q9A9vnvATh0kdgHw/e35yPHqz1DacK4oIKqF32bcH077px3Uv2dyzxNuY/5kQ2CS2T7AthTkqWSCgssUN7/fldFz13HYR5MPOutn/AveSqtVVrvdfMLPn1CgMlC6Kc/HkQXosqYXt89+8JeqA85kUBs0WCHMSQctS2cVtBkPiFyXPjlIBTLrkIPpk9frn64vaiQKGZxjR6P54pd2D7qW/Qplkho1ra1Fx2a9fHHQ2Gw2/cqbufK0ux5slL4xFeNwJ4qqOkVMDxQWYy1g84Kcuzy8YsZ1FZEnCT9//vxJPoOXvZY77bz/TsEew+1R/u/QYuHWDqqCCdkhfA/p67ALaQTgigCP4t0uxYA/6qJpSIwA0Fv/Q2PNtGAptRX+EOm1SCMOcBgNX/tLU3RFzkmdmurs4QWq6bUWLxF2lf2m7qLDSecfLq9QOd3/0ilVRjaabQhc+DwLP+GHTmaXCEciTr4LCyaXNXYO6vh1CeJ0dBxziyeS/YB21k7JbSfKLun4jdCTtvWo+q9UfGSt3+7U/cyTBncc5rWpegsM+F8+0Okl +api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","description":"`new` or `consumed`","example":"new"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z","description":"Any ISO formatted date-time string indicating when the magic link expires."}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,5 +38,5 @@ Create magic link Entity created -
    Schema
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-provider.api.mdx b/docs/docs/api/v2/mgmt/create-provider.api.mdx deleted file mode 100644 index c4551a9399..0000000000 --- a/docs/docs/api/v2/mgmt/create-provider.api.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -id: create-provider -title: "Create provider" -description: "Create provider" -sidebar_label: "Create provider" -hide_title: true -hide_table_of_contents: true -api: eJztWnuP27gR/yqs8kcTwLLXttayF0XRvcMdELTXBMkGRbExFEqibd1KokpSdtyFv3tnSD0oP9ZOcIeihfPY2ORwXpwZ/obhs8MLJqhKeP42du6cSDCq2HvB10nMhNNzFF1K5+7RqYekM+85kkWlSNQWJp6dry4tEveJ4bf5DmYLKmjGFNLCSM8R7F8lk+oHHgPJs/6aCAbSlChZz4l4rliucIoWRZpEWpvBr5LnOCajFcsofuI5e7fQItW2YKAsD39lkUIlE5UyrX0G3wqBNqmESc2zVKvALGgWSiWSfAmkLC8ztI4j1ciZ77Q6i2RpETdSYiYjkRSoHQzf58TMELWiikjFBZPknWY0uH//loBHBjSKmJT4kQiWgmdjAh6OwdyEprJ/oGxReTkATwRJfFTlrzQrtLXZtiYDtUvJgozmdMniQFtjrQ05TxnND0x4AP/fEVhJPpYFXaYl+yNYcA+LibUTHY3Jz/ATFn2CRWrFSKVwfGaZrTfuOii8r2Tj5q5HNFkgIxiTFjUVgm6BOFEsk4du2lnyHjEs+oa97GO0UfwAgR4Dg+5cVtAcBB+bjBkacmSCb3II9eP8KlkbSBZ2UtixWSPNzOiobJ15qc+iNIEVZ6PIH8/G4S313Fs2unG9iTd1pz5duKEfjma+Pxsv4qFT71fNFAqAYOplxjNvGE69CXVv6TRyvWk4dcMbNnRheBJ7YeQthtTZ7XpWQXg8UP243PnxZVWUdL11QLufY3Uozu06glUwaCirmoBeMPtzvjw8rBJJ4M+CC7JIWBqTDOSBjyTZrFhOtrwkMVWUZDxmKSQhTJHHd4b9/PVKqULeDQYxj2RfVtmJMTMooIwA02xQqTLgaybWCdu86ZMHyMg9Ya/pEyWPH3UR/T6+r0wFlm/ekBUTjFD4K5ki4RaN6OkyELM1SzEEe4TmsR5qNMCasNV+oGmKSwSJSiiXGWbNQeyCKpkp/Gcy/UTs53D0vByXUJN5CecN7Kax7ESKdPfz7QKN7pFNAkbIbR6hkdKYCeVPex02PFdcWy/oJtDbG/G0zHKYIDSOE10YKxJjaXWI9AkIyLmyhCyYilbaZxVzigHVKaXOeDSF5ArH7nTs3bpeeDNyw8lk6DI2HIfewp9MbyYHOaZdpNNCKtgtKuLf0933F7rbqki+z+h0NHFvfX/iemPPd2csYq7nh2E49KMojr2TRu3aLK5zFcsnpPOSi+1LGADBA5bakyZVdKsylAVHV0iaMgmBHWH1LhKIA5Gs8fO/WQ7R8wTlKk3hayaDeAtsk0gG48ltoNchGV/xwGCWiBayBK2tItRUH1RIk+3b3EKbBrZYpvZqn/ROAyaWLwExZAi/rrjpipuuuOmKm6646Yqbrrjpipsuxk0WhrgEPvFSQZWIVjBEC56mvAZSKV+o0/jHkvLbw6CcE4v+O3AQLZIAb8DmF/osB9xXk13iNMgPJiDwYWjJ9Uya5IyK0/6yJZx2mL6vO1G9YZlZCGg3l8YZo5sh/tNN8fpqkBgGsfMNd3ovZ8m5iL+JvCicDRcuG89GcAYvbt3pbOy5Q9+bTcb+cDEbjzCMLR3OZtHIH7Nh5N+6YzhuIYtm1J2FU+ZGExp5N368mI3ot7QUvS7IZrlIolX1JaPiiSlYE8CW8EwriAFrR4etm+HX7Fezv71vQuu9Nlxt5tXsf7sD6tkVogr2I4WiZ+dElQzABPC6CBOcnkgGUds4mXe0DVrPRykv46A63ILOXsmURk9dJ7WmH00759oIXRuhayN0bYSujdC1Ebo2Qv8/jRAWA7UN6pg8Yu/p7DVsBpcn8U8oDPxzUbaxing/jY9LNdmsBWzJL9Xo98l5ZXziVrx/r+y+MI6qDToXGhpJ0qA6WNuCfF7AOXDdpEIHLzajL8HqhvrHWq292KyaWxOibXzWzINKZVilt/ulMP02d2p252sbxhsqR/hCb64JuiQ322lhuv6xzVgkQqoGPpt6+NtIrgMJUKlaJSJ2Cyog7puGVQGuJa9Zf9knH5ve4E1XyZ9Ru79r5fZ2peOjPcXn9v+xtGT1zji7E8yS+GhL3y0/h6s1Ctnrcjt3IPYdyX4YdRr+3b6Hf9RQhhTtk6CMqRXHx0IFlzpyKOJwZ1A0T4TwhZBYmwdAz04pUuycqhIDvWdbYRI+yJaZGqxHBztbdxQEWiFnZz060lDERKn19KgN9CL5K2uufe4sGmwZURHA2dqOvXbMdFx4uEIh4pu2aEk9ZhoxjDGtEPgJbzM+tG+bfqpDpnNn1DbdbV940KRZndjRRsw8lGoanm5L87/fnhx0Jwf9x2VNxoke49JGoovOaxz5WGOUBvd1cMiFCGpuY6WW5f1Rlpfhl+5dY3U3VPGtryl2GPMLjvZgOppIv+kPJ/2ZdYXxi442vPTQsW2u76g5FCuGdTZiacxoggmNWOEvNlbA2O2kemfyoLC8gl/kba4Ej8sIxz7D73+wFIhZDXG7mhEQWeIXc5aQfwJ6imiuLyAUAi6kgZUme5rqj6CaLc0jR6kBCNiXMy1T9lHq4x8eP5QaY7+HkgbLW0QkyrxfwFiOtSoslQLBcr1801JsNpt+YZZpxFRbPdhw8SQLGrFmyC3KEEp0C9VQuPbDD1TqwkI+ffgbDn758uVzfqZkVlTo2Uq+tWGHZbvj/aZcKvZVIchLNB+9f89VRW87Xf3oc4XVHgafn0NQ9pNIdzschvontuah55qKhIb6ygSDsyq0GO66RGt4A7vnPphzaE0xoO4Ob4jxqt6sgPxghXqRdm4dSO/ffXwA4rB6aYqgGkahlYJB/HnnfIbfWCe0G3Se6/FnJ6X5soSoARrDd1fdqnaPFnOOVB+sp6g031pa2meOMQR/Wv8D0SX/E248HFp/bsjNzMkFzRFmqHHvsHP5D9ZSKMo= -sidebar_class_name: "post api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Create provider

    - - - - - - - -Create provider - -## Request - -

    Body

    required
      oneOf
      config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
    - -Provider created - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-schema.api.mdx b/docs/docs/api/v2/mgmt/create-schema.api.mdx index ee0540e41b..ede54c094c 100644 --- a/docs/docs/api/v2/mgmt/create-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/create-schema.api.mdx @@ -5,7 +5,7 @@ description: "Create schema" sidebar_label: "Create schema" hide_title: true hide_table_of_contents: true -api: eJztV21v2zYQ/iuc9mUFLDlxjDg2hmFt0QHB1i1IUgyDEzgUdbLZSiJHUnYMw/99d5Rk03mpv/TLgMaBLR4f8l6fI7WJMtAGBHeQRRNnauhFSoPhTqrqEkWRMICTN2IBJY96keNzG02mUSOw0X0vsiBqI90axZvoMeZaxl+ARvdbnNXc8BIcGFqGYwP/1mDdO5UhZOOH0uyVC1U5qBxNca0LKbwl/c9WVSSzjR345NYa0DyVfgbh0DBtyG4nwdJshToDlHVGVnNEwSMvdUGich23m2291lzOj2+bSygyG+C4MXyNMOmgtN/CLK5VUfBZLo11Mw/vYYqsMFJTIBDxj6oNC2LDvFGMsAn5UuIcZLPjqn4jHX++pOJ2Ae2ua1ImautUCYbh1jZhtwtpGf5zdmXUUmZgYqtBSFyRhcawD8k8YTstLFeG3fACLD4IsnXbC9I/bYJzT1JeFGo141kmySBezPyuM/IMnQjjnCpVAK+eeXDTGmTZagFugbYfeiJ4xXB/VsHqlVjaJAxWzgsLTw1uq+G4vVj2Tjof9KbmZm3BvRiCXTkGyxoWzmqd0U9XuNtmvdWqsk2BDU5O6edJMDycNXtk0Tcjmcy+XmDnw3F6CsNxPBgNBvHwnJ/FfASj+PREcA6jCz48y6liAxtmx/bMLgSkZ3keX6SjPB7mfBSnFxnEF8PxYDzIzwU/H9Oe3xvA9wbwP2wAkuj5hA+919tC0Ai2TyPw3tOd2e7kxkN4oehE18r6wuRugaO+bU9yOsjNsjmnN1FtCpxcOKftpN/HMz2xtebzooZEqn45L11/OXge9RbD3l5dRtvgbuBbUEOB4IawZ5GWv8O683QSYJBZtPECOJbZM32ohiGKOcV8ClgGSyiIcNbLhACLT4vWIIwR9bjr/RXkQ5ffjppBWwi7Qsf76Q73Ek8PmBfQiyJxtKR3FSarXJFOykXj5klyep6Mo33eP/KKzzGglfOONR2dCxf40aWCirjkkrKZKWF/3aVRqBLnDvN8MPmson7EP3ZZOaOyWpDsDj9/Q4FgoHBTnA8tY6iypoEv5oRh6/LMqy0uoC5CGFxZ+lV7dko8n+bNJRTbTJUx9K8Cr9MmpHX6w/S6rhDHrrCacfn9T50Ppq4SjbKKCjWtnUPFdjl/s0esVqtEN8vI0Z3X/ZUyX6zmAnaiWNcpcrGvMBlLCas3pNzH4R23vqrYp+s/SPjw8HBXHeFLi6LItvqDhD3l60Hsd0xx8Oj6uuDS7+Kzt2mpPI3s/lK+IJKjaLNJ0dBPpthuSYyFb9bNRXzJjeQplRNe1Hsdw6jCPTej980lIb4lxQSnYpo8vzBse92Kt0g37b6KvQ/60NVfN7cITts3gVJltMbwFQrpexLd4SeiFxKfeP+6QPJNVPBqXmPFIKbZ1x8aNUUh7ClNA2kfyLNuqloHVobNpnGEvsmtF+E/U9KxW/2ygzczry7Y9a4GTZnDQ277Hxdzq3A= +api: {"deprecated":true,"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,9 +38,9 @@ Create schema ## Request -

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Schema created -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx b/docs/docs/api/v2/mgmt/create-sync-config.api.mdx index 33129731ba..d331ed1d44 100644 --- a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/create-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Create Sync Config" sidebar_label: "Create Sync Config" hide_title: true hide_table_of_contents: true -api: eJztWNuO2zYQ/RVWfckCK1/ku1EUTdI+LJqii2yCorANhyIpm4lEqiRlxzD8752hZFu+bHZRBOjL2sCuRQ7nwjlzhtQ20Lkw1Emt7ngwDpgR1ImHjWJvtUrkIrgNHF3YYDwJjoM2mN0GVrDCSLeBqW3wNaS5DL8IfJrtYDanhmbCCYNL4dmIfwph3RvNQWTrH6URYNGZQtwGTCsnlMMpmuepZN6j5merFY5ZthQZxV9ukwtwU8efBXPgXG7QfyeFxVkOJqTya+eS1+StM1JhMOIrzfIUh/piEFM6HIbDLudhl8csHLUiGra7vShi0WjYFXGw8xZWkgvzpMJBMogEaw1C0WPtsDtIeDhkSS8Ugzbn7c5w0KEJKmTlxj4jmIQWqZs/Lg/hMiNzDBeGy9wUZTKJ9sOWJNqQabDU62lAnCYWkti4MAU/pebzzNasSMjIQhiQzaSSWZEF434LPrWQq+dTNz4sBSn1kVdSkUymqQSsaMXtDXpgCkUcyJSewH7AVgLkFpuru6vQ7iRIijTFVYpIBRDNACs0hXk/rlW6QUSe+jGdTq8vwwmyBre8K5R4IfQGFHnPEmmsw8nbi7VezjbIQTna/qZCsRJmgxM+Vlo4PbeOGjcHiMKmKMikLEFexR5rnQqqLtJ7lxBfK4fNK016ZQT1ZpB4RtN0Q9boNYodDRBpSVnbvDFVv5bQGnuNUxXsdre1kpzU8FBLz8xjN8vA8RKB+5KrOfmaQLId0Ql5KHK6SAtBKllMfVw6Di4grZThUmPoBh6lEyfwe6QoquErULlE4ZkLRAEjnVQssg4FbefhV0ZmO49Oqjg1/DkxM2pFaIWy0smVIPcVc/yPW3Dmgt8C8gr9JAc/b0725O0z9gRKQe69+W8xeA2bJym1Q4dRtzVKQjYaJsDRUS+MYz4MO51Oj4tO0o4Yu/D0qBucPZs741QgDZD1pjAr1fCcU0cv1J71ltPGcGD1msay3OZFzvFfTT+oLpXbHBi63JCo1b5E1rHj7ms3+G6t8qmt7/Z7CWfxIIz6cTeEJLTC4ajLwv6A0bjbbkVR7NtjzYcn0znqDSLeGsZh0oacdoeMhXQ0isK2iAetTpt3kj5FnS9t/KWNv7Txlzb+0sZf2vj3buO+WZ81rYuO83RzP2/nuwsa91VKsIWTw1UabsRLjdfsXFu/m9Qt4alZ0+ZrVZhVeXPeBoVJQWLpXG7HzSbcshu2qoeG1M1skbnmKroAzaFmXt/fBbvabf0Bjwdl8mp39mP+c/m7QAD4IhvXZAATqHgpKPfd5Kx47u8ISGFpAHXpNeFAmClCxZcLZUxY67nMOwS7heeV98eXAr/twXJ5iX9eiz/r8M9r4/Uuftmna+20apHHHvdoK3u8NSBJX+HeyZEKjkw2u8ZYdcm3NcljHU9OSvKZdee5QKpEY8yIuzKlrUa73xgFR8j/QRVd+EB9Em8P3sKyCi572GH1Z1Qicrlm9pcDZCF4mDvF9MnkRR39CB9yp5zRvPAbOYXvXyIFYYHQQkydekbAZOHzgeIN8rcugNIVKYAt3RIaKMrAysyvIqyw0HSBW/1JqTx2WQJ7X2u7toFWJz9M3heYb3IP5QvLZ6/2MeDBIIcxhUUZF86BYbta3Bwl1ut1Iy+XYaCHqJtrbb7YnDJxGArzIgZ6ampIxkqK9Q0a9/vwBhkf3f/4/h0Ofvr0aaqe4IZKyp+BS/u1hF1lqZMEHKjBia+umadUelU+hduKwCbBCYEBJJfIbzC+3cbg8keT7nY4DOVuNuULwRU1ksYIrAmeSCpeQQR7RvIAhxyGH9A6iiOsxpdXnt3tfsVrIJncfVN2VqPg+z8fPoBwXL2RzDTHNYauYRD/wtETvvBQHcH9a0sc3wYpVYsCsAMypd5deSZcnjJpSZvVD4xsP6U2NS/rFFsGgn8xrKviP2H6gaN/PoiXM48uODB2KY3pw4b6L9ubiko= +api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}]}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -46,7 +46,7 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    • SyncConfig created @@ -62,5 +62,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx index bffe5d08f7..cdeaaeccdb 100644 --- a/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection sync config" sidebar_label: "Delete connection sync config" hide_title: true hide_table_of_contents: true -api: eJytVOtLG0EQ/1e22y8KeaiUQqWUPvSD1IL4oJQYdN2bJIt3u+s+Lgnh/vfO7F2SS6IVpBESd+Y3M795Lrix4ERQRp9l/JhnkEOAH0ZrkCS8mmuJr5Ea8w4PYuz58YA/p/Z82OEeZHQqzBG04LOusKr7CPQaVqh14K3RHtDHgh8dfKCfDLx0ypIvjL52zMgzayJXVWcLeJJoMrnGe8LLJVMrnCgQ4XyiovGBVrOujD6YAlxXZYhS5GoCIgOHLy8nUAgiFeaW4D44pckbzERhcxIV87WLQ75D63qCnBo9OzthYSICi1o9RcjnTGWggxop8KhoAZVmcxMdE9bmSqZecKrWU1QOsCnBRag6rSysMyU6c90keUseXuTgR8ZJeD6JZQTWRNgig83E6k7MemJSzcME3/11U+6oKXeymQ8aD1cuWxJdTqRDsP6438dJ6floxTiP0FOmX4yL0C+P+Da3qwbDvl2c8ao1cVeUdD1ZrblblQAlP1HQWddwidmu3mY8DMMQxYJhIs/NlGVQQk4r45NMSvB1NxOhiryNDAWmRGsfB73Dj71PtD4qpOL/ElqMka0OyarDsUJByEBmDb9lntS0QigqVWak/7qqkTQF6jaLuKHcaet7/LAzHZzJYurOLf79hhzBQLlQEpvMGIaM9Egj2WN/TGRSaBY9GkyUTxi0LJJVe54DjOub4pnQWWtNfY+iDt4NLqOmub8wPqD5cG+Zg4u6Z1GmaQoeYggY2Jfj/TViOp32bG1Gia6y7k+Ne/RWSFiJujY+4Eb1DTajVDDdp+CpDt+FTy1jN5fnJLy/v7/Vrwxjg6LKNvFbDXvtIG30YjWWAWahb3OhktfUzUWzRwP+0h7h1E8wPkEWiwdM5MblVUViPDMuXdsOL4VT4oHGDW9vZznetHiZ8qTA1R2J3MMONRpG7Dmy27tstn6f/c/D9mzuaV13DnQpaAeOOafz92bi28fsnwS2b+uaQvvonZyen16folpEalb7ztRHpfmHCr5U6XnLXfsA1aHpm9J8Fv6ZZhUv2JcVvNa8aLC6ZzWachxWVfUX4KnAYw== +api: {"operationId":"deleteConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Connection Sync Config"}},"description":"Delete connection sync config","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"delete","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/delete-connection.api.mdx b/docs/docs/api/v2/mgmt/delete-connection.api.mdx index 08ee11bfe0..9e1fb4548d 100644 --- a/docs/docs/api/v2/mgmt/delete-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-connection.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection" sidebar_label: "Delete connection" hide_title: true hide_table_of_contents: true -api: eJy9VNtq20AQ/ZXt9iUBW0pDKdSU0rTJQ2gKIWkoxTHNWppYS6TdzV7sGKN/78xKlqXEpQ+F2mBLcz1nbhuuDVjhpVbnOZ/wHErw8EUrBRkJ+Yh7sXB8MuU7oeOzEXeQBSv9GlUb/jQWRo4fgN5mNWotOIOGgJ4bfnz0lv5ycJmVJoad8BPFoDJ+zeY6XzPpmAUfrIKcacVcyDJw7j6ULCJCl4TX9ehZjNOIlmV9uEZYUaHUuohM4QtaZsF5XYH9JXO0keRshC84IX0M0gKS9zYA8soKqATh9WtDrs5bqRaUfRetS/gv8bBMCLTQu7pH+BhlwtMtYJduetjrdJeaNH0cNaem2OWWebAlBiq8N26SptifxAUjFmWAROq0WlQ+XR7z5yW9bm3YyeU5r3t9viYeTT973e5YoeQrCkbbEu1s2vIUIHKwL/JhGoZWzGsmylKvsN9LKGkoXZTFOWC+aAHVFO1eU2Ii2sQ4St68S97TqEpfUvJvQokFolU+eo2oYV5kntxafFueqMT2SCpVrjP3qatRpivUDYs4UL6Yxtf4YefKW52H2JRb/P6AEo2BuBCJITKGKQO9xAVM2E8dWCYUCw4dCtwJskHPKnqx7SAwqTwsmq11TKi8twEuoazTV9OroNCOXWrn0X12sOVgg0oMyhRNwTx4j4ndcnG4s1itVolp3IhoxzpdafvgjMigE41NmJcySzU2YylhdUjJYx0+Cxdbxm6uLkh4d3d3q/4yjK0VVbbN32vYvl0f1L8bRQ9PPjWlkDFS7OCm3atpdwgcuk+GV6FXxKgcLDluQoGYKMRmM0dyN7asaxI/BrDx7o34Ulgp5jSCuH+5dPSM230vSgcv0NJMYusR8MFVezMOGQ3xPhbbLVO0T0tBgzvh+BiXcHDd6Ez9z9SDKtWzunfUTs8uzr6foakIVPz+rWgOQ/tA1dqbpX9EmnT0Swz3mn+gecMr9LEzbzR/dOhuUmNNfGd1Xf8GN+1wjA== +api: {"operationId":"deleteConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"An empty body is returned on successful deletion."}},"description":"Delete connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/delete-customer.api.mdx b/docs/docs/api/v2/mgmt/delete-customer.api.mdx index 5fd4cad5ea..13c4398cf0 100644 --- a/docs/docs/api/v2/mgmt/delete-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-customer.api.mdx @@ -5,7 +5,7 @@ description: "Delete customer" sidebar_label: "Delete customer" hide_title: true hide_table_of_contents: true -api: eJzlWOtv2zYQ/1c49cMaILITJ/EjGIZ2bQoEa7eiDwxDGqi0dLLZSKJKUk49w//77kg97TjxsmH7sPQRW7rH7453P/K48mQOihshs8vIO/ciSMDAi0IbmYLyDj3DZ9o7v/KqR9q7PvQ0hIUSZokvVt43n+fCvwH6dr3Gtwp0LjMNqLfyBkdH9CsCHSqRkx/00rIfysxAZkiG53kiQoul/0WT4MrT4RxSTp/MMgdUldMvEBpUzBUhN8K5aekGImrJa6NENkN5+MbTPKFH0TiE6Ukc++PpKPZPYz7yp+MI/PHpZDAZxMOQDyfeGqGVKB80uJSF8itp7ReZ+FqA34LkowU0mPEU7rf0ZvlCpjnPluwyC0kFgxfJ/TqUQR6aZ+kydLo9/G3xyyzDXKF/3bLAleJLNCAMpPrhxD4UO4zHmM4o9mESHfmng/DMn5yOz/xBNBpMxphciAcE5j9doHRZL49/TJoY40JEe2gOR6M4jEPuh/F44p+ejEc+P8ZPo+NwPD6bwnA0DTsGd65xVqTUR/Niit1BedY8AR1LFQIlXeQQKbGgz39Ahu1yE2hIEvya6iBaolkR6uBkeBZYPRKTcxmEKqUm4rkuEtKVhVHAwzl+nEnrmOcySWTlL5Ex+RbYdIrK5NBLRAbcdmKCv6eCXg81YP+Sb65uwMgO2sA9xLCCMJFFFPAwlEVmAshmfAYpdTPKJzy8Ia5octmEboSxT7pZoxXlBmZSLe/LoAu54wwyJcJ5+aWBxwtcclty+DjDZFXWO7CcvQpSLbOmLGnDM4y4UA/04NyYXJ/3+1jlvTJM6sJ+2Zu6fzw4OT0bok6XCC9LD+zju9cMs8vMHFjZtxCxqmh7hMZRIWY/z9G9DlAsFrNtcv0wF5rhXzIXC0giVqmw2zlkDNmKRdxwlkpke1ZofMWufrXtr6+fVqFEMtQ9XeR8lhRgg8kTbtBo2ndUoftyAWoh4PaJg6YPeuwD4t9wOgcFjOM/DYZNl+Rf1ZHp0j/FffXKKr6pFJ+/vbwPDu46/cWgn85S0y9yjAh8B8y3APwKwEGPlvdekkNzKfJSGdfjybJ8fG+pvHAlEQSWNyzUek0f77ksDmvufv+WD0hSaVP3HQGAaB/1V6T3i1Vb01b/tRAKIurLDoTrpqMc4qATKSpvaNdxbWTkmgSpSSKuon91hf73y1NbzYok2Xu1rGaG1pf35W03ZTnT/f2Z64KcYZ73oi4ohRvuclgrtigp7G4Q+zOZxbR8JJVprBt/E9b+tVYm/66TDS7NVgPssOLe7t6Fq5b0qmMYrv2uE+5mKdq3pXCrEpsuV4GzWfb7P9mJZXZ2ttJmYQIjmEzGdmFdQYjMLX3rTNv7+038VzxXRfe9xpdCRX7OFdbb2/I8xYyUCXsKvVmPva8Pbge9Pamik6MN4K31aovtJvamHFuqzWgSdLnCa/PO1fWmMRF5W6NEdw7onu03D+atE+bG8e5OcNvRbPkuzbo5rQulbbIaeJvwbDVeVKGuvAVHNrhrlN1vHKp6b2OErCfIHWPixhC15yjrfjZL9qW9O6hrk5LPFYIydGtANwUlwu5yCVLNuaGRpcm0UQUcbk//jx6+6V4Ckcxlc8lh8aHbc69fq/dXLXBrGmNwl6jg2ymgddQXDYkL6ch7Mdhq5PelDO0B3rp1efKegnNl0LpCaXgtFz/DslnXRqbM2Rx4ZLPc9YduGEohBTCOg98ti2ABCVGgts/CELS2lGIB2TEnlrYCUcTZOOodD3uT1lT0hmfltGW1DqtqIrUSXxVnq+Roo3vW3ujwXTeJnZdbBfUEf7CKjZJRYfvxE/75DRIUBoqFgugiY+iyoC+OlNnveGIIeYZbMxBR2o2YNFOrVZcqo3l45q7BNMNdiLXuTnrk9eq7q3dFRvz7VmqD6s12roqsl+OzjKpgWhiDjvVidtBI3N7e9nKnZrf7Kur+rVQ3Ouch1I/8vJhi4dbHkwNybvPwE9d2yWhUpIefP3/+lD1QjKWUvaBw/lsLtt2unezXhWjgm6EDlLB2ylHYdc5V3ct0IXG+QX5zdEkyq9UUsX9UyXpNj7E9lb0rPETOU4JPLdXjFCs0fcYGjXmiYQtOfVPoPX1X8sQBa0a7LsyqiTJql5JaPfxoe6zDQGs6t5S9RDCcxHNsk9y0dLcuJzuM8vLi9cWHC9qbCspLu4ldx5YfyMGd0Nrd7RDQ/+vDHeI/UCEgPfxYi7s3OxVqsnDSlCQ6q/8Jv1CqsA== +api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"],"title":"simple_customer"}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,5 @@ Delete customer Customer -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx b/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx index 8efaf4273f..51698833a7 100644 --- a/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity mapping" sidebar_label: "Delete entity mapping" hide_title: true hide_table_of_contents: true -api: eJytVdtu20YQ/ZXN9iUGRFFxXMPVUx3YD0YSIHASFIVj1KPlSFqE3N3sRbIg8N87s6SudtrCqPQgcq5nZs6M1rJC51FBxEqOo084kNahh6ituSER6WuMeG2ijquP4Jw2MzmQEWZBju/kgTzI+4EMqJInGWnX8tLp97i6THFOr/ctqT0GZ01A8l7L09EZ/1QYlNeOU1LCLqTY5GrbwZHBVUYksLNrtpgceGhI40PObeiFrB8LlUK0DfpCV2SlOcQcoUJPb0HNsQEGEVeOzUP0XTR8hMbVLGpWuxBv5BM4X+YoNnpxcyXiHKJIRv9IWK+ErhjnVGMgxZ6hNmJlkxeEvtYqt1tyd34k7TejaAd7VThvFxTMF1nykjoC1Bim1it8vohNBtFn+CmYrvN/7drpgAZ87PDfQI1Of71QE3VenI9OR8XZ2xEUF2cXWABMQU2gmp4BwWXm0GjndsfIPHDmlSx7PD0TQrneAmy5NegXG04kX3PXYnRhXJbg9DAkB7M64VDbspk1sVycyuPmfO5txOWnG9nucfwzF9hR+bGgaMV3XO2VC5n9FG47xI3N8fgO81EaQVYiWgF1bZeiwgXWvJYhy5TC0NEpA2o52tRyYi60izEavjkf/sabqmNu9EcwMCO0JmavgVTWRFCR3Xp8mzp5QA1oblVlVfh92yNlG9IdNvFA+YRXv9BH3JjobZUUy77R9w+syRi5Fi7iEJmglIlf8k4MxZ82CQVGpEAOcx2yDXk22Wt/oSLOursVBJhKUH0Gc84w5Kx3r+5uk+HF+2RDJPf715safDJDRzLDLJikGClxWMxOdhbL5XLoOjcudFt1ubT+e3CgcCsqXJrQSpeWhrHQuDzh5LkP7yDkkYmvtx9Y+PDw8M38Cxl7K+5sn39vYD+7hAcz2NIx4mMsXQ06R8tTXPc7dCePdoiCjHdrTpSfU3K2W68nVMVXX7cti+nIeT719LgAr2HCXKNFq3TgZ1rXKdQBn0Bi8lF8QvX6tr8aJ4LZ+hzUzToZXpwFMEPHkh7ztu1do/aejPudejGI//OcP1tNh/r4b2lbFt/ZFwM/PuH/COD4H2UHYf/aXl1/uP5yTVfmb3Dx1KY= +api: {"deprecated":true,"operationId":"deleteEntityMapping","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"responses":{"204":{"description":"Entity Mapping"}},"description":"Delete entity mapping","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"method":"delete","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/delete-entity.api.mdx b/docs/docs/api/v2/mgmt/delete-entity.api.mdx index b844bf115a..8f6ee60996 100644 --- a/docs/docs/api/v2/mgmt/delete-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-entity.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity" sidebar_label: "Delete entity" hide_title: true hide_table_of_contents: true -api: eJyFVW1v2zYQ/isa96UBLCtxDL9hGNah+RCsA4p0xTC4gXOSTjZbSWRJyk5g6L/3jpJlOW5nB3Dk43N3z7081F6kqA0m4DAVC2cqHAil0YCTqrwnE53n6PCudNK9iIFwsLZisRTeINGKx4GwmFSGjxfLvXgOQcvwK/Kvx5pODVqtSkvQxV6Mrsf8L0WbGKk5CaXogieqdFg6RoDWuUw8jeiLZdhe2GSDBfCTe9FIjir+gokjR22YtOdDpzLtYawzslwTBp+h0DmbJuN5fIPjeTiajkbheAK3IUxxGt5cJwA4ncH4NhP1oM9hdSlmOkswvs2ycBZPs3CcwTSMZymGs/F8NB9lkwQmc45ZQoH/H6l4CbFpSO07ksn15ZIziXlqezgwBril0mFhL/tfpgVa5TmsMmmsW3l4XfNwv1XS8O4smxiPbIU8V7sVpKnk3kG+8vRWBTWUwvbpxErlCOVZrLaey6FowahXnmHTtVXbstcRaYBnE23H0bX5LBhFqTnQ6b6+85II8LC2GgyFcWisV0DTywMdn0aymwa3EX1SjdzOtrptfs3iobAbdZShT0ZRFiLCVoDRvktUC9ai2R6IVCYn5MY5bRdRRLIc2krDOq9wKFVUrAsXbUfidXUfW0zw9sO9qHvy/shEm3Xpify4cVr+hS+Hni56mLb+DUKK5iwfpQkIFTgV+GEHKW4x5+W03pYkaOlp0xKqOVqmODEX2sS4Ht5MhnNxHN/fUMKa2JbOezVXCyTuuOtdnbzlBUhuVaoS+0fXo0QVdHbaxJPDs8X4lT7BfemMSquEbZ/p71/MCYxcCxdxyiyglBX/8Ds5DP5TVZBAGVSWHDbSegx5Ft4rSCrrKJYJJF2U6+aWtgGUaUD1lehz2iFnXf6yfKhKwgUflHXk/vjmUIOpyqEmW8lbEFfOUWK7XV8dEbvdbqgbNy60qzraKfPVakiwM4W6iklSkaJhbCXurji578OfYP3Igk8P79n49PT0ubywjC2KO9vm7w3stexOet+tocNnF+kcpI/ip7dvRbMUB9GQ9+KoT9rxDWVjwH4fE+1PJq9rNn+r0PgX2UBswUiIeblIWam0/EzCzCC3eMale5GJNw+t3K8CXs8fcTzop+SitsAruRD06OXVu0bqRwK3ImISzflb0od2Pc+zN+fJPfLu7v3dP3d8FVbckr56G6m2D5zgh8T6sm4Y8Hc9+An8N94Auhd+7+DNyU8duluiQXOL6J1SfwdATPXe +api: {"deprecated":true,"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Delete entity Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx b/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx index 6a06aa23e4..649d69c687 100644 --- a/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Delete magic link" sidebar_label: "Delete magic link" hide_title: true hide_table_of_contents: true -api: eJyFVGtP2zAU/Sue9wWkNuloYWs1TdsEH9BAQjA0TaUC13ETi8Q2frRFVf777nXSFw8NJEiuz/U593GyotoIy7zU6jyjI5qJUnhxyXLJL6R6pB3qWe7oaExjjGDQ0UmHOsGDlf4ZjlZ02WVGdh8Fvk1qOLXCGa2cgMwVPeoN8F8mHLfSIBUQba8jDWdG67rzAnQaT0gVsWWjxzDLKohaF6kVvAAyQu4Rci8zQElMN8wXFMU8BWmBYORtECCdF6JiKMk/G0x23kqVA1IsWWVKDJ1MZ8PjwWzYzaas3x3w/qA7PPp83O1/6fcyzqe9Xr8HgqFU0FLobeuiQqAd0XSryaWrPYE1xQba+bqIYEtIKLw3bpSm0MvEBcPyMohE6rTKK5/Oj+jL7ty0GPLj6pzWOzO5wQKb3u9MZlMuRH5BoLPu3RbT9q0QLBP2FR/QEEARrwkrS72Awc1FifvjYoxz4eCpaAXVeNtMIzEW2tzRSz6dJENcK+ljoy+ZYjmoVT5mdSjXyjPuMa3Vt64TB1Qxia3KNHffNz3iuoKz/SbuHb5arI/wQ86VtzoLHGN38PtHlAAWWAsWsa+MAGXAl+iVhPzVgXCmSHCQUEgXMZBZxSzCg/NwlyVSeZE3BnOEqYxAfUpETpcg6/jD+DoowJEr7TykTw7WNdigEgMxhVswDd4DsZvnh1vEYrFITJOGhW6qThfaPjrDuNiEuiZMS8lTDcOYS7E4RPLYh5/MxZGR2+sLDD48PNyp/yxji8LOtvw7A3vLtnv936yiF0ufmpLJeFOc4Kr1z3jH0w4uGO1bHNa9AGLErVZTqODWlnWN4acgbPwQdeicWcmmuGdgskw6fAarzljpxCtJuHgwX1B1cN1+MQ4JbupbUtdWUmiaOcPtHFF4jE578TWqJ/XOZ+L07OLs9xlAWcAyd13ZWLB9QMlvsuzataHDv3XnHfhXnCz4/dsG3py8m7Bxf4PGeid1Xf8DsXIX+w== +api: {"operationId":"deleteMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Magic Link deleted"}},"description":"Delete magic link","parameters":[{"name":"magic_link_id","in":"path","required":true,"schema":{"type":"string","example":"6bf954f9-dba3-4c34-9275-3830dccb0030"}}],"method":"delete","path":"/magic_links/{magic_link_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete magic link","description":{"type":"text/plain"},"url":{"path":["magic_links",":magic_link_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"magic_link_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/delete-provider.api.mdx b/docs/docs/api/v2/mgmt/delete-provider.api.mdx deleted file mode 100644 index 0b3feaf4b6..0000000000 --- a/docs/docs/api/v2/mgmt/delete-provider.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: delete-provider -title: "Delete provider" -description: "Delete provider" -sidebar_label: "Delete provider" -hide_title: true -hide_table_of_contents: true -api: eJy1WHuP27gR/yqs8kezgOWn1rIXRdG0lwOCu+sFeaAo9hYKRVE2byVRR1J2XMPfvTOkJEt+xNtDL49diZz3/GbI0d6TJVfUCFm8S7wHL+EZN/y9khuRcOUNPENX2nt49Jol7T0NPM1ZpYTZwcbe++rTUvjPHN+eDrCruC5loTnw7b3peIy/Eq6ZEiXqAS0d+UwWhhcGaWhZZoJZW0a/aiTce5qteU7xyexKDqwy/pUzA4ylQsuNcGpE0qHRRoliBTT8K83LDJfGLGDxcpL6fLac+sE8vfcXy1ngT8JgOZ+Fk3Q5m3qHQdeG6JbMaTjjExbe+7N4nvjBbEn9ZbzgPptTFozDJF1OKcoEcXwl1e6itKLKMbxM5fZtRVc8x3jgixJsXb/kVD1zAzwRrYzMrYGwXMiolf7Utc3JM8K4t4YGPazMOnJmXDdHItXUw3iICFPbE17vgrCC5t+Us65iwAI6oGnGdSoV45g7UfJEiQ0+/4cXAI7nSPMsQ0d1lOxArGA6ms3vI8uHZHINvlqvGC11lSGvrIzilK3hcSWtYlrKLJONvkymqFsAxBSTyJuJglOLuwx+xwK355oDWtsgy5610THyLJNVElHGZFWYqJcrnVH23A/S0fUmC2WN+shG7WCxn4rVJXD3y+VNQdwOMWtqiDYSSoz8bLMwevP+HYEMjcAurjU+EsUzSHhCmOIJ2CdopodnFdNaA5C/CfV815CB2ZXGqBTgfRJZKHR4YykhsMWZC59UxR8IcJKPVUlXWcX/DB68AWbSKbmexeR7+AlMn4HJrDmpDU5usHXtNqAVDD418koPsWSRZrCmO9RUKbpDFBme6/MwHTr6bB0PnXg9xNZG8QEwmiDkent5SQtQfGkz4ejIhQ25LaADX5ZX69pCX+ZXlV3addrczhOi8hjMl8aMZQI4bqIonC1n8T0N/Hs+HUMTDhb+IqSpH4fxdBmGy1maTLwmX41QOGsUN98WvAwm8SKYU/+eLpgfLOKFH4/5xIfleRLELEgn0IkPeDT9Vgnwr+1xHdMv6326zFajpB+tM9rTGmug+NRpzZBMw6OWsu4JGAWXn9vt4dNaaAL/oF+RVPAsITnogxhpsl3zguxkRRJqKMklHO9QhLBFHn924p9er40p9cNolEimh7quTsTMqIQ2AkLzUW3KSG642gi+vRuST1CRJ8pe02dKHj/aE/v3yX3ljnt9d0fWXHFC4b/mhsQ7dGJg20DCNzxDCA4ILRK71FqAPWFn40CzDFkUYRW0yxyr5gy7YErubhk3Kv0K9q8efi0u67MCs+k8u1Ii/Xy+S9HpAdkKcELvCoZOaucmtD8bdUh4YaT1XtFtZNPLZFblBWwQmiTCNsaaxHlaHyJDAgoKaTpKUm7Y2sasFk4RUL1W6s2mCyiueOYvZsG9H8TjqR/P5xOf88ksDtJwvhjPz2rMhsiWhTaQLaqSPzLcb14Y7k5HCkNOF9O5fx+Gc7jCBaG/5Iz7QRjH8SRkLEmCq04djlXc1CoeBtAMzC5qMHnB3+vV68SMXl7Eb1EZxOdF1cZr4tMyvqzVVbNVsCM/1au/T88rFxO/lv1HVfcLcVQn6BY07E2SRvXBemzItxXculy3pdC7L7ar37pWt9T/aMw6wablqAV0TplGeFSbDFw23d+C6f8WTivudm9DvKFxRKY2uQ50onDp7NzphpeSkQqlTXt9dv3w/6O5ARLcSs1aqMQvqQLcN4MqNFKZkdd8uBqSj+1scNc38nu07p/WuJOs9GJ0YngnS12yJjPe4Yow0WNt7w/99nPObW8hJ1NuZ0TtzofnMGq0oFgU3I/wd/bbASmPwz0EESQY/GqAXwocrI+2WtUCWUtqcIg7Goo398H59N/cufEzAwhey+M3C6sOr/neqFGgR/uOrgPOadCQGmsqleGYVvczGHSP7UzIUb7KzWgzPYNRM74QmLu8Q+dbiL33uJLofBE5VlUpfuC7JqYPHZo6BGu41Nugncx+brzDkxy6ntweO6S2a27qQ0Bbgw4oLZWoGB11MsbDyXy47EyiP9npDWdXy+W+wlDX22r7Gj8R4TkVGCps+X/rtnzY6wext3mGj1fwh7wrjJJJxXDtF/j7L54BMW9uKn3LCKis8MW1BPJvOAQZLewcafDcRBrgdNNoW8R4N+Ir91VL23ME/Cu41amHqPXxT48fKntVei+1AfbjwaaqYljCWoEoiCtjQLHerO6OFNvtdlg6NnvwNV6PtlI965Iy3i75ZRVDpR1PXFRu4/B3qm3KyOcPP+Lily9ffilugLGmwsjW+jsJO6++XvRbIBr+1eBZLawcm799XTnHgQUnm4dunQLQ16ASafb7GGz/rLLDAZd/q7iyn/4G3oYqQWM7CO+9RGh8hgJNcY4/M6f98Oe9/lCX/R1BjF4ysymiAstlQxGXDx482hrrNZQDjrB1LaEZjgJuhrw0Hd6zb429jvLd2x/ffnpbN8N+EbuKrR9QwUXTutXtLMCfh8EV8r8gEKA9/LUldztXGdpm4agxSHgh/S/KjI7K -sidebar_class_name: "delete api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Delete provider

    - - - - - - - -Delete provider - -## Request - -

    Path Parameters

    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-schema.api.mdx b/docs/docs/api/v2/mgmt/delete-schema.api.mdx index fcfea654ab..02039511c7 100644 --- a/docs/docs/api/v2/mgmt/delete-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-schema.api.mdx @@ -5,7 +5,7 @@ description: "Delete schema" sidebar_label: "Delete schema" hide_title: true hide_table_of_contents: true -api: eJyFVm1v2zYQ/iuc9qUBLDl2vPgFw7AOzYBg7RAkKYoiDRyaOllsJZElKTuGof++O0qW5TiZk8ChyXt57njPI22DGLQBwR3EwcyZEnqB0mC4k6q4xi08z8DBnUgh50EvcHxpg9lDUG/Y4LEXWBClkW6D29vgOeRahj+Avj1WeGrAalVYQK9tMDwf0b8YrDBSUw7M0MYWqnBQOLLgWmdSeBT975bMtoGt7XDlNhrQUS2+g3DoqA1hdrJOIuOOjXVGFku0gWee64y2LkfTxQBG03A4Hg7D0SW/CPkYxuHgXHAO4wkfXSRB1etimJ+KGU8ELC6SJJwsxkk4Svg4XExiCCej6XA6TC4Fv5xSzILn8P+R8k3YFFr5jiRyebrkREIW244dN4Zv0Ew6yO1p/9OwuFZZxueJNNbNvXnvxTV+VaVhnZ4xD4qRbUS15HgG8fx0qr8px7+vpbhPoYm6oWSitE7lYBiGthG7T6Vl+MfZjVErGYMJrQYh0SPugmFX0TJibRaWKMPueAYWF4KwVjS1P0tpiBMPdXMeaZdnmVrPeRxLAsSzuY86p8qwiG6fF0plwIujCu4aQJatU3ApYj+sRPCCYXxWwPqNXtqo26yEZxZeAm6m4TRepKeTzje9nrl5M3AvI+L4H/GhGeZ2SI+CYZSKAh124IPXE2Z3pNfcYBgHxnr9qMdjB8enkeSmuUuDLqhaq4404bXRnQwH8W/TGLk5EuGIx9OQA4hwgMyMhzCcjM8HiBXxI45U7UXPo8O0s6Bf57H9bQusCkj5zGoHvDQZGqbOaTvr91EEI1tqvsxKiKTq58vc9VfD43lobNj7m+ug6oipF8WanB1J3fNby39gs7uDWcem6VcKHAlwlA/TMLRiTjE/HCyGFWQkBdbvCQEWV2kDqKJoiaLEVGgd4zwaXEbTYH/dn3jBl4i2cN6rFnIu3F5Z2jrpYnIuqVWxEvbPtkdC5Xh22MSDw6NB+hV/2HXhjIpLQXvf8PcLZGgMVAsVcYiMYcqSvvgZjhgqlidcadGBxINs0DP3XntSSnwsLetHIqpLETOsrwCf00aU9eGXh9uyQDt2o6xD98d3uxpMWUQa9wqagkXpHCa2q+XZ3mK9Xke6dqNC26r7a2V+WM0FtFuhLhdIwb7Cy1hJWJ9Rct+Hv7j1V8Y+336kzaenp2/FiWFsrKizTf7Ohb2k6UHv2zF08Oz6OuPSR/G3t20489Bwk3RotqczjniKyeh8u10g6s8mqyra/lmC8W8NvWDFjeQLmi0kViwtreNG7I6gtG8NwbvbRh3OGE3naxB39CmIKCtOEzkLcOnZ1VGd6hGNGw4RiPr8PdJDu47n0WvKgYp8uPp4dX9FyllSR7rkrZnaLCjBq8C6rK4R0GfVe8P8dxoAlIU/WvP65E2HViRqa2oRPueq/wCwz3C2 +api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Delete schema Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx b/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx index 2f035bab77..0f05ad998a 100644 --- a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete Sync Config" sidebar_label: "Delete Sync Config" hide_title: true hide_table_of_contents: true -api: eJzFV21v2zYQ/iuc9iUBLL/IL5KNYVjX9kOwDgj6gmGIg5QiqZitRKkkZdcw/N93RymyZDlLsS9zgFgmj3fP3T13Rx28vBCaWpmrG+6tPC5SYcWHvWKvc5XIR2/gWfpovNWdd1o03v3AM4KVWto9bB287z4tpP9V4K/7I+xqYYpcGQEnD14wHuMXF4ZpWaAtsNSxwXJlhbIoRYsilcwhGn0xKHrwDNuIjOKT3RcCDufxF8EsHCw04reyMiR5S8ZYLRUqF99pVqS4NFvME87i0A8W8cyfjZdjP1rOmL8IGY1nk3EQxLF3HLQxPLykczkPAz6OYj+ZLBN/FjHm0+Uy8CciDsfTCZ8mC4o6wXsr1Y/pXIgwpjSK/GjGuT/jMfOX44D6k9k8CFiwjGbC4QTvt5IL/aLCMAkDwcahL+Zs4s/ChPsRS+a+CCecT6ZROKUJKmRVQl4MNBcJLVP78Lx8N9lVosuKaCR3y4YkuSZrb5Pv1h6xOTHAiGHPFDzKnD9kpmVFAlsehQbZTCqZlZm3Wozh03K5/t2F8XEjSKWPXElFMpmmEnicK26uEYEuFbEgUyGBeEAoKZjaX4yuQrt3XlKmKZ5SRCqmRQY8pinsu/VcpXusli6O9Xp9+RhukB3AclAocUKIBhQ5ZInUxuLmoHfWyZkhaZSj7X9VKLZC73HD+UpLmz8YS7V9AIpCUBRkUlYFWPse53kqqOql9yYhVpdi0ASvMumUEdSbQeIZTdM92SFqFDsZINIQ8AICzYdr9aai1sppXCvveMRu8q2UWnAM94kPrfTcO+5mGQCvGGj6DecVgWRbkifkQ1nQx7QUpJbF1McVcICALa9yl2pN9/BTWtGh3zNFUS9foEqfhWcQiKKZ6FQsdkQK2s7dr43cHx07qeJU8x/xmVEjfCOUkVZuBbmtO8f/GIIzCC4E5ApxkgbndScmr38gJlAK8gnNf/PBadi/2FKnNApggiQ+W0bQ93kw9+OYR/50Op1zMU0mAWM9pCfdAPZs76ynQtMAWWcKs1IvP3BqaU8t6OsNrd7E6Y6LptdftgMmHMBu2t642wHB0U2a2V1QDZmzQht3FXBM7mJ25iQqKKjdeG3srm305/uFePN5NBUsDPz5nMPsTqZzf7lYRH6yYOF8uQhnjE0ANbgDYDb56TLjIILZlTdqgTKjQxfiEfuJ0NsnP0qdwpGNtYVZjUZwvRmaumaHMh9lj5kdbYMesZu6fnV74x1b16QP6GJFsNZl6cTRQv4hkKR1+E4ydeQ2gnI38c4K/PaGgBSWL7TXfEc4NPUU6exKmjImjHH91gE6orYkR8PoaKVjPJwshkvvxIM/qaKPbqq4U4OmGa2a9D75iSnKqMRQ8ZyZ35oYQTeGvW4QO5s9cv0MH3KjrM556ebCGv7+EikIC/QFnegiI2CydMMPxYfk77yEPqdICS3EbmCqoAyczNwpwkoDkwgajrs+VHcRQ6CFtmaRGaLVu5/u3pc4XMltbiwcv7968gGnZQFrClkQl9aCYbN9vD5J7Ha7YVEdQ0cbr0e7XH81BWWiWfKLMoaaHeWQjK0Uu2s07uLwO7ZBhP/p/Ttc/Pz581q9QMZayl0MK/uthF0s3U4CGi5a8d2OipRKp8ql8FCX0F27rnECr87qHBi/AdsoeTjE4MQnnR6PuPythMsGvh4MvC3VksZINagzLg0+Q70mNDWiB6p5NfCu3tdt45qcBlQX7FM1KaybLUWCrjx4dMV23pOOeGuo6wqRVEKvoGQK2zreeyHp9Jg3b9+9/fjWc9enTbegq+qtH9DARXTtSq8Q4P/j4BnxX5AU0Cp+bcSrnWcPNI2jksY44ez5By0gxYU= +api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -50,5 +50,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    •  +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/destinations.tag.mdx b/docs/docs/api/v2/mgmt/destinations.tag.mdx deleted file mode 100644 index 9f3e883d69..0000000000 --- a/docs/docs/api/v2/mgmt/destinations.tag.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: destinations -title: "Destinations" -description: "Destinations" -custom_edit_url: null ---- - - - -A `Destination` is a data store where we write data in your infrastructure. - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx index 32f6334acf..d4b243797f 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of an entity mapping" sidebar_label: "Entity mapping created" hide_title: true hide_table_of_contents: true -api: eJztVttu4zYQ/RWWfekCli3fL0/tBn4I2m0XNhaLIhskFDW2tZFElRc7QaB/7wxly7eN45e+NQZii3PjzDk81CuPodAghYWYT6x20MAVI3VS2ETlfML/VDZZJOiAj0wtmF0BkxrqZ5EzyG1iX1gmiiLJl7zBVQHaO9xiUl6Zp/7/p8rnhhJgxQZ/DmCNDoF9KaD2bVZfD9uMTVm7W7E0fHLHv0K0UuqJTSnY8PsG1/CPA2M/qviFT165VLlFE/3EJOm2gdZ3Q029cngWWZEC/dxUqR78Ph6u3MfWkPj+uqGMonE36EdhP+i1R4MgGsQQtIWU7TBsd4fjPoYcbKOKG0YLKYe9OJDjURT0xhgygtEi6MZyKNrDzrC7GGAcdpKD3IeJYdjvjNvjAMJOD8NG/SCKw1Ew6g/C/iAaDBb9MYU5Y1UGugpqi07Ulb24D4MFGgut1kmMxlxk1K4RKZiF0hIIveg71tuZVFEobV2O7e5t2ykZK/JYaBqIBuNSHDeff7m5mc7nvGxwI1eQCZrx1r+KruojRWwC5i0E6hhjdUUqyF1G0F+GBplQY/uOa3kE4w8K7vNcg3B5DvGlnFehX57BfynlVcwoT6hxKeERa8oz2lwKPWBUeUKpS2GHbCtP6PY2JQ54WPV2TIPaXO55+nayHYEbfDqb/TXj98QTrZV+yMAYsXyngym5sp1rWVbKlGjS17sfUf2QhWcUOsX/GLxTROr27suyqmwKlZvqlHXCkL6O1X0G1umcCYZWhnOyzjCrWJLHtAlAtRfWS34srGAbYRheFpCsIWbGSYldLlyavvg+4RkV12BeUuhX/gQoxMf63uBrkborTibCl4FdKS+vFE+tCrvCx+0EccGAXoOuijmdom1lbWEmrZYokqZxhVhisWaiWtkys611h5/ebfOtD/vt860vakA6jTuak3JVY3sOMFvgm6lhx5XfgeRwq5F7nwZPKPEKBIJyVg/LMPSiCYs0VRsWY3MpSaGfuvAD9eP2G8KZ0n01299s0/+vrf/42jo766cHmhBeKEKAyFfhGjbbgybtHqfrReCTyNE5w3F7JP00rJBed7Yb3HGPKmYiIfrGSppfa95KlLHGCbGPjOUpvX7GP3abW61i5yf/DT9fIUVnIH4RsY53xrCkowePb5P9rRyT+EbnDB39xHgfjMx8FNuBg/pgYVm94hl8A4zZHm3TpKp3P93NXI5+7LMyFsPvf9n1oF3eLHAtp5MZOWuxsFkvP+w9NptNs6jCqNG669ZG6SdTCAn1UlC4COnZUgjGOoHNByru5/BRGH+M2JfZH7T4+Pj4LX9HILZeePL+BV+0xpw= +api: {"deprecated":true,"description":"Notification of the creation of an entity mapping","operationId":"entityEntityMappingCreated","x-event-type":"entity.entity_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.created"],"example":"entity.entity_mapping.created"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx index 42cd7b5e5b..217f25a988 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of an entity mapping" sidebar_label: "Entity mapping deleted" hide_title: true hide_table_of_contents: true -api: eJztVttu20YQ/ZXt9qUBRIq6X57apHow2qSBhCAoHMNeLkcSY5LL7kWyYfDfO7PUXbGsl77VAixx57Yz5+xZvvAESg1SWEj42GoHDVwxUqelTVXBx/yTsuk8RQd8ZGrO7BJYAhlsn0XBoLCpfWa5KMu0WPAGVyVoH3CDSXltnvj/H2uf3ykBVmzwpwBW6BDY5xJ2vmH9db/JGCY7dysWho9v+VeIl0o9sgkFG37X4Br+cWDse5U88/ELl6qwaKKfmCTbNND8bqipFw5PIi8zoJ/rOtW938f9lfvYGFLfXyeScTzqBL046gXd1rAfxP0EgpaQshVFrc5g1MOQg23UcYN4LuWgmwRyNIyD7ghDhjCcB51EDkRr0B505n2Mw04KkPswMYh67VFrFEDU7mLYsBfESTQMhr1+1OvH/f68N6IwZ6zKQddBLdGOO7Kb9KA/R2Op1SpN0FiInNo1IgMzV1oCoRd/x3pbkypLpa0rsN29bTMlY0WRCE0D0WBchuPmsy8fPkxmM141uJFLyAXNeONfR9f1kSI2BfMaArsYY3VNKihcTtBfhgaZsMP2DdfqCMYfFNznuQbh6hziSzmvQr86g/9SyquYUZ1Q41LCI9ZUZ7S5FHrAqOqEUpfCDtlWndDtdUoc8LDu7ZgGO3O15+nrybYEbvDJdPrXlN8RT7RW+j4HY8TijQ4m5Mq2rlVVK1OqSV9vf0T1QxaeUegU/2PwThHZtXdXVXVlU6rC1KesHUX0dazuU7BOF0wwtDKck3WGWcXSIqFNAKq9sLXkCyvYWhiGlwWkK0iYcVJil3OXZc++T3hCxTWYlxT6hT8CCvGxvjf4SmTuipOJ8OVgl8rLK8VTq8Iu8XEzQVwwoFeg62JOZ2hbWluacbMpyjQ0rhQLLBamqpkvcttctfnp3Tbb+LDfPt/4ogak07ijGSlXPbanALMFvpkd7LjyB5AcbjRy79PgKSVegkBQzuphGYZeNGGRZWqNF+kKMpJCP3XhB+rH7TeEM6X7arq/2Sb/X1v/8bV1dtZPDzQhPFeEAJGvxjUKW/2Qdo/T9SLwURTonOO4PZJ+GlZIrzubDW65RxVzkRJ9EyXNrzveSpSxxgmxj4zVKb1+xj92U1itEucn/w0/XyFDZyB+EbGOd8awpKMHj2/I/laOSXyjc4aOfmq8D0bmPoptwUF9sLCoX/EMvgEmbI+2Canq7U+3U1egH/usjMXwu1+2PWhXhCWuFXQyY2ctFjarxbu9x3q9Dss6jBrddd1cK/1oSiFhtxSULkZ6NhWCsUph/Y6K+zm8F8YfI/Zl+ictPjw8fCveEIiNF568fwEdPcaU +api: {"deprecated":true,"description":"Notification of the deletion of an entity mapping","operationId":"entityEntityMappingDeleted","x-event-type":"entity.entity_mapping.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.deleted"],"example":"entity.entity_mapping.deleted"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx index 2f3afde720..23c7c2a087 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an entity mapping" sidebar_label: "Entity mapping updated" hide_title: true hide_table_of_contents: true -api: eJztVttu4zYQ/RWWfekClizfL0/tLvwQtNsubASLIhskFDW2tZFElRc7QaB/7wzluzeOX/rWBLAtzpkZzpzDoV55AqUGKSwkfGy1gwauGKnT0qaq4GP+p7LpPEUAPjI1Z6JgrkwQz6yiByhsal9YLsoyLRa8wVUJ2qNvMCKvzRP/+bnG3Hr3BKHPAawQENiXEnbYsP562EQM3Q5uxcLw8R3/CvFSqSc2IWfD7xtcwz8OjP2okhc+fuVSFRZN9BODZJvdN78bquiVw7PIywzo57oO9eD38XDlPjaG1NfXiWQcjzpBL456Qbc17AdxP4GgJaRsRVGrMxj10OVgG7XfIJ5LOegmgRwN46A7QpchDOdBJ5ED0Rq0B515H/2wkgLk3k0Mol571BoFELW76DbsBXESDYNhrx/1+nG/P++NyM0Zq3LQtVNLtOOO7CY96M/RWGq1ShM0FiKnco3IwMyVlkDsxd8x39akylJp6wosd2/bdMlYUSRCU0M0GJdhu/ns9tOnyWzGqwY3cgm5oB5v8LV3nR8lYlMwbzGw8zFW16KCwuVE/WVqUAk7bt+BVkc0/iDhPs41DFfnFF+KeRX71Rn9l0JepYzqRBqXAh6ppjqTzSXXA0VVJ5K65HaotupEbm9L4kCHdW3HMtiZq71O3w62FXCDT6bTv6b8nnSitdIPORgjFu9UMCEo20Krqp5MqabhevcjqR+q8ExCp/wfk3fKyK68+6qqM5tSFaY+Ze0ooq/j0T4F63TBBEMrwz5ZZ2iop0VCm8ABvxQWP4DhkRFsLQzDmwLSFSTMOCmxyrnLshdfJzzjxDUYlyb0K38CHMTH873BVyJzV5xMpC8Hu1R+vJI/lSrsEh83HcQFA3oFuk7mdIa2pbWlGTebokxD40qxwGRhqpr5IrfNVZufXmyzDYb99uXGJzUgncYdzWhy1W17DjBa4IvZ0Y4rvwONw82M3GMaPKXASxBIylk+TMMQ5a/NLFNrlmBxGY1C33XhG+rb7TeEPaX7arq/2Sb/X1v/8bV1dtZPDzQxPFfEAImv5jUKW/2Qdo/d9UPgsygQnGO7PZO+G1ZIP3c2G9xqjzLmIiX5JkqaX3e6lTjGGifCPjJWp/L6Gf/YTWG1Spzv/Df8/woZgv2rGgnreGcMUzp68PyG7G/lmKTXO0NHPzUeg56592JbcnA+WFjUr3gG3wATtmfbhJT17qe7qSsQx74oY9H9/pdtDdoVYYlrBZ3M2FmLic1q8WGPWK/XYVm7UaG7qptrpZ9MKSTsloLSxSjPpkIyVimsP1By34ePwvhjxG6nf9Di4+Pjt+KdAbFB4cn7FzMCxc8= +api: {"deprecated":true,"description":"Notification of an update to an entity mapping","operationId":"entityEntityMappingUpdated","x-event-type":"entity.entity_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.updated"],"example":"entity.entity_mapping.updated"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx index 2175a670a8..b7e5825778 100644 --- a/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get connection sync config" sidebar_label: "Get connection sync config" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/iuc9mEJEMttPwyYMQxLX1AEW7EsbTEMtuHQ0tlmS5EqSdkxDP/33ZGSLFmOk2Zphw3rh9Qij/f68CF5m0jnYLgTWl2k0SCag3uhlYKERt6uVYJfMzGPziLH5zYaDKND0zYan0UWksIIt0ahTXTT47nofQT6Gm9xNueGZ+DAWD+v8APN3fSSwjqdgemJFI0IhYML4CkY/LLJAjIeDTaRW+ckbp0RipyBG57lkoay9U7F02h7FqVgEyNychCn3y2AVfPs4iVzC+5YocSnAuSaiRSUEzMBFicagkKxtS4M43kuReKzg0YNfCqEAUyTMwVszxpR5EYvUZnp+ZGHxGG5BDvTJoHDQVQWWGlhz5kxjdhcKwuWDD178oT+a+vZlY5R7Vhd20Qrh5mgFY2Q+x8sLdt0/dfTD6gHF6JXCB8nglG05oTyaydJ0N3x4VyxsJo5zfQSjMGofPZTmPFCOvZyp4UFLUUAKENTNFLGEKN9reC3mQdUJ1Jcx2wOCZY3IVuX2ro55og1vCRY70XkhPP1qMQ7QYYFB0qpioz2R14tHG+PVb5b4SBLwPsuZVJ8BPLaUp2cjtm7hbCVSIY4ZVwaxNeawY2wLmZvi5zPZQFsJaRkSjuW4LwDJnDyYuZHynRAeuYTXmqrRwn2NF5nqlkJr3YKrLCQxi3kVrtm8nRShrvdNvE5DLHXyRjTzrmzXM/F/PcCzPqe5arEP7tcUzH/5BdSuVLuuAV3v3qVwkcLVsk8UsUqdZ2S1dn67JJVId9Ss2r6QNEGgwG6CCPlI52h64VB5y3TCqmVL7mQfCqBXLw0sBSw8vkBSZu/8oCkGVHtK2QgkxthkeokVzEbIigcR9HCjk8yVOb0wAHPfrZl3uJEZ6cMKZNlmgwr/Jn5yOORQudGaqQOAOuNVnP98nkTV6NjyKrkT8ogTj8bYhlpSKceYYmWMtDX/UC2kz+Ks4bYFyaHKh2PzA2NvOB1gZjTcZVyk05CQeyBkwRzgaHqGUsQoj0Lygonlshf1VFZ6ShPHEt5m6596tBRCrwVNObRa/ThOI55bp1PIZbKnyAqwkkaYBbvUMSN4cRFwkHmXd8dVLfh7FzKDrJKoXshpY66PF7pnsBOKDWsTs1pqzjlBuuUpLTqt/xdx2O/Zp7b98dXioKuqFN5cCd27XhRwsMKr6yhvvW15CAyPCgO3leCKsI+gavaau19kK3pQkR+2tvSXbl/NO13k9FXS/bfYLJHSXtD3/Hcv1m/uDP1e/RD4bV2e5d96gqwu3ko6GqxEHw5FmqeZv8mHppMkv8GFflA/mejr53vf5qQ7pP5h3DRdpfw3eN3QvRRPbK3Wy/VDvE1uMZjOdwXk+rBn4Fb6LLfQ0XjboEf/cP66Q1swSyr3k1hJHU3nMvtoN/nuYjrK7nQ/Wyeuf7yWSfl9R30/PIi2jb6RW/pYhjg0uga1RXEkV+AOKxutlQy+22Wvevh5QVDKaotl1KvsE5LkAROz8A8ScCGto93aEvaZpoMU6BBx5P46ffxD03Ec8Xn6K1yflXonPCA8NK/Kk6qOz1bcCjViW09W3CuncTWZKeU3+I/dqGc0WmRhAfLSP0BEoU9a/h7ecszhiYL+gjvIfanLvB08idlgDHJ4MrMr2o2vhzMQ7fFMrw8NxBkY7I6/GZ4VSj/pkPaxeXjkyoGU6g4xzFFKJgWzqFhu5yf7iRWq1Wch2UUaB11f6XNR5vzBOqhXl5MpUj6tNM8tZBxn4fnRAjk/vurX2nw+vp6pO4AYylFmS3tNwp2dKO0ClFj0sGN6+MzVXiVvpSbchMNb9mkvkW6QOMkstlMMYr3Rm63NBwaEIMh/lxyI8K5MaRXUIlt3+ASliZw0864tNBxre7hRSdXJa2cssdsfx6M3e/VTht3yWkDDKLIdw0e6vh+y/OoA/sd2JYLQegct3zuGnOdXifRUk2Nr1+9Q1leUFWbbBSop/zRuElxtW7obtJUME9/G6dpW/xHQjTy3E+1eJi5dUHNekGakkFnxV+Cnln6 +api: {"operationId":"getConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}}}}},"description":"Get connection sync config","method":"get","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,11 +38,11 @@ Get connection sync config Connection Sync Config -
    Schema
      destination_config object
      +
      Schema
        destination_config object
        An object to override the default Destination configuration per connection. -
        oneOf
        standard_objects object[]
        +
        oneOf
        standard_objects object[]
        A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. @@ -51,5 +51,5 @@ A list of case-sensitive Provider standard objects to by synced. If specified, t (Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. -
      • Array [
        • oneOf
      • ]
    +
  • Array [
    • oneOf
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-connection.api.mdx b/docs/docs/api/v2/mgmt/get-connection.api.mdx index 2a35d3bd91..428d951d8c 100644 --- a/docs/docs/api/v2/mgmt/get-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connection.api.mdx @@ -5,7 +5,7 @@ description: "Get connection" sidebar_label: "Get connection" hide_title: true hide_table_of_contents: true -api: eJzlWOlv2zYU/1c09cMaILITJ/GFYVhXtEWwdS16YBjSQKWpJ5uNJKokZdcL/L/vPVKnHSdeO/TLcsrku48f+XTryxwUM0Jml5E/9edgnsosA04r/rFv2Fz70yu/WdT+9bGvgRdKmDVu3fpfApaL4Abo0/UGdxXoHAkBOW/9wckJ/YtAcyVyK3bqd3RwmRnIDFGxPE8Et+b0P2kivfU1X0DK7G6SvIqtSrPOAcXI2SeUgiJyRW4Y4VSKiP6WNNookc2RBr6wNE9oCcbjMYcoDmASnQTnA34RTM7HF8EgGg0m4/OYQTzwN8dta8KHZEYocXYWx8F4NooDlDEKZuMIgvH5ZDAZxEPOhhOSyQttZArqQYHpOqhog1PiRB+XIjqAczgaxTzmLODxeBKcn41HATvFp9EpH48vZjAczXhHYMZSuFNkVqSU/EUxw4RSnDVLQMdScaCgixwiJZb0/DdkmOGbUEOS4MdUh9EaxQquw7PhRWj5iEwuZMhVSllnuS4S4pWFUcD4Ah/n0ipmuUwSWelLZEy6BVaJ4pJ4E5EBUyQkwf8zQdtDDVhypJupGzCyY23oFtGtkCeyiELGuSwyE0I2Z3NIqfyQPmH8hsq7iWXjuhHGrnSjRhllBuZSre+LoHO5owwyJfii/NCYxwpMOSs7I8NgVdI7Zjl5lUk1zYaipA3L0ONCJfeXycKYXE/7fazyXulmD8Pbp3Zk3Oj+6eDs/GKIPN3evSw1eO/f/O5hdD2zAI+7hobIq4q2R9a43sXo5zmq1yGSxWK+iwfvFkJ7+EPiYgFJ5FUs3moBmbeWhRcxw7xURpB4hcYt7+qVbX99/bhyJZJc93SRs3lSgHUmT5hBoWnfQYXuyyWopYDVI2eaPup579D+LaULUOAx/NVgvNma9KvaM13qJ7+vnlvGlxXjk9eX95mDQNlfDvrpPDX9IkePIHCGBdaAoDLgqEfpvRfkUFyKuFT61Uo1U4qtqV8MpO31PXLK5XtL5akriTC0uGFNrXP69ZrL4rDi7tdv8YAolTZ135EBEB3C/pz4/rBsGzqdPhdCQUR92THhuukoZ3HY8RSZt7hrv7Yick2E1CQRU9F3zdD/Pj211KxIkoOzZTkzlL6+L277IcuJ7h+OXM9IGcb5IOiCkrjBLmdrhRYlhN1txOFIZm1afyWUaaybYNusw2utDP5dNxtMzU4D7JHidvefwlVL+tU1DHOPh+ydt5/tUrS7JXGrEpsuV6GTWfb7f9mJZXT2ttJ2YYJHZnoytol1BSEyl/rWnbb37U38bzRXRfejxk2hoiBnCuvtdXmf8oyUifcYevOe97a+uB31DoSKToy2DG/lq022H9ibcmyx8npmCbtY4bdx5+p6W5iI/J1RojsHdO/22xfz1g1z63p3p3FozUP1VOi9U8RuQkVUpZPYPKa15ILRTW8lzIJSqb1GO0GRw0WN3hmRgvZYoqV3k8lVhtxWEj7aC+JmY8F3s633BWIVb4+IWCoYCrz/azv+uZbdiqEgzpwZmiOa+BtVwHFrhtzp8kZak99vkIc5QUMXshymre0oYur3a9Dt37YM3/QbvbTTNmJDMwlCfuW2vdK37u2iQWQhHRIvBztJfFvSEKD7m9bw/paccBXRGuEbkMrFb7CuMG/aoiljswCGRbqjD9V4SIX9jJlP5MqLYAkJ1Z+2a5yDdmVgDbIzSyxJMTnqZJz0Toe9SWvEecmycnSyXO6lAXOHQmlf5ScBRsoEhYpOrV/apxbudYPY2dypw0f45V1mRsmosEn5gN9/QoLEQL6QE13LPFRZ0AeHsN5fePxzllHvuFYhGuRMLVeNiR4Nt3P3HgYbJota5a97pPXqh6s3RUZg+lpqg+zN2ayKrJfjWkZVMCuMQcV6OT9qKFarVS93bPbsrrzur6S60TnjUC8FeTFDpKrvGkek3MbhV6Ztymjuo8WPHz9+yB4oxpLKvm1w+lsJ2+nyTvDrOjTwxdBlSFgx5VjrmuqqhgB6uTDt4kErgnaz097YBgs0iETc3s7Qs/cq2Wxo+XMByr7JOvaXTAk2s6iOA6vQ9Ix9HSOgwY619Vss//GbEi2OvGaK63pRtVhGzbRkVLVTHx9tB3ZwjQDqe6ruRGlD96OyzSkGjuYJdnBuWtw7b+06KPji2Ts6AAtKWBtcHJKUD62Xel3L2qjj1NPf1hnXJf+JChRh6+ea3O3sZahBzFFTjOhM+gc3i1yW +api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,26 @@ Get connection Connection -
    Schema
      schema_mappings_config object
      +
      Schema
        schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
    +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-connections.api.mdx b/docs/docs/api/v2/mgmt/get-connections.api.mdx index 2c5257329b..383048e29a 100644 --- a/docs/docs/api/v2/mgmt/get-connections.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connections.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of connections" sidebar_label: "List connections" hide_title: true hide_table_of_contents: true -api: eJzlWG1v2zYQ/iuc+mENENmJk/glGIZ1RVsEa7eiLxiGNFBp6mSzkUSVpJx6hv/77khJlpzY9bphX5ZXmbyX5453D0mtAlWA5laq/CoOLoMZ2Kcqz0HQiAmOA8tnJri8DtqjN8eBAVFqaZc4tQq+hLyQ4S3Qp5s1zsZghJYFSaPNF2AZZ6k0lqmEiY55DabAJ0Afq2BwckL/utpdOKhtIbckxosilcJB738yJLsKjJhDxunJLgtAba41X6KetJCZ1riafkKjOFFoSoCVHoGMWzLGapnPUAa+8KxIaQjG47GAOAlhEp+E5wNxEU7OxxfhIB4NJuPzhEMyCNbHbWzR12zGaHF6liTheDpKQrQxCqfjGMLx+WQwGSRDwYcTsilKY1UG+qsGs2VYy4anpIkxLmR8gOZwNEpEIngokvEkPD8bj0J+ik+jUzEeX0xhOJqKjsGcZ/CgybzMqGrm5RTXl/JseAomUVoAJV0WEGu5oOc/IccFv40MpCl+zEwUL9GsFCY6G15ETo/E1FxFQmdUA7wwZUq6qrQauJjj40w5x7xQaapqf6lKyLfEmtFCkW4qc+CajKT4fyppemgAK5B8c30LVnXQRn4Qw4pEqso44kKoMrcR5DM+g4yKEeVTLm6pLza53IRupXUj3azRinILM6WX+zLoQ+44g1xLMa8+bODxEpfclRwO55is2noHlrdXQ2pk1pQlY3mOEZc63V8mc2sLc9nvY5X3qjB7mN4+NScX1vRPB2fnF8NgmwiuKg/s/ZuXDLPL7BxqPoCY1UXbIzS+kzH7RYHuTYRiiZzdp4d3c2kY/pC5REIas1qF3c0hZ0tVsphbzjIVQ8pKg1Ps+jfX/ubmcR1KrITpmbLgs7QEF0yRcotGs76nCtNXC9ALCXePPDRz1GPvEP+W0zloYBx/DbLedEn+dROZqfxT3NfPneKrWvHJ66t9cJBh+4tBP5tltl8WGBGEHljoAIQ1gKMeLe9ekkNzGfJSFde3k2U1vLdUnvqSiCLHGw5qs6bf7rkqDmduv3/HBySpjW36jgBAfIj6c9L71amtabP6XEoNMfVlB8LNpqM84qgTKSpvaTdxbWXkhgSpSWKu4/90hf73y9NYzcs0PXi1nGaO1pf78rabsrzp/uHM9YycYZ4Poi6ohDfc5bHWbFFR2MMgDmcyh2n5jVRmsG7CbViH11qV/IdONrg09xpghxU/u3sXrlsyqI9huPa4yT54+tkuRTdbCbcqcdPlOvI2q37/Nzuxys7OVtouTGAEk47pttnaZO6XvnWm7f3zJv47nuui+97gpNRxWHCN9fa6Ok8xq1TKHkNv1mNvm4PbUe9AqujkaAt4a73aYruJfVOOLdXNlSfqckXQ5p3rm21jMg7uXSW694Du2X77YN46YW4d7x4ER9G4gDC9qI5nZuOud77Mt/xKWraC23nQxmx1Ccf3b2FNZ6BfNDxX1VWTEJOJy6DfEEt/1XK07nevi0gWixqWO6a2zqJywzJSeXZZDO5V2ttKhkgqWLdusm8JtO+a1n1203iF/AWWdR9ftmSqXMyBY+Lv+UM3DKWwRhnHm8kdi2EBKfWocWNCgDGu5h0gdw5PFDmmQL2Nk97psDdpHdtf8by6Djgtfy3mnugqfHWc1AQZl5QqYuKf2kyMc90kdibX26E8wi92lVut4tKtyAf8/h1SFAaKhYLoImPosqQPnjXYH7ilCZ7j3gHUyW6nIM3MaTV9zujCNvNvJQxDmmy/NOiR1+vvrt+UORHEa2Usqm/2G13mvQLHcqqCaWktOjaL2dFG4u7urld4Nbcf1VH375S+NQUX0AyFRTnF7mv2zyNy7vLwMzduyeguQ4MfP378kH+lGCspd4P2/lsL9pLej3SrvZP+1ebdx943KlW9Wvhi6SAgnbvqSueb7bppZZK/7Pa16L7nmSNO0litphjwe52u1zT8uQTt3vYcBwuuJZ86AsO7mTT0jO2d8NTAnhAev6lI44jtAl13Xk49tuBUzJcBPrrG7NDRmnbjqgEJhpd4gr1V2JbuvTdGHT568ewd0W1JKWq3ve/x6oGsP4irzQfePf1dH+8Q/4FKBwnlx0bcz+xUaOjFS1OG6Pj5F1TN5GY= +api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,26 @@ Get a list of connections Connections -
    Schema
    • Array [
      • schema_mappings_config object
      +
      Schema
      • Array [
        • schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
      • ]
    +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-customer.api.mdx b/docs/docs/api/v2/mgmt/get-customer.api.mdx index 9bfd756844..6e1581c96f 100644 --- a/docs/docs/api/v2/mgmt/get-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customer.api.mdx @@ -5,7 +5,7 @@ description: "Get customer" sidebar_label: "Get customer" hide_title: true hide_table_of_contents: true -api: eJzlWG1v2zYQ/iua+mENENmJk/glGIZ2RTsEW7eiLxiGNFBp6mSzkUSVpJx6hv/77ki92rHjZcP2YUlay9K9PHe8e8Tjypc5KGaEzK4i/9KfgXlRaCNTUP6xb9hM+5fXfnVL+zfHvgZeKGGW+GDlfw1YLoJboG83a3yqQOcy04B6K39wckIfEWiuRE5O0EXLPpeZgcyQDMvzRHALpP9Zk+DK13wOKaMrs8wBVeX0M3CDirki2EY4Ny3dUEQteW2UyGYoD19Zmid0KxpzmJ7FcTCejuLgPGajYDqOIBifTwaTQTzkbDjx1witRPmgwaUsVFBJ66DIxJcCghakAC2gwYylsN/S6+ULmeYsW3pXGScVDF4k+3Uog4ybZ+mSO90eflr8MsswV+hftywwpdgSDQgDqX44sQ/FDuMxpjOKA5hEJ8H5gF8Ek/PxRTCIRoPJGJML8YDA/KcLlC7r5QlOSRNjXIjoAM3haBTzmLOAx+NJcH42HgXsFK9Gp3w8vpjCcDTlHYM71zgrUuqjeTHF7qA8a5aAjqXiQEkXOURKLOj6D8iwXW5DDUmCX1MdRks0K7gOz4YXodUjMTmXIVcpNRHLdZGQriyMAsbneDmT1jHLZZLIyl8iY/ItsOkUlcmxn4gMmO3EBD+ngh4PNWD/km+mbsHIDtrQ3cSwQp7IIgoZ57LITAjZjM0gpW5G+YTxW+KKJpdN6EYYe6ebNVpRZmAm1XJfBl3IHWeQKcHn5ZcGHitwyW3J4e0Mk1VZ78By9ipItcyasqQNyzDiQj3Qg3Njcn3Z72OV98owqQv7ZW/q/ung7PxiiDpdIrwqPXgf3v7sYXY9Mwev7FuIvKpoe4TGUSFmP8/RvQ5RLBazbXJ9Pxfawz8yFwtIIq9S8e7mkHnIVl7EDPNSGUHiFRofede/2vbXN0+rUCLJdU8XOZslBdhg8oQZNJr2HVXovlyAWgi4e+Kg6aOe9x7xbzidgwKP4T8Nxpsuyb+qI9Olf4r7+pVVfF0pPn9ztQ8OvnX6i0E/naWmX+QYEQQOWGABBBWAox4t716SQ3Mp8lIZ1+PJsry9t1ReuJIIQ8sbFmq9po/3XBaHNbffv+UDklTa1H1HACA6RP0V6f1i1db0qv9SCAUR9WUHwk3TUQ5x2IkUlTe067g2MnJDgtQkEVPRv7pC//vlqa1mRZIcvFpWM0Pry315201ZznT/cOZ6Sc4wzwdRF5TCDXc5rBVblBR2P4jDmcxiWj6SyjTWTbAJ6/BaK5N/384Gl2arAXZYcU93v4WrlvSrbRiu/a4d7mYp2qelcKsSmy5XobNZ9vs/2Ylldna20mZhgkcwPRnbhXUFITK39K09be/vN/Ff8VwV3bcaHwoVBTlTWG9vyv2UZ6RMvKfQm/W8d/XG7ah3IFV0crQBvLVebbHdxN6UY0u1GU3CLlf4bd65vtk0JiJ/a5TozgHdvf3mxry1w9zY3t0LbjuaLd+lWTendaG0TVYDbxOercaXVagrf8GQDe4bZQ8bh6re2xgh6wlyx5i4MUQdOMq6n82S/RFZkTeTPZYkIjJ0ZEDHBCW87loJ0suZoXmlSbNRBRxvj/6PnrzpUAKRzGV5vGHBoc9Lv1/r9lctZGsaYPD9UGG3+//WJl809C2ko+3FYKuF35UyxP7+unVs8o4icwXQOjxpGC0XP8GyWdFGpkzYHFhkU9z1h248lMLm9xiOfHdeBAtIiPy0vcc5aG3JxAKyA04sbe2hiLNx0jsd9iateeg1y8o5y2odV3VEaiW+Ks5WsdEr7ln7FYfPuknsPNwqpSf4g/VrlIwK24kf8fc3SFAYKBYKoovMQ5cFfXF07P2OewXOMnwpA1GkfQWTZmq16jr1aBKeudMv7eH7x2udmvTI6/U312+LjJj3jdQG1ZsXuSqyXo73MqqCaWEMOtaL2VEjcXd318udmn3RV1H376S61TnjUN8K8mKKVVtvTI7Iuc3DD0zbJaMhkW5++vTpY/ZAMZZS9mjC+W8t2EajdlJfV6GBr4b2TcIaKSdg1zbXdRfTOcTlBufN0R/JrFZTBP5BJes13cbGVPaI8BipTgk2tQyPw6vQdI2tGbNEwxac+oDQf/q2ZIgjr5noujCrDsqoV0pG9fHSNliHe9a0XSkbiWA4iefYI7lp6W6dSXa45MeX7+l9VFBS2u3rerW8IOv34mr3tXNP/6+Pd4h/RyWAxPB9Le6e7FSoacJJU4Zof/4nYdWlEQ== +api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"],"title":"simple_customer"}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,5 @@ Get customer Customer -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    +
    Schema
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-customers.api.mdx b/docs/docs/api/v2/mgmt/get-customers.api.mdx index 18a8a905b3..4eefed5322 100644 --- a/docs/docs/api/v2/mgmt/get-customers.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of customers" sidebar_label: "List customers" hide_title: true hide_table_of_contents: true -api: eJzlWOtv2zYQ/1c49cMawLITJ/EjGIZ2RVsEa7eiDwxDGqg0dbLZSKJKUk61wP/77qiHJbt2vGzYPixNapm8993vyNOdpzLQ3EqVXobehTcH+yw3ViWgjdfzLJ8b7+LKW69d9zwDItfSFrhx5331eSb9G6Bv1yvcDcEILTOSiPJegmWcxdJYpiImWqI1mEylBlD+nTc8PqaPLm/bEKFSC6klIp5lsRTO5MFnQ5R3nhELSDg92SID5OVa8wL5pIXEtNbV7DMIixuZJsetLPW3ZAYybNEbq2U6R3r4ypMspqVwImB2GkX+ZDaO/LOIj/3ZJAR/cjYdTofRSPDR1FuhyZX59wosVK79JjR+nsovOfgtk3yUgAJTnsB+Sa+LZyrJeFqwy1QQCwZFxvt5KLJc2CdJIUrePn46+1WaYqxQv3l4YO/zHSYTDGcY+TANj/2zoTj3p2eTc38YjofTCQYXoiEZ858mKCma9PgnxIk+LmV4AOdoPI5EJLgvosnUPzudjH1+gk/jEzGZnM9gNJ6JjsCdOU7zhIC4yGcIG4qz4TGYSGkBFHSZQajlkp7/gBRxdBMYiGP8mpggLFCsFCY4HZ0Hjo/I1EIFQicELp6ZPCZelVsNXCzwca6cYp6pOFa1vlhFpFsiGDWVSc+LZQpck5AYP2eStkcGENikm+sbsKpjbVAuoluBiFUeBlwIlac2gHTO55AQypE+5uKGms06lmvXrbRupRs1yii3MFe62BfB0uWOMki1FIvqy9o8nmPKXcnhcorBqqV3zCrl1SY1NCuKkrE8RY9zfQ8GF9Zm5mIwwCrvV24SCgcVNs3gZHh6dj7yNrvrZaWBfXj7imF0mV0Aq3ALYdNu+2RN2SIx+lmG6k2AZJGcb3fd9wtpGP6SuEhCHLKahd0uIGXYrVjILWeJCiFmucEtdvWrg7+5fly7Eiph+ibP+DzOwTmTxdyi0GRQtgozUEvQSwm3j0rTzFGfvUf7N5QuQAPj+GfwKJkVpF+vD5JKP/l99cIxvq4Zn7653GcOHluD5XCQzBM7yDP0CPzSMN8Z4NcGHPUpvXubHIpLsC9Vfj28WVbLe0vlWVkSQeD6hjO1yenDNVfF4cTt1+/6AVFqYxvckQEQHsL+gvh+cWwrugN8yaWGkHDZMeF6jajS4qDjKTJvcDd+bUTkmggJJCHX4b+aof99ehqpaR7HB2fLcaYovdgXt90tqxQ9OLxzPSdlGOeDWhdUxOveVdpad4uqhX3biMM7mbOpeGArM1g3/qZZh9daFfxv3WwwNVsA2CGl3N19CteQ9OprGOZ+1w13sxTdbkXcqsQ1ynVQyqzw/k8isYrOTihtFiYwMpNmH9scbTItU9+60/b/Poj/iua66L43uCl16GdcY729qe5TzCoVs8fQn/fZu+bidtQ/sFV0YrRheCtfbbLdjX1dji3W9WgSdHuF1+47V9ebwmTobY0S3Tmge7ffvJi3bpgb17tvGrftzZbuSmw5p3VNaYuslkmgk5mAXahqXicruV3gl0F7vsY2sKQnGtLdBbR1y5Tr/iFV2TeWw60aelfRUPvxVq3B/x2dBSUeWuP/GlKZ/BmK2rmLFg0FjQwBjiHd0odqGFJh9TGOM8ctC2EJMaHPuDUhwBhXzc4gd8OOFCkmR0sZx/2TUX/aupC/5ml10XdcvXreJbbKvtrPJg84QmKPfdLusbjXDWJnc7XpyiP8wRncahXmrhQ+4r/fIEZiIF/Iia5lDFXm9KXsB+x3PKwET/FUAMKoOwOIM3FcDYIZjWLz8gWOYdgAWWts75PWq++u3uYpQf+NMhbZ1yeJztN+hmspVcEstxYVm+X8aE1xe3vbz0o2d9LUXg9ulb4xGRfQLPlZPsPabk7GI1Lu4vATNy5lNKXQ4qdPnz6m9xRjReVm41J/K2Gv6HVSu9Y7wb9bvyza8/qpqlULXy0d79Kpqga1Ek5Xnmi/9VqgGbR4dzdDfz7oeLWi5S85aPfuq+ctuZZ8VnWeXl3lhD+HD+8pFnBGcF1yqraL7TdZBLIG2i+fv6dulZMtbWyVQKoeSHq9lRYt2W3Qlerp/1VvB/kPlB9E7Y8Nebmzk6HBcElN8aPb25/GshTH +api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["application_id","name","email","customer_id"],"title":"simple_customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,5 @@ Get a list of customers Customers -
    Schema
    • Array [
      • connections object[]
    • Array [
      • schema_mappings_config object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). - -
      common_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • standard_objects object[]
    • Array [
      • field_mappings object[]required
    • Array [
    • ]
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    • ]
    +
    Schema
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-destination.api.mdx b/docs/docs/api/v2/mgmt/get-destination.api.mdx deleted file mode 100644 index 2b80942a59..0000000000 --- a/docs/docs/api/v2/mgmt/get-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-destination -title: "Get destination" -description: "Get destination" -sidebar_label: "Get destination" -hide_title: true -hide_table_of_contents: true -api: eJzdWG1v2zYQ/isa96UFQtmWLVsyhqEtNhTFFqxrVwxDargUSclK9VaRsusa+u87UpQs2Y2TAMWwLQES6Xi894e80wHlBS+JjPPsFUNLFHH5ExcyzjQJXSFJIoGWN6hHFWh1hQSnVRnLPawd0GdMihh/5OptVcNqyUUBjBy2HpAzHqt/jAtaxoWWu0RDLTTPJM+kYiNFkcRUL4xuheI9IEE3PCXqiX8maZFw9Rgrex1KuUs4w9wLKZ5NAgcHYTjHc8YCOgl93/FckN8Tutb7uOs43pz6eDqeengWEgcTJ/DwlFN/4frMGdMA9mUkBV3oem+9zoWMwC3rJDz7QjEUZrVxJYwjZeAGiGqtzFlFFT9mAc74zqZJJSQvMWWbLKtkllB5a1cC70A0duySCZuk5EuekZ2waZ6C1CIvQZY7mzpXiBFJAiL6etdKyZopk9tYoaIKwGegVIKX8J7u9UNdX6E847+FOnPG/jy45VQqf2KpootEVZAoqbhSXaoSkXGTTBW9bpuQZZxFwNOlBbGZ60L0AhzOGSQkoFNMgskMB7PQmdBZMPOmLqrPM3JJ5sKZh8HC9zDz3BmeUdfHPnGm2F3wKXfCxZQTrmQ2Er4iKatSVcOdU6u+9I4KEra8FHFTc0YIbA1M1Er+qYpLzpQoMPnMB2PAUcqqvro7wr2S+e9EuMHDJUl3QeUB6ekiMkhPR6372DqN6jCEDfIumfkNQFm3qDytlZ4eBdi6j9iLNp2Cub7qnXwX9jVAr1ukX+JtDwGQLJJ1mrOLGWGxIEGiSpokSb7TceahdtGAYZirlv8ULTofJly9aHTuGctX5+hYNylfCxJ+C4Dq+u1wasrpgYAN4uhTxcv9owHLPc+jnIWY+2yMZw51sT/zXOywheN7cPfw0HksYH134bCxB4fAxA/xzKMUE7js8IQHi/F0wqbhnDwYsC/i6Hfl2WMB20VkUAQd9RGAhTdFv9ftdI8jWmDDjoHdoEvwewCf7tetYet2gzIQygUaj5gk4n4raRID7xoqNk4erg0qextTviaU5lUmn8Gasd+OSWpHZt0sN0fLSTEPFK9OV3vBOwZj6NrqvIz/RchK8yzKdfPyPwPWtXLssahqozEAVUv8ppcgoMncevaX6WRH01vb6LGzBh4Pu7iOch53CX39luhdD6e3grHuny7dngWsn0v1c3Uy17zk0mKDEaEgJSiA4AjdcZuRosfTWBGr3QWRG9S3WZYVv7sLqJVpIHuTm9lNqwMRSzTqKRCjw1Bdra5eOHZam6oSzjO0kbIQy9EIZjm7bYrtOB+lUSpHWweduvrW8FjPX79CdW8mfKvMbYqwNxl2xgPlF74/TldHHhOFDSdMNxlDfaDGAi5L5pZuRyDOW56okheaBqOggKeNMahW0sJcKe4KBI3tydz2e2fPNclIBNZmUu9qRlFCNXKMfW+Ps5A5+hHLqXjWxagZ0YZBHCyeVcn38GO9ymTXhb6H3z95Asxc+aKcGFpmgcpKvegc2tZfeWVRklkAEeCOheaBnaneZVGAI8gqrRgG66gZ8IVFMmaBfxnXOoWttN58d/OmyoBP9+2wffWk9aGsMrsAWqaqIKikBMViGz09cux2O7totilHO69Hu7z8KApCeUfCTZs6yrfqvuO7p0q5jsMLALs2/92bXxXxw4cP77N7itFwNU241t9L2DkGB9HvClHyz3JUJCTWcnT+DgY/N32AqhlteQJYKPfmgL1Bh4M6rt6VSV0rctP8LG/gcUvKWDfECmSmOQakhnAl8zOjum8g6Mkbg/+n1vETw9DYFkqZAs2WqOpcInjUSDs9XGq4fVtQKUsapueAl0L2tp99eRmcLi9//kMdnpWKTh/KDW7NQ++TwtC0PsYb9epvrykYsv+gygEOiR879mblzg3dkdFwqyBBn1T/DQFlZY0= -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Get destination

    - - - - - - - -Get destination - -## Request - -

    Path Parameters

    - -Destination - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-destinations.api.mdx b/docs/docs/api/v2/mgmt/get-destinations.api.mdx deleted file mode 100644 index 6195b2e8c4..0000000000 --- a/docs/docs/api/v2/mgmt/get-destinations.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: get-destinations -title: "List destinations" -description: "Get a list of destinations" -sidebar_label: "List destinations" -hide_title: true -hide_table_of_contents: true -api: eJzdWHtv2zYQ/yqa9s8KhLKthy0Fw9AWG4piLdq1K4bBNVyKpGSlelWk7LqGvvvuKFmWnDQPoBjWJUBCkfe++5E8HsyiFBVVSZE/5+alGQv1q5AqyfWUNC9MRWNpXi7N0fTqwpSC1VWi9rB2MD8TWibko8CvVQOrXEhWJSVSg9RnQhnUSBOpjCIy+FhBJWQJIwFaDqY9neK/MfuZRazIlcgV0tGyTBOmVyZXEokPpmQbkVEcqX0pgJ1WFd0DX6JEppWIzzQrU4HDBJ22GRMeFZwIP2LEnYU2CaNoTuach2wWBYHte8A/ULbWfMKzbX/OAuJMHZ+4EbUJtUOfOIIFCy/g9pSFwJfTDM14uTdeF1LF4K8x8AhD3NpZdquti1ESo4EbmMS1quA1Q3rCQ5KLncXSWipREcY3eV6rPGXqyqol2YFoYlsVlxbN6JcipztpsSIDqWVRgSzPdWxIEFU0pHKod41K1hxNPsbQLOsQfIaZWooKvrO9HjTNhVnk4lWks9/ZX4RXgin0J1EYXVPWJY3TWqDqCutMJW2WMXo9m1RVksdA06fF5K7nQfRCEs05JCRkDqHhzCWhG9kz5oau73hmcz0jt8lc2PMoXAQ+4b7nEpd5AQmo7RBvIRxhRwtHUIEyWwk3SMrrDHHQO7UaSu9nQcJWVDJpa7ETAqxhF7VKfKqTSnAUBSZf86Ez4CRl1Vx8PcKDkvl+Itzi4TZJX4PKPdLTR2SUnn62GWLrPKrjELbIu83MbwDK5ojK81oZ6EHANkPE3mrTOZibi+s74k18LdCbI9Jvoz1uAiBZpuus4LdmhCeShimWNE3TYqfjLCLtYgeGca6O9Odo0fnowjWIRu9eZ/nqOjrWbcrXkkbfAqC6fnucduV0T8CGSfypFtX+wYAVvu8zwSMiAj4lrs08Eri+R2y+sAMfzh4R2Q8FbOAtbD71YROYBRFxfcYIhcOOzES4mDoz7kRzem/APk3iP9CzhwK2j8ioCPrZBwAWvnD+TrezPYlZSTpyAuQduqS4A/DZfn00bH1kQAOhXOBCktBU3m0lSxOgXUPFJun9tUFlbxMm1pSxos7VY1jr7LcSmllxt94tt1vLWTGPFK/OVwfBOwVj7Nrqehn/h5CVFXlc6MvL/wxYL9Gxh6LqGI0RqI6T3/QQBDR1p571xZntWHZldXqsvIXH/Q6uk5yHHUI3nxKD4+H8VOis+7dLd2ABH+ey92nZ9SOBDfcxdz4l1JnOoB+ZzYnPZxGZCy/ybc9mtrBv6keCMKDOLAxJEAkX+xGPhNTHq9jU8ai9iGzP/w76kazdXMen+/VWRP8DIVTKXVGh//2waWB/azBxmVCbomtsNbHawMfkrAXF3RMSpTNQV7AtmxulSnk5mUBbax3v9lZSTLI4U5MtRn/cor7taIwnr5+bzaA9fovmt1gaNMmn3rRMfhf7U1JONNCvouCNoFz7OdYHagygMlRh6FsVNNVbkSJypZ6DjlbCaNMZ1KC0qEDFfZ2bU2s2t4LBFvqS5jQGa3OludpOmzK9AXT2vT21dN0JZvKCycd9jNrMjoM4WmzOXfkRfoznueor6j38/iVSIBboCzoxtswAlTV+6ARaxt9FbTCaG1ARQJ1ITQOcmeYyGBQmyKqMJFcibh87pEFzboB/udA6pYValz8s39Q50GlkAPvqp6MPVZ1bJczlWAVhrRQoltv40Ylit9tZZcuGjvZeT6AkP8qSMtFPkbaWJ8UWj22xe4TKdRyeQtFr89+9eYGTHz58eJ/fUYwdVdtLaP2DhL3AR5ezch/F/3B6T7n9naarWCU+q0mZ0kQr1Ik+dLhamvzskajdLZbm4YBoflelTYPT7dXucgnDLa0Sfd3Hh6OLY7kjEDVQzCdQySVCd0ux7C6vP/kg2nqYP/vtT9wZazRnCLIWUd1g8GZB8/1A9hB9rXr8O7h1jMl/xkQBfH/pyduVrzL0YG6pMYS4Uf0D99iX5A== -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    List destinations

    - - - - - - - -Get a list of destinations - -## Request - -
    - -Destinations - -
    Schema
    • Array [
      • oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-entities.api.mdx b/docs/docs/api/v2/mgmt/get-entities.api.mdx index 9d6f121212..52ca75aaad 100644 --- a/docs/docs/api/v2/mgmt/get-entities.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entities.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of entities" sidebar_label: "List entities" hide_title: true hide_table_of_contents: true -api: eJydVX+L20gM/SrT6T9XiJPdbMgvSrkWSlmuB6W9cpR0ycq2nExre6Yz42RD8HevNPYmzoa9wGVh42ikJ+lJb7yXKRqLCXhM5dzbCntSG7TglS5vySRX6N+XXnmFTvakh5WT84U8mO560mFSWeV3ZN/LhwiMin4i/7qr6TRFl1hlGI/QPqAXIHLlvNCZwCOwRWd06eh5vpfDqyv+Og3tVJHo0lMs+4AxuUpCuYMfjh330iVrLICf/M4ghYK1sKM45bFwHbuOf2Di6cBYbjqg06lKOz7OW1WuyAcfoDA5m8ajWXyNo1k0nAyH0WgMNxFMcBJdXyUAOJnC6CaTda9b2/ISZjpNML7JsmgaT7JolMEkiqcpRtPRbDgbZuMExjPGLKHA/0YqdlHgdcfuxFSmVpdbzhTmqfv/lF0uC4zOc1hmyjq/DO51zWP/VSnLu7doMO7YCnmut0tIU8XcQb4M5S0LIpRgu+XEWucI5RlW289lKNpQ4ipU2LC2bCl7ikgDPJtoO44DzWdghMKfnizQr3UrJyYP/Jp+DDoCcGg3aF0QUWVzOl17b9x8MCBB9V1lYJVX2Fd6UKwKP9gM5VNtfWl9xNtPt7LuCPML66GZU0eex1Eb9RfuHpuZd3xo/Ay8RkjRnuWjNIK8hNcisCxS3GDOW+GCLUnQ0dO6LahmtExzYm60wbjqX4/7M3nk7W8oYUXVlj5ENVqHxB+X7NAnr1cBiqlKdeL+PHCU6ILOTkk8OayftvKSPuK29FanVcK27/T3L+bkjNwLN3FamaCUFf8Iy9AX33QlEihF5ShgrVzwocgiRImkcp6wrFB0c62a69UJKFNB/ZUYcro+Z128WHyuSvITn7TzFH73x2MPtir7hmwlb0FceU+J3Wb16uix3W77pgnjRg9dD7ba/nQGEjyYIlPFtMsDTcPYKNy+4uSBh3fgwsjE188f2Xh/f/+9vLCMrRcz2+bvDOwjX/edVT/hfn+8zZ9/O7Sb6vHBD0wOKiQKA963WlpI7LyS1lQD2/b7mJr5avO6ZvOvCm14MfXkBqyCmFeOXlO9xxVn8QVxyLe0vYalugFetfn5i4YVdpD1h/f/8PVQcSldYTUqah8Y/fGo3HWwu4pr0vP/uveM+2seDkn2zcG9OXk24CDgxpvpo3u2/g3e87q/ +api: {"deprecated":true,"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Get a list of entities Entities -
    Schema
    • Array [
      • config objectrequired
      fields object[]required
    • Array [
    • ]
    • ]
    +
    Schema
    • Array [
      • config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-entity.api.mdx b/docs/docs/api/v2/mgmt/get-entity.api.mdx index e5e0d93a9e..f23d510d7d 100644 --- a/docs/docs/api/v2/mgmt/get-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entity.api.mdx @@ -5,7 +5,7 @@ description: "Get entity" sidebar_label: "Get entity" hide_title: true hide_table_of_contents: true -api: eJyFVW2L20YQ/ivq5ksOLOvOZ/xGKU0hhKMthEtDKY7xjaSRvYmk3eyu7DuM/ntnVrIsx0nsA588+8wzr8/qIFLUBhNwmIqFMxUOhNJowElVPpBJbNC9LZ10L2IgHGysWCyFN0i0YjUQFpPK8PFieRDPIWgZfkH+tarp1KDVqrQEXRzE6PaW/6VoEyM1RyD+jjxRpcPSMQK0zmXic4g+W4YdhE22WAA/uReN5Kjiz5g4ctSGM/b50KlMexjrjCw3hMFnKHTOpsl4Ht/heB6OpqNROJ7AfQhTnIZ3twkATmcwvs9EPejnsL7Gmc4SjO+zLJzF0ywcZzAN41mK4Ww8H81H2SSByZw5Syjw50zFS4hNQ2rfkUxurpecScxT28OBMcAtlQ4Le93/elqgVZ7DOpPGurWH1zUP92slDS/OsuFYsRXyXO3XkKaSewf52qe3LqihRNtPJ1YqRygvuNp6rlPRglGvfIZN19Zty75lpAFeTLQdR9fmCzJiqZnofF/foQvwuLMaDHE4NNavf9PIYy4+hmQfDW4r+hk1QrtY6bbzNSuHaLeqFaCPRBQLEWErvejQRakFq9DsjllUJifk1jltF1FEghzaSsMmr3AoVVRsChftRuLbuj60mODN+wdR94T9gbNsFqUn79Ouafknvhy7uehh2uK3CCmai3gUJiBU4FTgxxykuMOc19J6W5Kgpadtm1DNbJniwFxow3E7vJsM5+I0uL+hhA1lWzrv1VwqkLjTlnd18n4XILlVqUrs712PElXQ2XkTzw4vVuIVfYKH0hmVVgnbPtHfv5gTGLkWLuI8s4BCVvzDb+Mw+E9VQQJlUFly2ErrMeRZeK8gqawjLhNIuiI3zeVsAyjTgOor0ce0Q466/GX5WJWEC94r68h99fpYg6nKoSZbyVsQV85RYLvb3JwQ+/1+qBs3LrSrOtor88VqSLAzhbqKSUyRomHsJO5vOLjvwx9g/ciCj49/sfHp6elTeWUZWxR3to3fG9iZ4M4a3+2gw2cX6Rykp/CjO7SKWYqjYsh7cVImLfiWQjHgcIgp548mr2s2f63Q+PfXQOzASIh5s0hWqbT8TJLMILd4kUv3/hKvH1uh3wS8m9/L8SiekovaAe/jQtCj11bvAqlXBG4VxEk0529IHNr1PC9emGc3yLu3//D1V3E/+rptRNo+MPt3s+oLugnP3/XgB/BfefZ0I/zWwZuTHzp090OD5v7Qe6T+Hz5H8Ds= +api: {"deprecated":true,"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Get entity Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx index 9d6067222f..822d83f4a9 100644 --- a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx +++ b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of magic links" sidebar_label: "List magic links" hide_title: true hide_table_of_contents: true -api: eJyNVvtv2zYQ/lc07ZcVsGTFdvwIhmEdMBTBUqBoUwxbaigUdbJZS6TKhx3X8P/eO8oPqUmaOoFNkfe+7ztxF6oaNLNCyes8vAoXYN+yheA3Qq5M2AstW5jw6i70m0GzO++FBrjTwm7xaBc+RKwW0Qroab7H0xwM16Imo2jyDdiABaUwNlBFUHlD5cG8BlMraQB97MJBktBPV7vtuBdyJS1IS2KsrkvBfeT9z4Zkd6HhS6gYrey2BtRmWrMt6gkLlWntq+wzcIsHtab8rWgiEHlLxlgt5AJl4IFVdUlbwAfJdJRMozwbzKLRJLmMsuEMolE+HCaTJBtBMQ73WB7LrDM/tsU1MAs5ibdSSV8KIZ9yyIZFEU2zSRGNCjaJsmkO0XQ0G8wGxZiz8YxscmesqkC/aLDaRkfZ6II0sSRrkf+E5ngyKXjBWcSLKVZjOJ1E7AJXkws+nV5mMJ5kvGNQsgqeNCldRSBbugzhQG0xrARTKM2BeiRqyLVY0/orSMTHKjVQlvhYmTTfolnBTTocX6Zej8TUUqVcVwQZVhtXkq5yFmvOl7hcKO+Y1aos1dFfqQryLRBimivSRZgC02SkxN9M0PHYAAKWfDO9Aqs60abNJqaV8lK5PGWcKydtCnLBFlARdlG+ZHxFNDrX8py6FdbvdKuGZXS6fKp4XbrcLqFFseDj+5u407OltbW56vcRcvHBZ4y59olYjFvTvxgMR5cexBqs0zL9KbfoJ7Aq0JALjcSiNSuwjIHFeNC2xE2UDIQJmLNLpcVXyJ+PrNrS9yGug247NHio0Y9JmX0qNOxERSdhjgSLrKig42iQDIZRMogGw9skufL//4d7n/AXh2ZzgiJi/0TjRwTtsqvLmO/h3gm2aWKntPNzx33fUuobhkMfxBhgsQ5zmUwzu8SH/lmSojOg16CNn8W+W61aiti4mi1KB7FQ/WpR2f568Kh9Hw4ywet31+G+Nd8/0EBtZmNryp/Hay3+AZqvDbNbMkQjCgQYVuKRP3QToJSHCRJwE+SwhpImsfF7nIMxHjs+oD1ZKxQ5pkQbG0l8MY5nLcK8ZfJAMa/VvCwQ06R2iO+YJ3WlYoJKlStu/jzVqKF9t4idw/33qfyKn+BaWq1y53H6Cf/+hRKFgXKhJLqRBejS0YPHUxz8p1zAmQycQYUlMoRkULPyWsERagHNpUXzqkYWybzFKxOT17tf7t475JgM3iljUX3+2zEH7WRc454kFGTOWnRs1otXZ4nNZhPXjZon3jHr/kbplakZh9NWVLsM6dBX2Iy1gM0rcu7r8BczvmU0d2jz/v7+k3wBjAcp/6Jo/LcadkO3hu6VoVP+3flG8MN7xgGvFh5svy6ZkK2B2pDqLmyTCimwxGBoe7fLMKuPutzvafuLA+0vOr1wzbRgGWEPrz29I9aJhZ4l4WuEcU20XTPC3NXjKwtR7UTxN3/f0qhxFE2bYQ2dDguyfjyS25btNvUa9/S97z0j/jt1Cbn7x0m8OXlW4cTkRpoqOMcR9Q3h8nqm +api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","description":"`new` or `consumed`","example":"new"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z","description":"Any ISO formatted date-time string indicating when the magic link expires."}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,5 +38,5 @@ Get a list of magic links Magic Links -
    Schema
    • Array [
    • ]
    +
    Schema
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx b/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx index d1026dbece..c14342856a 100644 --- a/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx +++ b/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the ID of the logged in (common schema) User sidebar_label: "Get logged in User ID and details" hide_title: true hide_table_of_contents: true -api: eJztVltz4zQU/ivCPNDOJHbS0nbJMMwWFnY7wNDpBYZpO6liK462tqTVJWlI/d85R7Idp8nCdmZ5ww9tJJ375TtnFUnFNLVcirMsGkU5s+daznnG9LVhGu56UcZMqrlCGqC4mnFDmMiU5MISzazTwhA7Y+TsDZFT/6uQec4ywgXZS2VZSkFMOmMl3ScolFCRkYxZygsT34pbcQUsG3SBDOSVVIFs6YVOZVHIBRc5OdRZX1Ftl0TVthI5ec9SCyxmhBKfSOMFIU/kgpXSsjUN3iFNv/lI53fnDmneuYlR0hLk+f2Q/LYQKLP5As2bpaAlTw2eT/9ympHLpbGsDG4EmjNhmQYnPU1WQmi639OtgEBbmptodBP9IIUASyHeJrrrRYalTnO7hKdV9NinivcfGJ7uKniFQNCSgXDj38ESBll67Ju8D1qk7s/hCVPXizjmb8YohAVOIdTRaBXZpUIeYzVEF16YcCXaMUTt7JGWqoD3YVX1WvlN4Mf+XIv+4JhewkGzD45rBvVktWOfomkWogw3pRlndTjHh8dHY0MLZryCEL8Nk1q+rmmpM1aWYBrPGsMUtbMX2FVhXDUDycKAcng/GAzw32YntA2SSjBOWKSgShU89f2UvDdIttpWEwoRGCGK0H2WByXOBKN3xOl5C+5uNhQAV9QSqXnOBbXMkKmGoltKp0kTmK+wXXnbQ02nxNAnUxQQ2s3SScEIncg5tp72d21ThdZUYFwcVRAruhjXDb3LTZplHE2nxXnH4ZCDbc9AGMmopcFyVPtJ1qMda0Xjz2bST+C7AcU7tZoeGggNX9IlmUC4WrHBBchIhgEtpHxwyjuzG+j2WJzHZMHtrEGcfSzqdal3yiM6GQyHR+ww7R+cDAb9r4fDg/7k4NUUj8ds8OroZMCOo62svJgfGYAaisi+xghAACDf2IPYOhA1D1ZY/DS12KPUQYZ87cNBwmkW3VXhg8YGflmPGCx9bMlRlDRpNcmq07hVkq4xMBm3aNP4gKCo5w3mOV0gFlirzChJAB9j4xTNC8diLpMyL20yP9jqosuahpyen0VVB2cvMTWhJTto29YQ3PzMEOZaqG1oniPspj5QQ4AKy4HiJIMROGcFFp8fcTRNmQmD1BtUobSpRMUNgo+iQTw8jr/BUcGtB8BfqaA5WAujGLl6TTqQrbav8RPhtoRigKtMpuZ1G6OQ0c0gbjxWz135Ej6caFpmzucIZ+4frEh9nwT82LSMgEqHB18eMflTOpJSD1nYWMbTAGfpudpmJwj7edhPjN8bOnXhd4ebL24unED0O5fGAvvdXuODdiJWcCewCibOWlBs5vn+mmKxWMQqsKGjrdfJQuoHo2jK2qu+chNA9gTgUM85W+yjch+H76nxKSPXF7/g5f39/a34l2KsqTCytf5Owt4y2wH1BiE6S9Pz0lqtJ9D/69l/uJ6F/rfs0SaqoNynz7fNqoazm3b5wByNNjeRTuXCaRvTAIFmUAsoZbWaQFFd66Kq8DrsVYh0GTc4lgFGp7Qwz2dVtw72LuplZ598zHQPa1ub3JwiVowiD4lzqjkq/PzKGzAVy67Oxqhu5Ko7IK8x9WVm/LPjO1fktfewUAa6UwBmZTtvWzseRqodb29/vAqjcLY5M8KAqH+gHzsj0B0mQT3+RWN2kn+LuAPT6LuWPLx8lKGdTYEa44Ej+m8YiMEp +api: {"operationId":"getProviderUserId","description":"This endpoint returns the ID of the logged in (common schema) User and details.\n\nThe common schema User ID maps to the following 3rd-party provider object IDs:\n\n| Provider | Remote object ID | \n| --------- | ----------------- | \n| Hubspot | V3 Owner | \n| Dynamics | Azure System User | \n| Intercom | Admin |\n","tags":["Connections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-sg-minor-version","in":"header","schema":{"type":"string","enum":["1"],"example":1}},{"name":"provider_name","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","ms_dynamics_365_sales","intercom"],"example":"hubspot"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UserId","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the logged in user that originates from your customer's third-party Provider. Refer to the table above for the Provider ID mapping."},"raw_details":{"type":"object","additionalProperties":true,"description":"The raw data from the your customer's third-party Provider."},"additional_raw_details":{"type":"object","additionalProperties":true,"description":"For some third-party Providers, there may be additional data used to lookup the common schema User ID (e.g. with Hubspot)"}},"example":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","raw_details":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","user":"test@something.com","scopes":["contacts","automation","oauth"]}}}}}}},"method":"get","path":"/customers/{customer_id}/connections/_provider_user_id","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get logged in User ID and details","description":{"content":"This endpoint returns the ID of the logged in (common schema) User and details.\n\nThe common schema User ID maps to the following 3rd-party provider object IDs:\n\n| Provider | Remote object ID | \n| --------- | ----------------- | \n| Hubspot | V3 Owner | \n| Dynamics | Azure System User | \n| Intercom | Admin |\n","type":"text/plain"},"url":{"path":["customers",":customer_id","connections","_provider_user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"provider_name","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-sg-minor-version","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/get-provider.api.mdx b/docs/docs/api/v2/mgmt/get-provider.api.mdx deleted file mode 100644 index 8185ce2c5b..0000000000 --- a/docs/docs/api/v2/mgmt/get-provider.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-provider -title: "Get provider" -description: "Get provider" -sidebar_label: "Get provider" -hide_title: true -hide_table_of_contents: true -api: eJy1WHuP47YR/yqs7o/eApafWsteFEUvQRIc2jSHe6AoNgsdRVE2s5KokJR9ruHv3hlSkiU/zpsguceuRM57fjPkaO/JkitqhCzeJt6Dt+LmnZIbkXDlDTxDV9p7ePSaJe09DTzNWaWE2cHG3vvi01L4zxzfng6wq7guZaE58O296XiMvxKumRIlKgEVHflMFoYXBmloWWaCWUNGv2gk3HuarXlO8cnsSg6sMv6FMwOMpUKzjXBqRNKh0UaJYgU0/AvNywyXxixg8XKS+ny2nPrBPL33F8tZ4E/CYDmfhZN0OZt6h0HXhuiWzGk44xMW3vuzeJ74wWxJ/WW84D6bUxaMwyRdTinKBHF8JdXuorSiyjG8TOX2bUVXPMd44IsSbF2/5FQ9cwM8Ea2MzK2BsFzIqJX+1LXNyTPCuLeGBj2szDpyZlw3RyLV1MN4iAhT2xNe74KwguZflbOuYsACOqBpxnUqFeOYO1HyRIkNPv+PFwCO50jzLENHdZTsQKxgOprN7yPLh2RyDb5arxgtdZUhr6yM4pSt4XElrWJayiyTjb5MpqhbAMQUk8ibiYJTi7sMfscCt+eaA1rbIMuetdEx8iyTVRJRxmRVmKiXK51R9twP0tH1JgtljfrIRu1gsZ+K1SVw98vlTUHcDjFraog2EkqM/GSzMHrz7i2BDI3ALq41PhLFM0h4QpjiCdgnaKaHZxXTWgOQvwn1fNeQgdmVxqgU4H0SWSh0eGMpIbDFmQsfVcUfCHCSD1VJV1nF/woevAFm0im5nsXke/gJTJ+Ayaw5qQ1ObrB17TagFQw+NfJKD7FkkWawpjvUVCm6QxQZnuvzMB06+mwdD514PcTWRvEBMJog5Hp7eUkLUHxpM+HoyIUNuS2gA1+WV+vaQl/mV5Vd2nXa3M4TovIYzJfGjGUCOG6iKJwtZ/E9Dfx7Ph1DEw4W/iKkqR+H8XQZhstZmky8Jl+NUDhrFDdfF7wMJvEimFP/ni6YHyzihR+P+cSH5XkSxCxIJ9CJD3g0/VoJ8K/tcR3TL+t9usxWo6QfrTPa0xproPjUac2QTMOjlrLuCRgFl5/b7eHjWmgC/6BfkVTwLCE56IMYabJd84LsZEUSaijJZcIzKELYIo8/OfFPr9fGlPphNEok00NdVydiZlRCGwGh+ag2ZSQ3XG0E394NyUeoyBNlr+kzJY8f7In9++S+cse9vrsja644ofBfc0PiHToxsG0g4RueIQQHhBaJXWotwJ6ws3GgWYYsirAK2mWOVXOGXTAld7eMG5V+BftXD78Wl/VZgdl0nl0pkX4+36bo9IBsBTihdwVDJ7VzE9qfjTokvDDSeq/oNrLpZTKr8gI2CE0SYRtjTeI8rQ+RIQEFhTQdJSk3bG1jVgunCKheK/Vm0wUUVzzzF7Pg3g/i8dSP5/OJz/lkFgdpOF+M52c1ZkNky0IbyBZVyZ8Z7jcvDHenI4Uhp4vp3L8Pwzlc4YLQX3LG/SCM43gSMpYkwVWnDscqbmoVDwNoBmYXNZi84O/16nViRi8v4u9QGcTnRdXGa+LTMr6s1VWzVbAjP9arv0/PKxcTv5b9Z1X3C3FUJ+gWNOxNkkb1wXpsyLcV3Lpct6XQuy+2q1+7VrfU3zZmnWDTctQCOqdMIzyqTQYum+6vwfS3hdOKu93bEG9oHJGpTa4DnShcOjt3uuGlZKRCadNen10//GM0N0CCW6lZC5X4JVWA+2ZQhUYqM/KaD1dD8qGdDe76Rn6P1v3bGneSlV6MTgzvZKlL1mTGO1wRJnqs7f2h337Oue0t5GTK7Yyo3fnwHEaNFhSLgvsR/gFquTxO9hBBYDf4yQA/EzhMHw21egXyldTgBHe0Eq/tg/PRv7lw4zcGELyW9dcKqwsv+N6oka5H+46iA05o0IoaUyqV4YBWdzIYcY+NTMhRvsrNaDM9A1AzuBCYuLxD5yuIvfG4Yuh8CznWUyn+yXdNNB86NLX/a7jO24idTH1usMMzHPqd3B57o7Zrbt5DKFuDDigtlagYHXUyxsPJfLjszKA/2rkNp1bL5b6/UNfVavsaPxHbORUYKmz2/+g2e9jrB7G3eYaMV/CHvC2MkknFcO1n+PsfngExb+4ofcsIqKzwxTUD8l84/hgt7ARp8MREGuB0c2hbvngr4iv3MUvbEwT8K7jVqYeo9fEvj+8re0l6J7UB9uORpqpiWMJagSiIK2NAsd6s7o4U2+12WDo2e+Q1Xo+2Uj3rkjLeLvllFUONHc9aVG7j8A3VNmXk0/t/4eLnz59/Lm6AsabCyNb6Owk7qbte6FsUGv7F4BEtrBCbvH1dNsc5BQeah26FAsrXoA9p9vsYDP+kssMBl3+tuLJf/AbehipBYzv/7r1EaHyG0kxxfD8zp/3e571+Xxf8HUGAXjKzqaACa2VDEZQPHjzaAuu1kgNOrnUhoRmOAi6EvDQd3rNPjL1e8sN3H+sG2C9fV6v1A0q/aFe3rp16/HkYXCH/G0IAGsPfW3K3c5WhbROOGiOEl9D/A/lGiSs= -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Get provider

    - - - - - - - -Get provider - -## Request - -

    Path Parameters

    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-providers.api.mdx b/docs/docs/api/v2/mgmt/get-providers.api.mdx deleted file mode 100644 index 61bd5b9e58..0000000000 --- a/docs/docs/api/v2/mgmt/get-providers.api.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: get-providers -title: "List providers" -description: "Get a list of providers" -sidebar_label: "List providers" -hide_title: true -hide_table_of_contents: true -api: eJy1GGlv4zb2r3A1H3YCRHZsK5YdLBY7u2iLQa9BZwbFIg00FPVss5FElaTscQP/975HHZZ8xOmgzWFL5LsvvscnTxWguZUqf5t4d94S7Dut1jIBbbxrz/Kl8e7uvf3aw7VnQJRa2i1uPHmffV5I/xHo7WGHuwkYoWVBFJHeN2AZZ6k0lqkFKzqkNZhC5QaQ/pM3vrmhrz5uVxChcgu5JSBeFKkUTuThr4YgnzwjVpBxerLbAhCXa823iCctZKazruJfQVjcQFFQcSsr/jLpwBirZb5EGPjMsyKlpRsRiHg+WvgwmY/9YLq49WfzSeCPwmA+nYSjxXwy9nbXXdmiSzTH4QRGIrz1J/E08YPJnPvzeAa+mHIR3ITJYj7mRBPJwVLp7UlqeZmRf4TO3NuSLyEjO9GLlmJVv2RcP4JFnIiXVmVOQFzOVdRSf+jKVtGz0lZvDQxpWNpVVIlxXhxFUGOP7CEjio0e8XoXieU8e5bOqowxSEgBw1MwC6UFkO9kAYmWa3r+HXKMmsfIQJqSoiZKtkhWChNNpreRwyMwtUJdnVaCF6ZMCVeVVgMXK3xcKseYFypNVcMvVQviLTH0tFCEm8ocuCYiKX7HkranBjCMWyOrnrTR3vIiVWUScSFUmduo5yuTcvHYN9Je9cYLTfJEzmo7lxMLuTwV3P08epOzaofZFbfMWIW5x350Xhi+efeWoYeGKBcYQ49MQ4oOT5jQkKB8kqdmcJQxrTQY8hdDPds2YCh2acgqOWqfRC4UOrixUmjY/EiFD7qEO4aY7H1Z8GVawj9RgzeIzDop15OYfY2fiPQRkewKmtqTXEDrym2RKwp8KOSZGuLAIiNwzbygEtVm2nX4uTweVOTNgEoepweM0YRCrreXFTxHxqc2EyBFTmyoTY7V9DS9mtcGCzucZXZqt+JW7TxQVO6N+VKbiVQixsUoCifzSXzLA/8WxjdYhIOZPwv5wo/DeDwPw/lkkYy8xl8NUTysNNjnCc+DUTwLpty/5TPhB7N45sc3MPJxeZoEsQgWI6zEOzqzfisl6tfWuI7op/k+nEaro6RvrSPYwxxrQvGhU5rRmRaiFrKuCWSFyj+Xy8OHlTQM/7BesYWENGEZ8kMbGbZZQc62qmQJt5xlKoEUkxC32P2PFfmH1ytrC3M3HCZKmIGps5NiZlhgGUGi2bAWZajWoNcSNlcD9gEz8oDZa/7I2f17d5J/Gd1XVRtgrq7YCjQwjv8GG5B4S0pcuzKQwBpSCsFrxvPELbUSUE3YOjvwNCUUzUSJ5TKjrDmKXRQlq7qPL+s5zh5+bVzWZwV5s9LsTIr0/fl2QUpfs41EJcw2F6SkqdTE8uesjg7PrXLaa76JnHuFSsssxw3Gk0S6wliDVJrWh8iAIYNc2Q6TBVixcjariXMKqF4p9SbjGSZXPPFnk+DWD+KbsR9PpyMfYDSJg0U4nd1Mj3LMmcilhbHoLa6Tv9Pcb15o7k5FCkPgs/HUvw3DKbZwQejPQYAfhHEcj0IhkiQ4q9Run8VNrtJhgMXAbqMmJk/oez57KzLDlyfxV8QM7fOibIMa+DCNT3Otstkx2LLv69Uv4/Oqsolf0/67svuFcVQ76FJouE6SR/XBui/Ilxlcaq7bVOj1i+3qc211C/2/RqyD2HQYNYHOKdMQj2qREcu5+7kw/XPmdOQu1zaKNxKOhknbHiEyr9zZ6ekGp5yxkNrYtn2u6uFfw7kJJOxK7UrqxC+4xrhvJlgspCplr2GwHLD37Wxw1Rfya5LuByfcgVd6NjoQvOOlLljjGW93hpjsobb9Q7/8HGO7LuRgyu2MqN358DiMGi5E1lHOwK5Ufe1AkcGpz/aG3WsCgzWAnuiuodQpTUZ1CcHZcl9BpBpmy8wO1+MjzzUTA8NRx9t17i9cq1FFYecWYx/IhfwWto0adx0YGglJEOyjQR+PW9VERYcnFhq12Rcl49aqQYtiyAm0I2oLRYxJ0YrGzWA0Hcw7w9/3bmCicdFhVRcivContXyNnhRUGZdkKqqy/+lWWdzrG7G3uTtU5RX+sLe51SopBa39gr8/Q4rA0DQHfckYsizppcpC9n88dwTP3ehm6agiGMSsBsA2b6gdgWV1D2Vc6Ub9cnA8zYC43v/j/qfSdSfvlLGIvj9LdJkPClzLKQri0lpkbNbLqz3EZrMZFBWaO2sarYcbpR9NwQW0S35Rxhjc+0OOmDs7/Jcb5zL28afvaPHTp0+/5BeCsYYiy9b8Ow77jm7FurHeM/7T/s7rmVu0OlYtfLZ0gkrHyrn4qU6n/RjhLu9WKAYtPj3FqM9Hne52tPxbCdpd4V17a64lj908SvNcHeWUfy4/qE2CgtJ1zSna7o4v5CjJ2tT+5qsPdVno51aVSPUDUW+28m2HdjfpKvb0ubs+A/4v8g9m7b9b8GrnLEKbwxU02Y9asz8An65PnA== -sidebar_class_name: "get api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    List providers

    - - - - - - - -Get a list of providers - -## Request - -
    - -Providers - -
    Schema
    • Array [
      • config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-schema.api.mdx b/docs/docs/api/v2/mgmt/get-schema.api.mdx index 5e47682448..f846b4f0b3 100644 --- a/docs/docs/api/v2/mgmt/get-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schema.api.mdx @@ -5,7 +5,7 @@ description: "Get schema" sidebar_label: "Get schema" hide_title: true hide_table_of_contents: true -api: eJyFVm1v2zYQ/isc96UBLDl2vPgFw7AO6IpiLwiSFMOQBg5NnWy2ksiSlB3D0H/fHSXLcpzMSeDQ5L08d7znkXY8AWNBCg8Jn3lbQo9rA1Z4pYtPuMWX4O/kCnLBe9yLpeOzB15vOP7Y4w5kaZXf4vaOP0fCqOgb0LfHCk8tOKMLB+i148PLS/qXgJNWGUqA4dvYUhceCk8WwphMyQCh/9WR2Y672g5XfmsAHfXiK0iPjsYSYK/qJCrp2DhvVbFEG3gWuclo63o0XQxgNI2G4+EwGl2Lq0iMYRwNLqUQMJ6I0VXKq14Xw/xczGQiYXGVptFkMU6jUSrG0WKSQDQZTYfTYXotxfWUYhYih/+PlG+jptAqdCRVy/MlpwqyxHXshLVii2bKQ+7O+5+HJYzOMjFPlXV+Hsx7L67xX11a1ukZC6AY2cZUS45nkMzPp/qdcvz9Wor7FTRRt5RMls7rHCzD0C5m9yvlGP4JdmP1WiVgI2dAKvRIumDYh3gZszYLS7VldyIDhwtJWCua2u+lskSIh7o5j7Qrskxv5iJJFAES2TxEnVNlWES3zwutMxDFSQV3DSDHNivwK8R+XIkUBcP4rIDNG710cbdZqcgcvATcTMN5vEhPr3xoej1z82bgXkbE8T/hQzPM7ZCeBMMoFQU67sBH8MztGW+ExRgerAviUc/GHkvIocjHCL/iXUS1Sp0IwmtzOxkOkp+mCRJzJKORSKaRAJDRAGmZDGE4GV8OECiCRxwr3chdgIY5Z7xfJ3H9XYuq4qR5dr1HXdoMDVfeGzfr91H+YlcascxKiJXu58vc99fD00lobNj7m0+86shokMOalh0xPTDbqD9gu+/+rGPTNGsFAkf/JB+mYWjFvGZhLFgCa8hIBFzYkxIcrlYNoIqipZoSU6F1jMt4cB1P+eGi/xKFWCLawgevWsKF9AdNaeukW8mFolYlWrpf2x5JnePZcROPDk9G6Ef8YZ8Kb3VSStr7gr//QIbGQLVQEcfIGKYs6UuY3pihVgWqlQ4dSDbIBj3z4HWgo8IH0rJ+EqKuFAnD+goIOV1MWR9+eLgtC7RjN9p5dH98t6/BlkVscK+gKViU3mNit15eHCw2m01sajcqtK26v9H2mzNCQrsVmXKB5OtrvIy1gs0FJQ99+E24cGXs8+2ftPn09PSlODOMjRV1tsnfubAjgh41vp1BD8++bzKhQohwdbuGMA8NK0l+Zgci43yvMBOd73YLhPzZZlVF299LsOFlocfXwiqxoMFCViXK0TppNO4ESvuywN/dNrpwwWg0X4O4505BLFkLGscZx2WgVkdvqkc0bghEIOrz98gN4zueJ28nR/rx8cM9qWVJ7ejStuZos6Dor6Lq8rlOT59V7w3zn+nqURB+ac3rkzcdWnmorak/+Gyr/gMYKmsT +api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Get schema Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-schemas.api.mdx b/docs/docs/api/v2/mgmt/get-schemas.api.mdx index a3f16445f6..6a69796f93 100644 --- a/docs/docs/api/v2/mgmt/get-schemas.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schemas.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of schemas" sidebar_label: "List schemas" hide_title: true hide_table_of_contents: true -api: eJydVX9v2zYQ/Sqc9s8KWHLiGHZsDMM6oCuCtUPQpBgGN3DO1MlmK4ksSdkxDH333VGKLcfLDMw2Eul4fPeD7x13UYrGogSPaTT1tsJepA1a8EqXN2SKlujv5AoLcFEv8rB00XQWPVseepFDWVnlt2TeRU8xGBV/Q357qGk1RSetMoxGWO/RCxC5cl7oTLg9rEVndOmQsHfR4OKC/x3vPKQgdemx9OwCxuRKhlT7Xx377aIGlJ/81iDtBGthS/uUx8J17HrxFaWnBWO5YK+a6Crt+DhvVbkkH3yCwuRsGg0ni0scTuLBeDCIhyO4imGM4/jyQgLg+BqGV1lU97q5zc9hptcSF1dZFl8vxlk8zGAcL65TjK+Hk8FkkI0kjCaMWUKB/41UbOO2AXXoVKaW50vOFOap+/8tO58WGJ3nMM+UdX4e3F8y429dWdHpmQhJCfZNuJaC1jCdnw/1O8f4899C3K+wRd1yMFk5rwu0gqBdIu5Xygn6gbi1eq1StLEzKBXtSLvJiHfJMhH7KCLTVtxBjo4eJOdaM52/V8qyoGZNcx7YCnmuN3NIU8UJQT4PqHOujIro9nmhdY5QnlRw1ybkxGaFfkW5H1cioRSEL0rcvNJLl3SblUHu8GXCLRvO50vq9sqHpjecm7eEe4lI9D/RQ0vmPUlPwAiFP3TyVKluBxFTD/yKXvqH4eHQrtG6MH8qm9Piynvjpv0+zaLEVQaWeYWJ0v1iWfj+enDa19ZHvL29ierOTAtTpyF5Z7IddGLUH7h9rmXa8SHtMPAKgYh0Eo/CCPISXovQZJHiGnOWlAs2KdHR06pNqGa0THNgLrTBuEguR8kkOrTtI5SwpGxLH3Y1gxKkPyh0XydzoADFrUq1dL/ueyR1QWvHTTxarF+W8iN9xE3prU4rybYv9P0Lc3JGroWLOM5MUMiKXwIXEkHKD8StHG1gEbIP7SzCrgO5FY39ZXMvkUrLVFB9JYaYLuGosx9mn6qS/MStdp62P/z0XIOtysSQrWQWLCrvKbBbL98cPDabTWKabVzovur+RttvzoDEvSk21YKo3Nd0GGuFmzccPPThN3DhyMTnTx/Y+Pj4+KU8Q8bWizvbxu8c2Ae+KQ9MP2r97nATvnqvtjz1+OT7JgcVwoTj3bVCmkXucJWvKAE27XYLquSzzeuazd8rtOFC70VrsAoWzDe63nvP/GblBWVEb4m6hmW6BubZ9PSKZnntJf3+3T2Phooz6aqqkVD7wOjPS+W2g92VWxOe/9a9V9x/5pMhvf6yd29WXt2wV2/jzd2jQV7/A+ltJvY= +api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -42,5 +42,5 @@ Get a list of schemas Schemas -
    Schema
    • Array [
      • config objectrequired
      fields object[]required
    • Array [
    • ]
    • ]
    +
    Schema
    • Array [
      • config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx b/docs/docs/api/v2/mgmt/get-sync-config.api.mdx index f8ce41ce71..285f99accb 100644 --- a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get Sync Config" sidebar_label: "Get Sync Config" hide_title: true hide_table_of_contents: true -api: eJzFV21v2zYQ/iuc9iUBLL/IL5KNYVjXDUXQDQj6gmGIg5QiKZutRKkkZdcw/N93RymyZCVLsS9zgFgmj3fP3T13Rx29vBCaWpmrG+6tvI2w7w+Kvc5VIjfewLN0Y7zVnXdeNN79wDOClVraA2wdvW8+LaT/ReCv+xPsamGKXBkBJ49eMB7jFxeGaVmgITDTscFyZYWyKEWLIpXMwRl9Nih69Azbiozikz0UAg7n8WfBLBwsNIK3sjIkeUvGWC0VKhffaFakuDRbzBPO4tAPFvHMn42XYz9azpi/CBmNZ5NxEMSxdxq0MTy8pHM5DwM+jmI/mSwTfxYx5tPlMvAnIg7H0wmfJguKOsF7K9X36VyIMKY0ivxoxrk/4zHzl+OA+pPZPAhYsIxmwuEE73eSC/2iwjAJA8HGoS/mbOLPwoT7EUvmvggnnE+mUTilCSpkVUJeDDQXCS1T+/C8fDfZVaLLimUkd8uGJLkma2+b79cesTkxwIhhzxQ8ypw/ZKZlRQJbNkKDbCaVzMrMWy3G8Gm5XP/uwviwFaTSR66kIplMUwk8zhU314hAl4pYkKmQQDwglBRMHZ6MrkK7d15SpimeUkQqpkUGPKYp7Lv1XKUHrJYujvV6/fQx3CB7gOWgUOKEEA0ocsgSqY3FzUHvrJMzQ9IoR9v/qlDshD7ghvOVljZ/MJZq+wAUhaAoyKSsCrD2Pc7zVFDVS+9NQqwuxaAJXmXSKSOoN4PEM5qmB7JH1Ch2NkCkIeAFBJoP1+q3ilorp3GtvNMJu8nXUmrBMdxnPrTSc++4m2UAvGKg6TecVwSSbUmekPdlQTdpKUgti6mPK+AAAVte5S7Vmh7gp7SiQ79niqJefoIqfRZeQCCKZqJTsdgRKWi7dL82cn9y7KSKU82/x2dGjfCNUEZauRPktu4c/2MILiC4EJArxEkanNedmLz+jphAKchHNP/NB6fh8GJLndIogAmS+GwZQd/nwdyPYx750+l0zsU0mQSM9ZCedQPYi72LngpNA2SdKcxKvfzAqaU9taCvN7R6E6c7Lppe/7QdMOEAdtP2RliCc5s0g7ugGtJmhTbuHuBo3AXsbEk8XVC79drAXc/oD/cngs3n0VSwMPDncw6DO5nO/eViEfnJgoXz5SKcMTYByOALgNnm9TXG4QObK2/UQmRGxy6+E3YSoXePTpQ6hSNbawuzGo3gYjM0dbUOZT7KNpkd7YIepZuKfnV7451aF6T36F9FrdY16czOQr4VSM86dmeZOmxbQbmbdRelfXtDQAoLFxprvicc2nmKRHbFTBkTxrhO6wCdUFuSo2F0tNIxHk4Ww6V3ZsCfVNGNmyfu1KBpQ6smt49+Yn4yKjFUPGfmlyZG0IdhrxvEzmaPVj/Ch9woq3Neuomwhr+/RArCAn1BJ7rICJgs3dhD8SH5Oy+hwylSQvOwW5gnKAMnM3eKsNLADIJW4y4O1S3EEGierSlkhmj17oe7dyWOVXKbGwvH768efcA5WcCaQhbEpbVg2Ow212eJ/X4/LKpj6Gjj9Wif6y+moEw0S35RxlCtoxySsZNif43GXRx+xQaI8D+++wMXP336tFYvkLGWclfCyn4rYf2i7US/IaIV3+yoSKl0elz+jnX93LUrGgfv6qLCge5bMIySx2MMHnzU6emEy19LuGPgW8HA21EtaYw8gyLj0uAzVGpCUyN6oJo3Au/qXd0wrsl5LnXBPpaSwqLZUWTnyoNHV2mX3eiEl4W6qBBJJfQK6qWwreO995BOd3nz+wfPXZm23VKu6rZ+QO1PQmvXeGUe/58Gz4j/hHSAJvFzI17tPHugaRmVNAYJ580/E0+/5g== +api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -50,5 +50,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    •  +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx index 2e241e1e7a..d08fca9549 100644 --- a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Sync Configs" sidebar_label: "List Sync Configs" hide_title: true hide_table_of_contents: true -api: eJzFVttu4zYQ/RVWfUkAyxf5bhRF022xCLoFgr2gKOzAS5GUzV2J1JKUHcPwv3eGUmzJTjbBvjQBEpscnjkzc2bIfaBzYaiTWt3yYBashPuwU+yNVolc2aAVOAr/ZvOgvnrfCqxghZFuB1v74CGkuQy/Cvx2f4BdLiwzMkdUwHwrHKEkldYRnRAEIid8I2yulRXgZB9E3S7+ax5v8mFaOaEcmtE8TyXz3DtfLNruA8vWIqP4ye1yAaepMXQH56QTma2t6/iLYA42coMZcLJkIHnNxjoj1QpsxAPN8hSXBqNhwlk8DqNRPAgH3Wk3nEwHLByNGY0HvW4UxXFwaNW5LV/CnA7HEe9O4jDpTZNwMGEspNNpFPZEPO72e7yfjChiQlqcVK/DHIlxTOlkEk4GnIcDHrNw2o1o2BsMo4hF08lAeJ4Q/UZyYV4EHCfjSLDuOBRD1gsH44SHE5YMQzHucd7rT8Z9miAg85V6OdFcJLRI3fJ5+6YKSgUUpVSJ9suWJNqQRbDW20VAnCYWpNK+cAUfpebLRvklqGglDNhmUsmsyILZqAs/tZCr700aH9eClHjkSiqSyRR0LSAIbq+RgSkUcWBTMoF8QCopuNo9mV2FfudBUqQpnlJEKmZEBvqmKez7da3SXXDRU4vF4uljuEG2QMtTocQbIRsA8swSaaARYbN1cdbb2TY5gqPv7wKKjTA73PCx0sLppXXUuCVIFJKioJKybMwq9ljrVFB1Ud7bhDhTiNYxeaVLD0YQN4PCM5qmO7JF1mh2ckCkJRAFJJq3F+qPUlozj7hQweGAY+ZbIY3gmO6THmrluffazTIgXirQXk6im9MQK3K6SgtBKlssfVwSBwo4Nn9o+lTLT0jlUoVnFIiimWh0LE5KCmjn4VdO7g9enVRxavhrYmbUitAKZaWTG0HuqsnxP6bgjIJPAblCnuTI87qRkzevyAm0gnxk82MxeITdiyO1TycR3CBJyKYTmPs8GoZxzCdhv98fctFPehFjF0xP2ED2bO9spsLQAFvvCqtSLS85dfQCFvAuLq2LG6d5XRxn/dN+wMXBM8yEW+vqbYEQ1K3hS6dm6htRGJgl1r8nCpOCxdq53M46HXhbtG0l9rbUnWyVuc4mulDEsSFu7m6DQ+2N8gHfBGVlai+VU3Fz+ZfA6voOmtVsoOAIvBaU+6virDPubglYoe5hLukt4TANU9SB7wXKmLDWDypP6IBoiUbHGGiJ0W33Ru1pcErg31TRlR/H/lTr2MVwrOL3GCdqKaMSU8U1s78dcwRjDPaaSWxsHs5D+Rl+yK1yRvPCD9QF/P4jUjAWGAsG0WRGwGXhbw00b5N/dQEDQpECes+tYRyjDZzM/CnCCgsjHDrV37vlJW4JzJ7aELdt9Dr/af6+wFuJ3Gnr4Pj91WMMeM3ksKZQBXHhHDi2m9X1yWK73bbz8hgGeoy6s9Xmq80pE8elMC9iEHtHQzE2Umyv0bnPw+84P5D+p/fvcPHz588L9YIYKyv/oir91wr2Dgfo2bO3kf/96VX7/cdypVgnHlwnT6n0Dn2h91VfzYNGX0EXrIEPru/3MQT2yaSHAy5/K+Dmxvd6K9hQI2mM8pvjLVjJHRvRN0pwA0rOsXU3FGU3u3x4Y7cd2/ztnx8D/xZYN5us7KjqA6I/bqldDbvefaV7/HtoPWP+CxYK2vfXo3m58+yBYzOX1phCHKT/AY4ZdYM= +api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -50,5 +50,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx index 382920c6be..6e7dfb6987 100644 --- a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of SyncRuns." sidebar_label: "Get SyncRuns" hide_title: true hide_table_of_contents: true -api: eJztWetT4sgW/1dyuV92qgzv4EDtTl1H3VlmBUeFsdS1Mk3SgcYkne3ugGj5v99zOgESQHRwd2s/jA/M43Sf33mfPj4WeEQFUYyHbbfQKgypupiFznkcysJeQZGhLLRuCotHt3sFSZ1YMDWD54+Fe5NEzLyjeHf7BG9dKh3BItwPdvtElUEMn0llcM+Y71KEnSMiSEAVFVLvE8IN0MPOkgt4zXD1nzEVM7iRzogGpNB6LKhZhGRSCRYO4Q29J0Hk65VH5VnnqH1/0jvA3+rvDwcPn3vdj53xmd8pH1c6s3q583D20Blf+Z279rRz2H846x1MC0+rmHsjakRkyEKtFCOBZEyIH1MgXkAFEmpL9kB3QVspl9cZd+NgQAUqSlAZ+0oaisOlikVogI0QVA6BE0vFAyps5u6CIZiZ8x3MymY1zN8b7SNDjYgy4pABC39mMJeGinmMAsgsIQuNGY+FQaLIZ47WYE5pgk9gqbD1/Q6gJfGp9Lhw6DOGSxkYmkGGMx+MqaNsvfPr+YZxgO7v8CAAFkCqSOgSgfpORMaAyKCbv35a47yLsMRxeByqzZIm26KLeMyHODIGs6y8aB4129E16H59YJG6Z3pVq2rWScMxm/WyY3o16/1+rd58b9Vrm1ElbME9ngUGOlKx3AXVRf/w8PjiYjPjZNscV+Mnh0hqslDSUDLFJvTdChABDsECCldBtAuiD9VytWKW4afRK9da1XrLqhXrtXqt2rh+FqYAowHTHNSicTHise+m76dMjQweUswFNx/2jJ9vDY/7Pp9SF+UiodG+ODXeN8oVY4G/mLe++09LBixfJ9d3CATBBakw4mBBiXirkDbhT555WlUwJHmowAGRJJN/SmOJdI8ZuYnvn3q67qQaWMQo5A9ItYol/EJ6rzbpKYx9nwxQUUrENBc5s8/R9WG70R6fzbo9x7oeOw8nvWEFypDqHvVrncOydTW+qp1cfh1fBWe1ztHncTdo33cP27Idfvbd4OvMqfbZaXA9GvzW9b2zX35BfUeCThiP5a5oPo6vj0bBVXB9d3LZt7oBojmeXgOa6/HZ/cklFMRxv3I1doPup3a9O1tBE57P3MuvTUSiuCK+nSSmJZhQ166sC0GJgywI9vszZoK6mEa1OjOygHkhW/hpNU0Lrnbj7WZJy2OGPRGCoGszRQP9HILnGQvPOR4RRYyAu9RvGaf6pVxjlC0aO5YHUEHKem0DeEWF4MIGh5dY21+07dPeWtbaGsUQxDWzXDWr1V6l2bKsVmW/aFlNHcH5FPFdbpXZtlpe2TYTeFh8tsJr7tcrVcsjpucNGmZ933PMQaXqmfW6YzUanmO5RDcm2Ubn+1qafL+xxYSjeAB5Bv0j02HAehZRV0DlgOsH0BiVd7akvg+3gbTdGWzLHGnXGpat1yEZH3HbEQH6AInAUXEtj5WgxBnB5ZBrxiTC/Dfn53Mv6RAgbYI3waXPQkowoBwf/g4Yvm5gIcPtAiLuqOI5tHbyEMSyHZ/Hrp12DzYNh+BcASZGoPeJc5dvWpaiL4IxpzU0AFF0yKF4bAsCLXKOGQ0Fc0bpzRIeicFCSayDl4Gy5rvnYCX7zSEtaJ50mg8hoF7jYbVqZZ8Sq2JWKs57s15zmmbTqu+bDa/S3KflKrVovZBEldqcXOfizZuPvUK7a385P/10ntz9etA+6Z8f60AHUltQhwtX2hKqEnU3Zchn42pDxsx3rYsctt66rBb8lTDcWzksLJqwfAJaDZiM5VfVvlHa2025e1PCPcY2kdH1jLtsW3+kyx/p8ke6/JEuvyddZg+9/94cmWl78Zkt4PDyBF+3+AESBVSNeDqLQ3ZEjeCmhLSmSOZykorJfHQWCx/dUqlItkolErGijKGd9mNaZLwUDANVmlQLq0e2i5TGOPjS1get+VjvAk9JSTLODPeWnXbEfqcoanrSXNKkp8wRJa42XJ4fsDGACk+HBA9+hksn1MfUrw/tEH2gXz1L0oCecDePI2MUNNmjXKw0is2Mm3dImIaPXpWcAEnSa6f45nKiHQPCUFUud+T/FjpK8kdeibmXa6fd/8KX0Q6V4G6sbf0HfF9SH4j16ReFyCMzgGWMN9rZisYVjw0HDr2xhAUjJjUNrAz0quw0DTwrGc5KOCS7xtK/ZBG53vznBo6+OHX7wqWC5bc/zWUATylG8CxELxjESgFjORm+W1JMp9NilCxDQRdSl6Zc3MmIOHTxyIziAcRKiYMxJoxO3yFzrYePRGqTGf3zE3z47du3P8IXnDGl0hUn4Z8xGI6MMxPonOofl0f8LaPl1FMVnDZLkU+YZqQN/JgG001hGUzg+iMAgQ8fHwcgTV/4T0/4OJmXYIi5TGIKgpj0iC/pFlTbhsfPINPxtZx8J7Stgj4Hv57xq4bHWxFkB9o7gvjrZsYv6Cqbp9+ANT8t3q6dlaS/nWuyJt+9vwHnplnvVrSL5vsNTJ8Z5W7lmy3Ab2D9ymHuViiL8v02HH/btPYl8CvNy5sM+ZdPZl9wAvcZ6Ld4I1jSzt1gD5h2C5hkk8UH0AhEWc9dm+TiLosW6dNxDzu5GLN6tkdJGpL0IjMGJOEss3e2eUnY42fmEJsn/xnrHHQ/Hxbky/8Kblyw6IUSalQSNnn/B12x/Zk= +api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","deprecated":true,"in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9"},"sync_id":{"type":"string","example":"629525f8-f6f7-436c-80fa-1cb23acc5bf8"},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["id","sync_id","object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9"},"sync_id":{"type":"string","example":"629525f8-f6f7-436c-80fa-1cb23acc5bf8"},"entity_id":{"type":"string","deprecated":true},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["id","sync_id","entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,9 +34,9 @@ Get a list of SyncRuns. ## Request -

    Query Parameters

      2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."}}>2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}}>
    +

    Query Parameters

      2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp."}}>2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp."}}>
    SyncRun -
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    +
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/get-syncs.api.mdx b/docs/docs/api/v2/mgmt/get-syncs.api.mdx index 68f19bc0d0..55ebcd2d0c 100644 --- a/docs/docs/api/v2/mgmt/get-syncs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-syncs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Syncs." sidebar_label: "Get Syncs" hide_title: true hide_table_of_contents: true -api: eJztWG1T2zgQ/is635frDE7ivBDCXG+OAtOGkrS0UAYoQ2VbThRs2bXkBJPJf79d2UnsQFJKubkv104pllf7PFrtq6dGGLGYKh6KrmvsGgOmPqfCkcaWoehAGrtXRvZ8vWVI5iQxVyksTo07k0bcvGX4dD2Dty6TTswj1AR63jJFKPG5VCT0iFZRAZ0RjWnAFIulViLgAYRBrQxjeM1x6/eExSk8SGfIAmrsTg2VRigmVczFAN6wOxpEvt55UEt7B92749M9/Fd/f793f3Taf9Mbnfi92qHVS5u13v3JfW904fduu5Pe/tn9yenexJitEj4dMhLRARfaFiSjRMbUTxgIL6iCCLuR/J49h61Vqz0E7ieBzWK0Usxk4itJVAi/qiQWBK4GSZUYOIlUYcDiG+4+h0OQmnMNpvW4GebvSfeAqCFVJBEcIPyUcJcJxT3OgGRRkAuShklMaBT53NEWLBktDsewNb7Rz88gLanPpBfGDltzcTkA0QAF5NAeMUfdaM1PxxVJgI7vhEEAECCqqHBpjPbOjozRUGA3f/0ot4wCQRC8WY/74P7ETh/SfFYAhEJR2LoReg0q3qVKn+lHrN20W7TpmV69VTebdNsxO82aY3qN1k670ezstJqNx1llsOBLK8TAphABUSgkk4hdh2iB/8oKMJPgNcCxQQ++L/hcdSRRaFo4APX9D57ONflRFqYGn4HwUjwDE+xOPXZgkfg+tfHEKk5YyQDpUXS5393ujk7S/qnTuhw598enAwtSj+ofnDV6+7XWxeiicXz+ZXQRnDR6B0ejftC96+93ZVcc+W7wJXXqZ/xDcDm03/V97+T1azRYFLMxDxP5XDZvRpcHw+AiuLw9Pj9r9QNkczi5BDaXo5O743NIgqMz62LkBv233WY/XWEjPqXu+ZcOMlGhov6NEyaiaBqh81XRFyCtzWZ4ed8THjMXQ0ebs3AWuFu4dD/PoHmS1b64+VrylFiAp3FM0Ue5YoFeDwVbc8NzxAOqKAlCl/m75BCdD5WvIkEUbPT3Ttty7Pa2a3ZarR2zWfeYueM1bHOHthqW06jbbsvTRtMa1ieVzPvLCSRfm20VQnIjmXbNpY2dRs2021bbbHYc2+xYXs2s1z274dU6tNOmqA7CRIAtwNY/VNmoW21GW5ZpWQ6cr+F04KTNtrntWZ02q9VZizVRpYQABJ8QHh+8hM6WdnmaSFbUZYehz6goKvOoL5kOj2It2Qg/TGxIJzo3Fovmz5THFbfWqTIvJsXsWbbzAyMtTrhKv0zs+rF4eMyJP+iX/50P5+RKPpyvwe5izX3h6pqDPLUi/u/+/577lzurhbu+VCQUCoZWMeFqeLPYAh5xM5cHlrPZNf4AtjBbDMN8jtFgaggPVZmPNJLF4/nskcQ+GkmpSO5WqzDMVGQCtQn6/QoPq8EgUNVx3VhtYD7nMmTvY1e3LPOh6DO2HFkYFkajZdmK+HuGdSvvvZYyee81ZNTVZbWMBzAEpLBVglYmnBCXjZmPQa/nBOo4TGbNuCY0Q21eiMB40ExHrWJtVzqFXNKjAoaKADKY3rW1iJndRW84Pyd6R0A5msoNHfn3wkYQvvCubMTSywe93+/wh3SFikM30R7yFf6eMx+EdWeMhygzIwCZ4INuFyrkIkyIQwUBDwJpLrUM7Az0ruI4otggG2olAV8hS6+UFUS9+u3qUyJwbPkYSgXbr/+YnyFORCWCNYFeYCdKAbAcD14tJSaTSSXKtuFBF6euTsL4VkbUYYslM0psaE6rIVzGmLPJKwTXdnhDpb4ycvbpGBe/ffv2VfzAGXMpnTIy/MKF4cA9n9xLdp8um+V1U3nuowqatmrkU64h9NVO8xC6MuT8K8AQoHFhOrXhDGexP5vhcjY7YGC5XGKP6uZJawOdTTP3GlY6qpYfDDLZXUO3kk8HftLMvZFB8TvAM0m83Kj9A1sVvxf8AtfykL3ZOiu5/RdQ147PGwmUq9MLwP8k8q+BrpmQN+IW29El9DU+xDybGa+gwZzXGQzUbOMelJCoSPjBQI1aFoX17eEpyNIEs0KxumWlLP+lMI1RkRZ0F8teBo8/C31vWfxPzJBQN/9aiC8/yD26YVFFM2k0ELYG/wD79hDS +api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","deprecated":true,"in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,9 +34,9 @@ Get a list of Syncs. ## Request -

    Query Parameters

    +

    Query Parameters

    Sync -
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    +
    Schema
      results object[]
    • Array [
      • oneOf
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx b/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx index b41b4819d9..42075da786 100644 --- a/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List entity mappings." sidebar_label: "List entity mappings." hide_title: true hide_table_of_contents: true -api: eJytVltvGjsQ/iuuz0sjwW7ah0rlqTk6VRW1Vau01VFFETG7A7j12q4vEIT472fGuyzLQqgUneQBmBnPfN/c7C0vwTooRICSj4KLMODGghNBGn2LIq6kD291kGHzUVgr9cLzAQ8CP0Zj3lNMBtxDER3KULvlN1a+h81NDEv8Odmh2gonKgjgfDLQ+ANjPAyL6IOpwA1lie6lRuESRAkOf/liCZXgoy0PG0vmPjgMhxp4EJVVJKo2Bxcv+G6AtHzhpCUaqP66BLbXs9t/WFiKwKKWvyOoDZMlII+5BI+KjqHUbGOiY0hPySKlBIM6+B2l26drN+iwsM6s0JkbJslTeHihwM+NK+A8iX0E1kTogZmQxFujPXgK9PL6mj6O/XzAijIzZ5CKx6pDWQujA0rpSIdz/tPTue0pAeGc2BDPAJXvyM3sJxQBFQgXmynIGk0dcIolPskBkm20dTLP6IVSZj0VZSkJlFBTLJgqpy38w5mZMQqEpkMNEiKk1Kd5arrLIGvtmRrpWFHL+yB0KRy1ad0ofIJxHkG961ZoXGsbYywV8q2L3ricGjetfU4bcNRdl+HOHSK4ALeEFSg60OLFr5M+sOQFBxTFj2b1acVO7s7Wk0JAecHgidQQoe+0ybm+6LE/gto/jrk6b542Vbdp/9yiJ9ntNAGCX2A6GoeNBULdpfhnJrg3vhl6x826NLS0F5AKImjx8vzYJ8Hw4Fb7HRydoi0VgvWjPBdWZj5asVARMmnyalGFfPWS9yF8aWzYzedbvuss/i+0JOoWeBiit+Ev2HS7KF0J+yEYdWz66/I4HoZhaMWCYSnLrK2+T7KiAF+v7wSIukDPDQUmorWP6+zFq+w1P+T8o9BigWh1SKfqBSjqfdHg2/OkWldCUqpKU/g3bY4KbNJBL4lHypPq/YV/7FYHZ8pYkOwH/v8LCo2BuBCJY2QMQ0b6kfZxxr6byAqhWfR4YCl9ssGTVTrVvcACLOq73DPcMQz5aUgxfUZRx8/Gd1HTRffZ+IDHJ8/3HFzUmUWZpi6YxRAwsF8trg4W6/U6s/UxItqyztfG/fJWFNCKhjbO8DrJDRZjJWF9RcFTHv4WPpWMfbv7QML7+/sf+g/N2FhRZpv4nYI9NhtHNWjbMcBDyK0SMnlLVdw2c9MOendalxiPVNvtDIF/c2q3IzG+Ixw9efDrSjgpZtReY9pFTTvToJXSkwLncy6UhxNI7e3Ln9816+aK/Z8vl7Oc03ievMBWgnp+xNMN9GTg/dfKRQD9x9MRhNroBqfcho7u5JVCm6jdgu/efsVN8B/p+tD9 +api: {"deprecated":true,"operationId":"listEntityMappings","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of entity mappings","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string"},"entity_name":{"type":"string"},"allow_additional_field_mappings":{"type":"boolean"},"object":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},{"type":"object","properties":{"from":{"type":"string","enum":["developer","customer"]}},"required":["from"]}]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string"},"mapped_field":{"type":"string"},"from":{"type":"string","enum":["developer","customer"]},"is_additional":{"type":"boolean"}},"required":["entity_field","is_additional"]}}},"required":["entity_id","entity_name","allow_additional_field_mappings","field_mappings"],"title":"merged_entity_mapping"}}}}}},"description":"List entity mappings.","method":"get","path":"/entity_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entity mappings.","description":{"type":"text/plain"},"url":{"path":["entity_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx b/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx index df1ca5c9f4..1421e9401d 100644 --- a/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List schema mappings" sidebar_label: "List schema mappings" hide_title: true hide_table_of_contents: true -api: eJytVm1v2zYQ/isc9yUBbDkp0qQxhmEd9oJgLVakLYohNWxKOltsJVIlKTuG4f++O+rFlO0kW9AUaCLe8e6ee3mOG55CaSARDlI+dqaCAdclGOGkVjd4xHNp3R8S8vStKEupFpYPuBP4a3zH3ycZFKITTAbcQlIZ6dYo3fD7oSjl8CvQ12SL0lIYUYADY71c4Qd6uB8mlXW6ADOUKVqXCg8zECkY/LLeBx9vuFuXpG6dQW8ogXtRlDkdFeudiXO+HSAomxhZEggUf8iAtXJ28xtzmXCsUvJbBfmayRSUk3MJFgWBolRsrSvDEF0uE58QdGrgWyVNm6ztIEBRGr1EY2boT56Dw4oc7FybBI6DaD2wxsNeMBM6saVWFiw5enF2Rr/6dt5gPZmeMx1/gcRZJlRKuKVhc6oyK5pqshM5ZxbcKfpJtHKYJDIWZGP0xZLFzSE0YYxYUwYcFDY4r32iAIFgkzlZx1kfT+tEPpYfikOgAUxOc6fWPXJHVQV1aKKLwtfNOgQqTMoneFnkuV5NRZpKwiHyqYc+baEHBmOtcxAqjKKuewN6ih37aMgvz6+ur+BVOpyfvTofXlxfpsPra0iGL+HiPL64vErnFzHh8RHY5+fwoeQdNhFpUgNQs9clF5YKTQ1PZ001QxD4LXOKUlrKGqTTeD1tB+VotvpuP2WAlk3gcoU+vSUWr/tjd6IVDmXTZnEOTM6DsFhGFx8vnwfjNKNCnfJdqUiOof/3TNUXfMLSpzPWIklhCTmVJmI3foIGfYCJUErjCC7BGBzmiP1NgLXyRZkdxjpj2rBZe70vsZmuMJwYyE9EWI/p/W+0R8HuFeq7xr0NueyOtwR6rNuQ5Jx0Ne2DWaC0qz7a2TMUMkufM54mgXDEu/kMvDfW9m5t/c9+fj3pNm0SOMBdmGlasgvwEy1chh+jw0DALNulWZmc1opzpR2PRrhgI1uVYpFXEEk9KhaFGy1fHBT4faPDXr+74dtgUfsVXlNIsK53LFTKv4BoqNtyrc7+fuv7QzcMtWgMfZ53U2H9WZKArfetD4ioRc01OSagtY2z6Pwyuua7jL8VSiwwWuX8rUG3Dzr+63ASfXnSGvNUJ/aXLke4EFDWT2JPeFC7H/GH3ShndFoldPYZ/32CHJXB0wyC6EfG0GVFH35NRuwfXdHUs8rihUxar4M3C38rfHE4WNRPr3ovIz4F3qeNyOvdD3e3lSLaeaetw+uTkxaDqVRU4pmiLogr59CxXS5Odxqr1Soq62sEtEM9Wmnz1ZYige5oWFYx0u+IOGopYXVKzn0efhXWl4x9vH1Dh7PZ7LN6ohkbLcps4z8o2AOT0StB140O7t2ozIX0xnwRN83U3PG9qcEez9AbSTabGMP+aPLtlo7x2Wf8k3TAl8JIWjL+gTpom5nGLJWWBDicc5FbOIioexLxk9uGcE7Z93xoHoXsh/PgwbwU1PFjzuk5+uzA9x+Xjwaw/9bthVArvcYZL10gO3g6Eg91FPjn7x+IlCsqZkg/Ndc0f1BlWpFaB7ZDXqrd0/8UzFH1n6iFkdh+7tRryYMXOpqrtSkZE+T5fwHdeJ4t +api: {"deprecated":true,"operationId":"listFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"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."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}}},"description":"List schema mappings","method":"get","path":"/field_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/management-api.info.mdx b/docs/docs/api/v2/mgmt/management-api.info.mdx index 2b0d624632..cc1d24b908 100644 --- a/docs/docs/api/v2/mgmt/management-api.info.mdx +++ b/docs/docs/api/v2/mgmt/management-api.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx b/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx index ea1c412a9d..6e2daa18f5 100644 --- a/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx +++ b/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of am object field mapping" sidebar_label: "Object field mapping created" hide_title: true hide_table_of_contents: true -api: eJzlVktv20YQ/itb9tIAoiTqLZ/aGC4QtGkDGUFQOAa9XA6ljUguuw/JrsH/3pmlHqYcyz71Uvsg7uy855uZfQxSqDQIbiENLqx20EGKEVpWVqoyuAj+UFZmEhnwyFTG7AqY0HA484Kp5BsIyzIJecoKXlWyXAadQFWgPdsHVB00TL8Sz8eG5ZK0oNlOcB/CBkob2ocKDqxdry/e6euKA7flSxNc3ARfIFkptWZXJGuC206g4W8Hxr5X6UNw8RgIVVq8ok9Uku+C6H0zFNhjAPe8qHKgz22jKvZuxG9zA7WXeI8aY0kBwrAvkmQ+DMdJfxyOotkkTCYphBEXIur3o+F0PkaxJ540ctMkE2I6SkMxnyXhaI4iM5hl4TAVUx5NB9NhNiFzzlhVgG6ExFSMB/0RDydROgxHIz4Nk/EsCnmUDebJYDjPZnMUqrTayBSFSl5QSIbnYDKlBVB9fHz7q0tMFhf2SN9lQaiiwHx1AiNWUPDG/CBLk7Q/TMMI7YUjmExCPoZJOEimw0hMIx4NKEUajMsx/8HVYvHnAgmgtdJxAcbwJSm/ojPbn+u9ESpJqwhNKIgnK8G8VLCDjLG6QSCUriCknK0k4uaAhPOc9bOif8fkQdWb8FA/B8Q5nW/CSn0ClnMK34Sj+hmQXk71yiWmUlSwFtYqWUGq5Ya+/4ESR8w6NpDneCxMnD6gWilMPJyMYy9HbGqlYqELwj6vEEges85iMcQKP5fKG+aVynO1t5erjGxLbHyNyMXPXJbANSnJ8TeRdD0xUBpSV3C9Bqta3sYNEcOKRa5cGmO9lEOUQblElBY0UZA/52Ldxs4xdCutp7SzVp+03Lm67LuxPmnHlxN/7FPLy5RrBHbdatpz5t7Uz/WxoV924/rz5eXV9TVSmp4nJ066/pwjJwOhbma61LSdbr7X9act+ayf2s1wiuR2SdrJfpq9Q+i3dd14haVGDPlhNOj36ae9NxdgnS4ZZ3jLsCbWGWYVk2VKzgHuUW79Mk255WzLDcM1DNghKTNOCMxA5vL8wecA7nGPGdRLe+8xWAOut/bS7AQbnrvXJxgCtgC7Un5hbRooV9yu8LhLLoUNegO6seV0TtC2tjIXvR6vZNe4ii/RVleqXrEsbG8zCE4fDdc7HvbLpw/eqAHhtLQP15TRJmv3IWoLfSwHRCDlNyR0gt1SOvJQT5MjwLF2z+yhGYZclGCO02DLUgwup4Xhk859Pn22vUOYUnoELI7Phav/31vgOK7+w4fAcTy8+hSQZaaoHgTFpsr9bjTpzp/M14+83E1kX1dfB+87iu2i2SORLBZcEphTJczPBxQ3W6IN89ZlfQq2H/GPfSitVqnzNf+K/18gR2YgtBHM2p4xNOno4EvdZX8pxwQvmTM0B6TxPChZeCm2Ly+jNbZs3tCG4VRnR5yZLlm9+eFm4UrkY5+UsSh++9M+Bu3KboW0kvo0cdaiYbNZvjtybLfbbtWIUaCHqHtbpdem4gIOpLByCSK1p7AYGwnbd2Tc5+E9N76p2OfF70S8u7v7Wr4yLnZc2If/Av2hOkQ= +api: {"deprecated":true,"description":"Notification of the creation of am object field mapping","operationId":"objectFieldMappingCreated","x-event-type":"object.field_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.created"],"example":"object.field_mapping.created"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx b/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx index 138a3ec50a..cb5b5488b5 100644 --- a/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx +++ b/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an object field mapping" sidebar_label: "Object field mapping updated" hide_title: true hide_table_of_contents: true -api: eJzlVltP40YU/itT96Ur4STOPTy1i6iE2m1XQWhVsciMx8fJbGyPO5cEivzfe844FxyWwFNfChJ4Zs79fOfyFKRQaRDcQhqcW+3gDG+M0LKyUpXBefCHsjKTSIBHpjLGS+aqFOmZVXRQyTcQlmUS8pQVvKpkuQjOAlWB9jxXKDdoiH4lmk8NyY2XkSLlQwhrKG1oHyvYk3a8vHgrr+P21JYvTHB+G3yBZKnUil0SrwnuzgINfzsw9qNKH4Pzp0Co0uITfaKQfOtB95shr54CeOBFlQN9bhpRsTcjfp8ZKL3Ed5QYS3IQBj2RJLNBOEp6o3AYTcdhMk4hjLgQUa8XDSazEbI9s6ThmySZEJNhGorZNAmHM2SZwjQLB6mY8GjSnwyyMalzxqoCdMMkJmLU7w15OI7SQTgc8kmYjKZRyKOsP0v6g1k2nSFTpdVapshU8oJcMjwHkyktgPLj/ds9XWCwuLCH+20UhCoKjNdZYMQSCt6o72dpkvYGaRihvnAI43HIRzAO+8lkEIlJxKM+hUiDcTnGP7icz/+c4wVorXRcgDF8QcIv6cx253qnhFLSSkLjCuLJSjCvJWzPY6xuEAilKwgpJzOJuNkj4TRl/SLp31G5F/UuPNQvAXFK5ruwUh+B5ZTAd+GofgGk10O9dImpFCWshbVKVpBquabvf6DE/rKKDeQ5HgsTp48oVgoTD8aj2PMRmVqqWOiCsM8rBJLHrLMauFji50J5xbxSea52+nKVkW6Jha8RufiZyxK4JiE5/k8kPY8NlIbEFVyvwKqWtXFziW7FIlcujTFfyiHKoFwgSgvqKEifc7FqY+fgupXW37SjVh+V3Km87KqxPirH1wN/qFPLy5RrBHbdKtpT6t5Vz/WhoF834/rm4uLy+hpvmponI46q/pQhRw2hbnq61DSabr9X9ccl+aKe2sVwjOR2StrBfh69vet3dd1YhalGDPlm1O/16F97aM7BOl0yzvCVYU6sMzQuZZmScTg6l9ziH2DYWzjbcMNwBgNWSMqMEwIjkLk8f/QxgAecYwbl0tx7ClaA4609NM+CNc/d2x0MAVuAXSo/sNYNlCtul3jcBpfcBr0G3ehyOidoW1uZ826XV7JjXMUXqKsjVbdYFLa77gfHG8P1lob98vnKKzUgnJb28Zoi2kTtIURpofdljwi8+Q0vzoLtUDrQUE2TIcAxdy/0oRqGVH4fwW6wYSk6l9PA8EHnPp4+2t4gDCktAfPDunD5/9sFDu3qP1wEDu3hzVVAlpmifBAUmyz3OtG4M3vWXz/xctuRfV59HrztyLb1ZodE0lhwSWBOlTA/71HcTIk2zFuP9THYfsQfdlVarVLnc/4Vf79AjsR+IyaYtS1jqNLRwae6w/5Sjgnaog31AWk8DXIWnovt0stojC2aHdrgop2yA85Mh7Te/nA7dyXSsc/KWGS/+2nng3Zlp8K7kuo0cdaiYrNefDhQbDabTtWwkaN7r7sbpVem4gL2V2HlEkRqV2Ey1hI2H0i5j8NHbnxRsZv573R5f3//tXyjXWypsA7/BY7BOXg= +api: {"deprecated":true,"description":"Notification of an update to an object field mapping","operationId":"objectFieldMappingUpdated","x-event-type":"object.field_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.updated"],"example":"object.field_mapping.updated"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/pause-sync.api.mdx b/docs/docs/api/v2/mgmt/pause-sync.api.mdx index 6e2f65f935..ce56adeb76 100644 --- a/docs/docs/api/v2/mgmt/pause-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/pause-sync.api.mdx @@ -5,7 +5,7 @@ description: "Pause sync" sidebar_label: "Pause sync" hide_title: true hide_table_of_contents: true -api: eJztWG1v2zYQ/iuc9mEJYPktfomNYVib9kOwDQmSFsOQBCktnW22EqmKlB3D8H/fHSnJku0mXZsWGLYYSKzj8V6eu3tEZu2pBFJuhJLnoTf2Ep5puF7JwGt4hs+0N77x6FF7dw1PQ5ClwqxQuPYefJ4I/wPQ090GV1P4mIE2L1WIorV9FCmgUZNm0PACJQ1IQ0s8SSIRWKet91pJkulgDjGnb0rCxdS6MKsEMCY1eQ+BoYCEiUjwihvOYhVCNGavJUoFaFxOUsrFPqAZoIXVvQjpIbekTSrkDFVD0EEqEooAxW/mwJw6EyEzik1FZCBlk5W32TQqmdxUrN5tGp8X4YVd3A/Qbbp3JvZDBJnF5DFQcYxRIvqGy5CnIX4NMm1UTCWBBx4nkdtYLu9n53wx8rGTX6MI/lAIpfEzLB63Ge7bvkzVQoRornBSsc+OAq6BaZAaq7SA4z1AqyiUsXw2tmcWHHbtmufrEK6hWaL+/FgGj2B5nSV8FmVwCMvPhe5us3GaOlFSOyS67Tb9qTukuWZ24G1Pfef5PDyYW5iG7e4AenDqd/rh0O+dhqf+ZDQa+tNuf9SdDPq9QWdEkD9VXTex9ermsk3jcZbYbhj1YBBMBoHfhuDU73VPpv7p6fDE73ba/d5oOOKDSYfMIYgSsUDgnjR50u0Mgfc7fqdDJk+CkT/q94b+YNoZDaHdhT70yKTGKt2j3amYPYfNPtnMi761NVEqAi6rxqY80rDbcoI6JW+4LXS7ee8FXXr8atL8Xl1TTFPVdi4rx/z5qfsZGKRg4590wSGSx3CAh/9bzXqQK79B3z7+Qvo3du836dTiPVfv0v+b8h825d22CUnJ27hXfx3rS9Jm2p3pE54i0Hig0PYNblEf41ne0RKkvnUgaN8cOPII+S9f/Z/GLV5tTdg34T4zFevs/BUzc25YJgXeGCI6dNO7ZIpDggsVRSHZSmUpq5xHvMbOxYIGs8wiycnPt5IvyUPzCPRUpQEcTqLwwHIPO8FgQRDdubJXKaWNRdzM8alFBdCte1s7CgbSRVGFLI0oTmMSPW618FrV1Pl8NIVqxbPYtBbdT84Qe3F57m0q1zNLPo5wKpe0MmuU/IaCxha2QmcXsLo/dMNQi86kPIrUkoWwgIjoTVtZEIB2BbQBIXx0drza3gpfFyjXLmdFFTbkfapolYBxPtvNzqA5qnDtH1zyGWYnjfXSKBlmXLZBgQvVNeaCoA1VoH8tMUViw7U66LXFvcr/iD/sXJpUhZkdzFv8/AkRKts7ACVdj4yhy4webNc22V8qYwGXjEbRzIW2OrgztruqLW9g5u7jmiHXsi0Z6CZ5vfnh5iqTNBqX2F+4/e6oyCHNZDNBmaSumWTGoGO9mB1vNZbLZTNx2yjRMuvWUqUfdMIDKEV+kk1w6FoKi7EQsDwm5xaHl3SSoPDfXv1Ownfv3t3KJ5o317LM6fxXClYjqBrwZc8aeDCtJOLCmrClW+eTdWOpj06K+WzhJMxp9HBlvZ5gsG/TaLMhMXZiav9d0fAWPBV8Qi11g+/2ouVpGEOhaSHM+XsvovKe5B1d5cN/zJ6T3w6mbEd4j6cXnPp87HnEgl8c+C6nPRrALsXWQnBKZ86R/8a91wqNvVvldscL5I7EPKpbZdbLi+s3qDzJ/9NERy+UpnxJhIy/x94tfuiVapO3TGjlay/icpbhxKGOs0s8xTNqpCpBOjbMv1SuulyuKlFWmdMlQr8rR8W6+s80NEi9v5TqbuWTG0oidtpUCLrc/w0PV6GH +api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"Contact"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,9 +34,9 @@ Pause sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync paused -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/providers.tag.mdx b/docs/docs/api/v2/mgmt/providers.tag.mdx deleted file mode 100644 index fca488489d..0000000000 --- a/docs/docs/api/v2/mgmt/providers.tag.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -id: providers -title: "Providers" -description: "Providers" -custom_edit_url: null ---- - - - -A `Provider` is a third-party SaaS tool we can connect to (e.g. Salesforce). - - - -```mdx-code-block -import DocCardList from '@theme/DocCardList'; -import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; - - -``` - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/resume-sync.api.mdx b/docs/docs/api/v2/mgmt/resume-sync.api.mdx index d718ad6840..d5a33206f3 100644 --- a/docs/docs/api/v2/mgmt/resume-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/resume-sync.api.mdx @@ -5,7 +5,7 @@ description: "Resume sync" sidebar_label: "Resume sync" hide_title: true hide_table_of_contents: true -api: eJztWFtv2zYU/iuc9rAGMG3drIsxDOvtIdiGBkmLYUiDlKIoR61uEyk7huH/vnMoS5btXLou7cO2GHAs8vDc+J2Ph1obZSVqptKyOI2NmVEL2eTiYlVwY2QoNpfG7NLAR2lcjQwpeFOnagWDa+OWsiqlnwQ+XW1gthZ/NkKqF2UMQ2v9mNYCtKq6ESODl4UShcIpVlVZyrXVyUdZFjgm+Y3IGf4qC/Em0SbUqhLgVBl9FFyhQ6nKcOAVU4zkZSyyGXldwGgqJExXNQajH0CNwInVdRrjw1aTVHVazEFU3LK80rp4EjHP9EzKXYdRl3kODVjA6dS0uGeGYRJEJiyIheR1WqHLsOjtjSCtfpLGRJUkSTMlahKtjM1mNAj9cuDG1Wb0eSG90ZPHEbWLrlsVd8RUNDla5GWeg5ewXYoVMatj+Mkbqcoc93AX+WD6OLrWFkEbB/GNOucfTivsNtMR3q/7obQNY+0tAsw2m1ZSVmUh27TYpon/9u0gZkmLZh3/NwbfY6jzTdsTrgioNY196gZxQKMw9GliT0M78qauZ4WY6sf2ukXX/r5uxzajzy2B0BUejzxOTcED6tpOQoPAd6htmVM39EPmRRaqgyQWkAtI3KMqHdvyBZta1LJQpcNDGk5dn3qJFfrCtMVUuKhSwjZdg94knT+FzinqrFgjxVBXVJaZYMVQWcIyKQ4xlyJStojbpe4w7iOne4v/uMC/FWq6chrq3o715f30NPMEzHFWl4s0FvUPsiORguWCPONMCiJFIaEaF+LkvwbWO8nyK+D2pd5yctGy5b8BvV8FqRdNxeZZI/ZR+j8o/yYor3YgRCF9oHXWW7QZNmcsCk2XOtznAKnQpQEPbOpyOwgtJ3JcgFSHqO5g3DsXjTjyTDsJAupj1+e6iUmD0LEpD+3EEqbjuKF75DYsY75j+xYckkkCYE6ciAa+HVB76jPAueX7/I7oZkZiR45gNqMeswR1w8ChoZVYNLSZG0du7LNokIQuy7rp2QfZue5tiGxb9YrVADHopaTuXTTeZtCit4QsaqpTm+LCG8GAQdG3vum5HzH5aqdC9wDHnNzNk9NXRN0wRZoihYtAhq0xJjoBeoCJgWBakFXZ1GTQiRmjg/sCUlIfRbWlfapHviQOyTIhk7Lm4u4gOgtka+HAGYAiZPemxB2sSql0xtUNPE1wA+Tkum010RtRL7ptaOoMHVWqkrPJBK5LY7mlhnFaTvJ5riYL+176IM/PTo3N4Nqlebfl2sHlqw8bRn4RCO8+b53MYcb27YEZAlLYj7MsK5ckFguRIbNLPca5kO0Oaocgf9g2n+9ue693VTmsrM+6WW3Qt6TEtZi21iNzbHnjcHAI/cYKNofYC6V9GPXUO+tR0mUNtz1nKSY+Lrn8uc84MD7M7W/J3uQRML6HP3JaqLqMG1367+Hzu8hAWF+KMCX7nhEw2eCDBvWY/FE2hLOCQDGDdCq1DKzM9aphRSgxb6/hksAhRHZ0I8do9fK7y/OmwMo5A/jB8qtnXQx1U4wrGCsQU1GjFBiWi/nJTmK5XI6rdhkG2kc9WZb1J1kxLvohWjUR1OSkhM1YpGJ5gsZ1Hl5gi4Xuvzv/FQc/fPjwvngE2lspfaS09gcbtk9ge5nvIa3ErZpUGUu1Dr13623lXWpuxR66qz2olBusTZharyNw912dbTY4DEit9WuKkbFgdcoiBNUltD1dSWCxxqnEiY50j1zqr5DGs/MtO5yQpyTAO2PWJX5E5AuGSJ8ZBtLkFzt+SHoPOnDIwXsutEIvW0P0bXvkdxJHF+7diufALZV6UHZIvWdvLt6CcLR9w4RdKb6zYktkbPieGe/hg92GDl4zpR5fGxkr5g3UHMi0epHHWINIGhJoy5bbH4O3AKxYDbwcMmsbCH4Puuh98R+xbICaf+rF25l7F/RE3UrjRuCLj78A7eeI+g== +api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"contact"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,9 +34,9 @@ Resume sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync resumed -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/sidebar.js b/docs/docs/api/v2/mgmt/sidebar.js index b23579b899..5ec77ce6a6 100644 --- a/docs/docs/api/v2/mgmt/sidebar.js +++ b/docs/docs/api/v2/mgmt/sidebar.js @@ -1 +1 @@ -module.exports = [{"type":"doc","id":"api/v2/mgmt/management-api"},{"type":"category","label":"Customers","link":{"type":"doc","id":"api/v2/mgmt/customers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-customers","label":"List customers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-customer","label":"Upsert customer","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/get-customer","label":"Get customer","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-customer","label":"Delete customer","className":"api-method delete"}]},{"type":"category","label":"Connections","link":{"type":"doc","id":"api/v2/mgmt/connections"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connections","label":"List connections","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-connection","label":"Create a connection","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider-user-id","label":"Get logged in User ID and details","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/get-connection","label":"Get connection","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-connection","label":"Delete connection","className":"api-method delete"}]},{"type":"category","label":"ConnectionSyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/connection-sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connection-sync-config","label":"Get connection sync config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-connection-sync-config","label":"Upsert connection sync config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-connection-sync-config","label":"Delete connection sync config","className":"api-method delete"}]},{"type":"category","label":"Destinations","link":{"type":"doc","id":"api/v2/mgmt/destinations"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-destinations","label":"List destinations","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-destination","label":"Create destination","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-destination","label":"Get destination","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-destination","label":"Update destination","className":"api-method put"}]},{"type":"category","label":"Magic Links","link":{"type":"doc","id":"api/v2/mgmt/magic-links"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-magic-links","label":"List magic links","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-magic-link","label":"Create magic link","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/delete-magic-link","label":"Delete magic link","className":"api-method delete"}]},{"type":"category","label":"Providers","link":{"type":"doc","id":"api/v2/mgmt/providers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-providers","label":"List providers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-provider","label":"Create provider","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider","label":"Get provider","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-provider","label":"Update provider","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-provider","label":"Delete provider","className":"api-method delete"}]},{"type":"category","label":"Schemas","link":{"type":"doc","id":"api/v2/mgmt/schemas"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-schemas","label":"List schemas","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-schema","label":"Create schema","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-schema","label":"Get schema","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-schema","label":"Update schema","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-schema","label":"Delete schema","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Entities","link":{"type":"doc","id":"api/v2/mgmt/entities"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-entities","label":"List entities","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-entity","label":"Create entity","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-entity","label":"Get entity","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-entity","label":"Update entity","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity","label":"Delete entity","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"EntityMappings","link":{"type":"doc","id":"api/v2/mgmt/entity-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-entity-mappings","label":"List entity mappings.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-entity-mapping","label":"Upsert entity mapping","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity-mapping","label":"Delete entity mapping","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"SchemaMappings","link":{"type":"doc","id":"api/v2/mgmt/schema-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-field-mappings","label":"List schema mappings","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-object-field-mappings","label":"Update schema mappings","className":"menu__list-item--deprecated api-method put"}]},{"type":"category","label":"SyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-configs","label":"List Sync Configs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-sync-config","label":"Create Sync Config","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-sync-config","label":"Get Sync Config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-sync-config","label":"Update Sync Config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-sync-config","label":"Delete Sync Config","className":"api-method delete"}]},{"type":"category","label":"SyncRuns","link":{"type":"doc","id":"api/v2/mgmt/sync-runs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-runs","label":"Get SyncRuns","className":"api-method get"}]},{"type":"category","label":"Syncs","link":{"type":"doc","id":"api/v2/mgmt/syncs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-syncs","label":"Get Syncs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/pause-sync","label":"Pause sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/resume-sync","label":"Resume sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/trigger-sync","label":"Trigger sync","className":"api-method post"}]},{"type":"category","label":"Webhook Events","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/sync-complete","label":"Sync complete","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-created","label":"Customer connection created","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-deleted","label":"Customer connection deleted","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-created","label":"Entity mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-updated","label":"Entity mapping updated","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-deleted","label":"Entity mapping deleted","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-created","label":"Object field mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-updated","label":"Object field mapping updated","className":"menu__list-item--deprecated api-method event"}]}]; \ No newline at end of file +module.exports = [{"type":"doc","id":"api/v2/mgmt/management-api"},{"type":"category","label":"Customers","link":{"type":"doc","id":"api/v2/mgmt/customers"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-customers","label":"List customers","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-customer","label":"Upsert customer","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/get-customer","label":"Get customer","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-customer","label":"Delete customer","className":"api-method delete"}]},{"type":"category","label":"Connections","link":{"type":"doc","id":"api/v2/mgmt/connections"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connections","label":"List connections","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-connection","label":"Create a connection","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-provider-user-id","label":"Get logged in User ID and details","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/get-connection","label":"Get connection","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/delete-connection","label":"Delete connection","className":"api-method delete"}]},{"type":"category","label":"ConnectionSyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/connection-sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-connection-sync-config","label":"Get connection sync config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-connection-sync-config","label":"Upsert connection sync config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-connection-sync-config","label":"Delete connection sync config","className":"api-method delete"}]},{"type":"category","label":"Magic Links","link":{"type":"doc","id":"api/v2/mgmt/magic-links"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-magic-links","label":"List magic links","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-magic-link","label":"Create magic link","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/delete-magic-link","label":"Delete magic link","className":"api-method delete"}]},{"type":"category","label":"Schemas","link":{"type":"doc","id":"api/v2/mgmt/schemas"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-schemas","label":"List schemas","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-schema","label":"Create schema","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-schema","label":"Get schema","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-schema","label":"Update schema","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-schema","label":"Delete schema","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"Entities","link":{"type":"doc","id":"api/v2/mgmt/entities"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-entities","label":"List entities","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/create-entity","label":"Create entity","className":"menu__list-item--deprecated api-method post"},{"type":"doc","id":"api/v2/mgmt/get-entity","label":"Get entity","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-entity","label":"Update entity","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity","label":"Delete entity","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"EntityMappings","link":{"type":"doc","id":"api/v2/mgmt/entity-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-entity-mappings","label":"List entity mappings.","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/upsert-entity-mapping","label":"Upsert entity mapping","className":"menu__list-item--deprecated api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-entity-mapping","label":"Delete entity mapping","className":"menu__list-item--deprecated api-method delete"}]},{"type":"category","label":"SchemaMappings","link":{"type":"doc","id":"api/v2/mgmt/schema-mappings"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/list-field-mappings","label":"List schema mappings","className":"menu__list-item--deprecated api-method get"},{"type":"doc","id":"api/v2/mgmt/update-object-field-mappings","label":"Update schema mappings","className":"menu__list-item--deprecated api-method put"}]},{"type":"category","label":"SyncConfigs","link":{"type":"doc","id":"api/v2/mgmt/sync-configs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-configs","label":"List Sync Configs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/create-sync-config","label":"Create Sync Config","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/get-sync-config","label":"Get Sync Config","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/update-sync-config","label":"Update Sync Config","className":"api-method put"},{"type":"doc","id":"api/v2/mgmt/delete-sync-config","label":"Delete Sync Config","className":"api-method delete"}]},{"type":"category","label":"SyncRuns","link":{"type":"doc","id":"api/v2/mgmt/sync-runs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-sync-runs","label":"Get SyncRuns","className":"api-method get"}]},{"type":"category","label":"Syncs","link":{"type":"doc","id":"api/v2/mgmt/syncs"},"collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/get-syncs","label":"Get Syncs","className":"api-method get"},{"type":"doc","id":"api/v2/mgmt/pause-sync","label":"Pause sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/resume-sync","label":"Resume sync","className":"api-method post"},{"type":"doc","id":"api/v2/mgmt/trigger-sync","label":"Trigger sync","className":"api-method post"}]},{"type":"category","label":"Webhook Events","collapsed":true,"items":[{"type":"doc","id":"api/v2/mgmt/sync-complete","label":"Sync complete","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-created","label":"Customer connection created","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/connection-deleted","label":"Customer connection deleted","className":"api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-created","label":"Entity mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-updated","label":"Entity mapping updated","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/entity-entity-mapping-deleted","label":"Entity mapping deleted","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-created","label":"Object field mapping created","className":"menu__list-item--deprecated api-method event"},{"type":"doc","id":"api/v2/mgmt/object-field-mapping-updated","label":"Object field mapping updated","className":"menu__list-item--deprecated api-method event"}]}]; \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/sync-complete.api.mdx b/docs/docs/api/v2/mgmt/sync-complete.api.mdx index 82dd2b9f3e..f3f11db5ff 100644 --- a/docs/docs/api/v2/mgmt/sync-complete.api.mdx +++ b/docs/docs/api/v2/mgmt/sync-complete.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the completion of a sync" sidebar_label: "Sync complete" hide_title: true hide_table_of_contents: true -api: eJztV0tv4zYQ/iuseukClp+JneTUbuDDoo8sbCwWRTZQKGpkayORKknZcQP9985QtmTFdpLTHookB1PDec83g+GTF4EROsltoqR35f2lbBIngtMnUzGzS2BCZXkKOwpnZiOF1/FUDtrxfYpQkIjXFSPg5aMPK5DWt5sctrdd0VxbvjDe1a33FcKlUg9sSszGu+t4Gv4pwNiPKtp4V0+eUNLiFR15nqdbz3rfDXn75MEjJ510XFeqAmc3OGFXFzJIyN1hHIVRfxT5g0E89M9gPPb5OYz9YTgZDcRkwAfDCPnRvARBJisxGPVFGF6O/POwf+6fDS7GfjiOwB9wIQb9/mA0uTwnscJYlYGuhCZhLMTkLPLF5UXon10i/wVcxP4oEhM+mAwno3iMQrlWqyRCIckz5ztPwcRKC5ewKh4Vfkd3KPnuUIdpuYy4juoLpFHmuOPVYIqUSNPZ7GaGBNBa6SADY/iCxKf0zXbfZcczYgkZp6wqCTcxVurpwAObWEq8d+MIbI6ZZnsAwGgQHzYBc6o4tUpjdSIX5JcsMkJFu2oIirrMz67KpqJHtNVCbyp2eVDtl1S+CQjlMyS8pPBNICkPUHI6icsiNLmiSrWAlCc5RDpZ0flfkNj9D4GBNMXPzATRBtUmwgSj8Xng5IhNLVUgdEbA5jliiWRVYTVwscTjQjnDPFdpqnb2UhWT7QTbV2O98JgmErgmJSn+hgldjw1IQ+oyrh/Aqpa3QUXEsAKRqiIKMLeqQPyAXCBQM5oLyJ9y8dAGSRP6DqTtrJVNT5zO3/zL9fV0PkdK1TZ3KIVXgQahdGQCQiLsF5VCXYDeryoioTxot5dQcNCJr7XKth3JudZIOC2BxchweHb2h0aF0j0tL3u5Gy1lWc3rRFMibo91ed2gz7ur3RrPcV0XaJuBdnSdvbBPD6apxNPmfTC9D6b3wfTjBxO47nPOVcejQGtuj6PmR06Yxs22U3flXVlWjmDxEBVucAz7ffppb88zsIWWuCLjLcP5agvDrGKJjGhxBdymuXUrdcQtZ2tuGBYNEPMRM4UQmN24SNONCxsecfE1qNe49esBcB9ur9Udb8XT4sjwQcxlYJfKbayrCo05t0v83CaQ4Al6BbpSXuiU0Gltbq56PZ4nXVPkfIHKu4nqZYvM9lZDlGlHO9/ysN8+f3JGDYhCY97mtD5WaXr0UZvvnK9ri5TfkYCorRbdhofakhwBHjm8tu2hGYZclFGODb1mEQaX0jR3WeYugS69ziHMIT0TZs2DYvo/fi00o6Ve95tBcWw8oAOvvQRee3bUq8TBo6OkSsaKMk0gq+rX7w7G3cu94fcnl9tx6SrWqcVRbBvWDmPUkxlPCKaREubXGp/VCG8DuHVZPofRz/jHPkmrVVS4Yn3D/6+QIjMQjghAbc8Ymizowz0+u+xvVTDBJSsMtXRiHA9KZk6K7erJ3OCt3siG4bLFGoCYLlm9/el2VkjkY5+VsSh+98suBsReN0eapA4MC2vRsFktPjQc6/W6m1diFGgddW+t9IPJuYCa5OdFiG/nnsJirBJYfyDjLg8fuXHtwr7M/iDi/f39N/nKINhyYYf9B1K1gy0= +api: {"description":"Notification of the completion of a sync","operationId":"syncComplete","x-event-type":"sync.complete","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"salesforce","type":"object","object_type":"standard","object":"contact","result":"ERROR","error_message":"Error message"},"schema":{"oneOf":[{"type":"object","title":"Object Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["object"]},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string","example":"contact"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","object_type","object"]},{"type":"object","title":"Entity Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["entity"]},"entity_id":{"type":"string"},"entity_name":{"type":"string"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","entity_id","entity_name"]}]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"sync.complete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"hubspot","result":"SUCCESS","num_records_synced":100,"error_message":"Error message","type":"object","object_type":"common","object":"contact"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx index f32a1a402f..ca0ae17876 100644 --- a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx @@ -5,7 +5,7 @@ description: "Trigger sync" sidebar_label: "Trigger sync" hide_title: true hide_table_of_contents: true -api: eJztWOtv2zYQ/1c47cMawPIrfsTGMKyvD8E2NEhaDEMapLR0ttlKpEpSdgzD//vuSEmWH027NikwbDHgWMfjve9HntaBykBzK5Q8j4NxYLWYzUBfrWQUNALLZyYYXwf0aIKbRmAgyrWwKySug7uQZyL8APR0s8FVDR9zMPaZipG0do9CA4q1OodGEClpQVpa4lmWiMipbb03ShLNRHNIOf1SEl5NnQq7ygCtUpP3EFkySNiECC+45SxVMSRj9lIiVYDB5UyTN+4BxQAtrG5FTA+FJIMOyhmyxmAiLTKyAMmv58A8OxMxs4pNRWJBs8kq2KBY0FOl09tpniS3GqYazLwmc6JUAlyiULjjaUYGksObTaMWguuaOTebxpe59sotHnrmN916EYe+gcxT0mgslzHXMZKi3FiVUgoPHffSGEnZdb3m0FYWelXYfExzxU/J5s6xQ4UXWi1EjDpKzTWl7EnEDTAD0mBWF3DycAmoR61y4otz8VylqZLsylfpV2YkckK+IQ2FgAdIwlWe8VmSw7EkPHrMbzYbz2kyJY0PYbfdpn+7lhLysAKUwBXydwaR4+ixDfGw3R1AD87CTj8ehr2z+CycjEbDcNrtj7qTQb836IwonJ+rDI8OVBlb2QVt07gfyrYbRj0YRJNBFLYhOgt73dNpeHY2PA27nXa/NxqO+GDSIXEYRImxwMB9VuRptzME3u+EnQ6JPI1G4ajfG4aDaWc0hHYX+tAjkQYTdYtyp2L2EDL7rgR5biC+v+imPDEHVSeoUoqa24Zu3+8DoyuN3wzQ36tqyoaqyy5oFUR8KSg1jp8Xj3sE/GRK/JE8haPg/18q1qNw+Qh1e/9h9m+s3kep1PKM3K3S/4vyHxblzbYIiSnY+NN/DxX8Ic+MHz0yrjHUeB0x7gx3cR/jyOGBCXToVAjaOQeOSEIWVIf/pyOXrrYi3Fl4iE3lOjt/weycW5ZLgYNNQrMBnSZTbBNcqDEKyVYq16x2Iwkae/MPtWblRVbAX+goX+OH4QkYvKBFcNyJUgMrNOwZgynB6M4VzXyZMtZF3OIFL2hRAkzrtrh0kTmgF2Uecp2QpdZmZtxq4fzXNEWPNIVqpbPUthbdT/YRe3pxHmxqc6QDIA86tWmy8hspvwFdgKvAlTz7IdvVh2oYctGdlieJWrIYFpAQxBlHiyIwPoXOIAwg3R8vt+PryzLOO1PkNg/HL8c+zWjZVNFOCpq3p93sDJqjGhb/wSWfoefSOgsaFQKNqyIpY0ZZT7mgsMcqMr9W8Ubgw7XdhOwsHtTFj/jHzqXVKs5d477Fz5+QILMbOSggu5YxVJnTg6vpJvtL5SzikmFjI7cwjgd3pm5XvSEszPxrBcMQi9kWLEyTtF7/cH2ZS2qcC6w+3H7zpPRB57KZIU1SRU1ya1GxWcxOthzL5bKZ+W3kaOV1a6n0B5PxCCpSmOUTbMmWwmQsBCxPSLmLwzO6aZD5by5/J+K7d+/eys8UdsHlkNXrryVsD8B2Ql9VtIU728oSLpwQl7x10XnXDhzpLln1HnbKnJoT19brCRr8RiebDZGxUrV779IIFlwLPqGyusbzv2wJatZYGFqIC4w/sKmapYInlwU8nLCHRMCjTrsWP0DyBadaHwcB4eRXG76PevcasA/COyZ4pudeUfjan30lx8Hkud3xFLEls/fy1rH34tXVa2SeFK/M6HqGVM2XBNn4PQ7e4oeOXee8Q0pHXwcJl7Mcuw55vFzCMZ7b+S6AerQsftTGYS5XNSvryOodoe/adXKX/WdqHITmXyp2v/LJDRVQe25KBL0D+BuGbO0B +api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Entities","deprecated":true,"properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object_type":"standard","object":"contact","perform_full_refresh":true},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,9 +34,9 @@ Trigger sync ## Request -

    Header Parameters

    Body

    required
      oneOf
    +

    Header Parameters

    Body

    required
      oneOf
    Sync triggered -
    Schema
      oneOf
    +
    Schema
      oneOf
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-destination.api.mdx b/docs/docs/api/v2/mgmt/update-destination.api.mdx deleted file mode 100644 index 0c2666499f..0000000000 --- a/docs/docs/api/v2/mgmt/update-destination.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-destination -title: "Update destination" -description: "Update destination" -sidebar_label: "Update destination" -hide_title: true -hide_table_of_contents: true -api: eJztWW1v2zYQ/isa96UFQtmW7Vj2pzZrMARdtixtNhSJ4VIUZbOVKE2k7LqG/vuOlCxLSuMkXbZmRRyglU7He33uyJM2KE5YShSPxYmPJihLfKLYKyYVF4aKDpAic4kml6hGlWh6gBKSkogpluqnGyTgBiT4O64Z92E5F0BNiFrAdcr+ynjKQJNKM3aAJF2wiKDJBql1oldLlXIxR3k+LZhB2FHsrzVHey2NhWJC6UckSUJOjc7OBwlGA20nmn0iURIyfVnaeLq2zmKp5imTVsvXwoykfIqMmoDP9eIFEPWzNPYzqvmx72HBVjYNMwlhwNRfCJEpEVL1wc4kXoFo7NipL20Skc+xICtp0zgCqUmcgqzhoO8cIIg48Yis651pJTPfQ7sQoSTzwEmgZJKlcB+tzYXOg5SrOPUNTTIhueJLVlHz/ADFgv0WmCyVDsbeB0aVdpirsOUx6AZMKA43VcjaCTrYRfXGaObbcH5hscgiDalK67QusKLm9fC3LW+aWSRnn5kPkLd8m7hKD/jhmSRUenRO83pS99rUznd+c0001hVYyLdg2Mdb4iSvA2U//5cxtKu/yyLaZTBqvlbGl3ZNr+NrViR0RtQsZESqmSQB08YtoY/wonRvjO2W1DbHYLREWwWZnchpfnAz8D0+hzaTrr8O+Ed8/rtefV/gV1obwK+o9wA+3Gm67rW3pBXPaYJLdgzsJUolu6VwovVsa9hsu0AbCMGH/stJKG+3koYceGeADR7eXRtgaMkpmxFK40yoF/CstN/mJLLn5fPycVWiKV/CJjb7yNb7VWH9Ozr++eRX6+z85I+Xb4+t18fvDPXqSpyenNi2fQ1rDU+ayqZt3lpudrFuRm56HYmPrkSiWMxjsxl9RYWc6sWvju5bIFudjfrYEh90X4DCKDcC+3O/t6LRB7vUY4sC6Xfr5Ts537wv1xpyuw+Xrn0bjNXsKA6aM7+OirwQKBM4YBbZc7pd/R9w0ZQnhmuCmie2rzkG6l6JHErZkDAfMzegeNDzHOwFwSE+9H2P9oLx2HGHIL8m1PRYxIaO4x7SMe53+y4eBMTBxPFc3Gd0PBqOfadLdal8h0fNu50kZZaQeZixa6V42w7lD4ZDiJ6Hg0MfEuLRPiZeb4C9QeD06MAbuP2hhmg7I/tkjpzDwBuNXey7wwEe0OEYj4nTx8MR6zMnGPUZYXdpR5VTjX5UUfcVTrtKzGbQ8qEqmjv14xvP6o85wk9zxHczR0gZzqLY35sRn0vihRrSJAzjlYkzC4yLZTE0c7Xlf/hJ49ad7W4F+q/MGLcVF3NdlzI/wGzsd/HAoUM8HrhD7PgjZ+zC3sMC574FOx6OHL/rQhPojQM8cCnFBDY73GPeqNvv+f3gkNy5YJ/mn8c2/+wbVx54QHkElXXTaPK/LywzNj0NTTdtQv907vmvoFuzoD3q6Bg15poLMxJZfmNKiJhaxL7Zqk2e9Hv0CerUmGRn03znnuvdETrD9sV8lkLLQQulEjnpdEjC7e251eZxJ5pHqrN0UNuaNyWP9fLsBGk/JKNZytX6jd54C5x8wiANN9+zAOU1W+8GoB1P+SlgwYhvzgFNfaDGAi5LxZY5MUAclizUqJSGBtOahKtFaRBET49457tvBMdPr/m5CGLtQoVq1LV7h/a41jBPiSBzyJ9QJo7F/EyoqoXtzW6AK/cr5MdUvqhQU/jWhFXj4TVo/wg/60SoKqZX8PcnC4GZ6ezqtDYts0Blpm9MymzrXZxZlAgLggHcXBoeWBmZVRaF1ICs1OJCsXnxQUtaRPgW+CeY0SltrfXyh8vzTACfwQYsnz7b+pBmwk6AJnRdeJlSoFgu5893HKvVyk6KZdrRyusOpOCjTAhlFQkXiezES71Js9VzrdzE4QhAYMy/OP9FE9+/f38lbinPkquYHIz+WsK+2DgaCaiqU7FPqpOEhBtRJoWbsqlc1juULolJ61Me9ICiNi7RZqORfJGGea7JxaFtcgmXS5Jyc5DXnac81ANkAzhKsGtGVe9u0LPzstc+t3bl2TR221+E7iRLogE6QXBp2k/7s2MOp4Ztp9GWFEw/Ffrw23LYLoVce2+kTxzFipfQdhK1l3daa9JnF2+B1yu/WBYzEkqJHn/0vxN0BX9wEydFkPVnTU3foJCIeQZIBp5CrP79DSOuLGs= -sidebar_class_name: "put api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Update destination

    - - - - - - - -Update destination - -## Request - -

    Path Parameters

    Body

    required
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - -Destination - -
    Schema
      oneOf
      config objectrequired
      config objectrequired
      credentials objectrequired
      config objectrequired
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-entity.api.mdx b/docs/docs/api/v2/mgmt/update-entity.api.mdx index c4902629dd..8682322c7c 100644 --- a/docs/docs/api/v2/mgmt/update-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/update-entity.api.mdx @@ -5,7 +5,7 @@ description: "Update entity" sidebar_label: "Update entity" hide_title: true hide_table_of_contents: true -api: eJztVl9v2zYQ/yoa99IAlp04Rhz7ae3Qh2AbEKQNhsExnLN0stlKJEdSdgxD3713lGQrcdbsocBeJgE2dbz/97sj9yJFYzEBj6mYeltiT2iDFrzU6oZIojQpbX5UXvqd6AkPKyemMxEIEp2Y94QBCwV6tLyzF4o+SBCDyEKmJCUVEQz4Na0t/l1KezTnkjUWIKZ74XeGBZ23Uq1EVc1rZnT+g053zPFSNtHKkx3eAmNymQS/B1+cVkw7Ua2XXzDx5ISxHGUIYNp6/NKBnsAnKEzOpGIX1/GIKljN5OpttZnEPHUdPrAWOInSY+F+hFtgdJ7DIpPW+UVgr6puhme1jjlTIc/1dgFpKjlHkC+Ce4uCEkdqu+4stc4R1ImuJp63VVHhKFd5BwVNyl717pDQjlhikVC3qMG3aFNf1fLOaOXqFA3Pz/kvRZdYadgbEj6A9QfBgyD83SpcjSbLCxxN4uF4OIxHV3AZwxjH8cV5AoDjaxhdZoybjg+Lt3Sm1wkuL7Msvl6Os3iUwTheXqcYX48mw8kwu0rgasI6/4fufwTdMNdeVLT3z4DuQJgUPcfrfUB5hC1saZauNc9eU4bM8tycigE2I3ewP4zWirYd2k07ekubE+fae+OmgwEY2XelgVVeYl/qQbEq/GAzFC/tf2p4ove3N4KnrsOktGThEzdIXdCnmLTFX3HXxYSRv+GujXra4Wkm/hohRXtij8xExBV5HYVyRCluMGf4uEBLEnS0WjcOUb64Y++OR8HHFkWHw+YI8i7GWxQfD6VXUDf/F/ji04b9kCrTrJgTXsdy3r+46k/EsdB/gIIVZU354H09hCDxHWfbfHM/FCC5ZKlO3C+HWiW6oL3nxXy2eQKhn+mJbpS3Oi0Tpj3Q+yfmxIycU07mc88iMlnyR0BvP/pLl1ECKiodCaylCzwkWQSpKCmdJ102kjRSV/X9wEWg0ojiUxhsuj5bnf00uysV8UW32nkSn79rY7Cl6huiKUbjsvSeDLvN6uzIsd1u+6YW40APUQ+22n51BhI8kGJTLqn5BpqKsZG4PWPjIQ8fwAXoRPd3vzPx8fHxQb3RFA0XZ7ax3ynYywZ9lvtDO3h88gOTgwxaQvX2TfPORNu8JD093owIe2uyxgz7/ZLcvrd5VTGZsG6p12a03ICVsGRwEY5T6XhN0yGD3OGJL4cjT7y7a6bVWcTwfM3Hto8VB7UBhuRU0DK0eecCV82JuWlmdqLe/7U2FX9mLUf5k5O26rUS76mzjf8u77wz/m7vPxPvsrn7FTplEQtbvkTS71Q80Cv4whrQFy6ITN+LHNSqJNgST62Wn28Ttcod +api: {"deprecated":true,"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,9 +38,9 @@ Update entity ## Request -

    Path Parameters

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Entity -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx b/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx index 8c2435ebe2..c7b2587eaf 100644 --- a/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "Update schema mappings" sidebar_label: "Update schema mappings" hide_title: true hide_table_of_contents: true -api: eJytV2lvGzcQ/Sss+8UGdNiBY8dCUTRpG8BoDsOxERSyIHF3RxKTXXJDciULgv57Z7i3JFuJmxiws+QMZ94cj8M1jyA1EAoHER84k0GH6xSMcFKrK1ziWRrh5sfgC4TurYQ4ei/SVKqZ5R3uBP4ZDPmncA6JqDZGHW4hzIx0K9xd84euSGX3K9DXaIO7qTAiAQfG+n2FH2jpoRtm1ukETFdGeLpUuDgHEYHBL+tt8MGau1VK4tYZtIY78CCSNKalZFUfcco3HQRnQyNTAoPbt3Ng5T67+ou5uXAsU/JbBvGKyQiUk1MJFjcaglKxlc4MQ3SxDH1g0KiBb5k0ZdA2nQaK1OgFHma6fuU5OKyIwU61CWE/iNICKyxsOTPKV8C6Nzpakam2QIeHWjlES1sNWP0vlkysd33UPv1oCS1jdTgMEu3mkJ9CQoYEaiKMXGiPsMoSKqJQJ4kPrXVCRcJEfIRaUyq5cVKWVq0vjBEriq6DxB52NYc09sc97bJIdRyTpLFu7BGiG+QARN+j/pb0Pni1TTMzw7YLmCMnXVx7PG4hReUt7SLV3vBOWBqn5f06fuxQf6pNtbJ5XF6cnNCfdo29k9YxPWX5IZZhPqgnpGH+PFbaZUdyyiy4Y/7TSqrw+4cqq9B5XoGJONbLsYgiSf6KePxoxQVaxyBU04u898vMygOl8fL04vICXkXd6cmr0+7Z5XnUvbyEsPsSzk6Ds/OLaHoW8LLm/0etPxa8XSIhSUo0EV6eWmEpoUR6tFZkrQkCv2VMXkpLUcOmCFbjkiz3Rqtt9vMc8GTTMLlEm/4kFqza1HukFRJzUU5BDExOG26xOSk+nT4PxmlGiTrmdaqKfv7+SOUKPmDR4YiVSCJYQEyp6bEr3ymdNsBQKKWx1RZgDBJ6j30kwFr5pEx2fZ0wbdikVG/v2LnO0J0AyE6PsO6T+2G0e8FuJeqn+r2f9/ZWW4P28HNWEjSdv0ugTWZpc8ZhEmi2eNWfByjcerrdub/vPD+XddKwgAPRXNPElWa+pYWb40e/fWZ/3OJ3cgzMohykMhPTqOFcagf9Pg5dPZulYhZn0JO6n8wS11+82En4p0KGvb6+4pvG8ObHupxSGiNczUqp/AeIlqrJp5TZnnna9tAMQylqSx/3ukusXwtDsPkM5h3CCNIlclNPNH+XZFQNXeVlUE4ZNddvs/lwexTYc99vX/fNO52uDKmmmoxT3HNIJ73T894lrwvivVBihsFTzoPoVB7WPpdhJ3b1nDrgkQ7tH1XKEAPutXPa2typrV/xH7tSzugoC2ntHn8+Q4zC4FkQY9r2jKHJjD78bd1j/+qMSIllFhXm0noZ1Ey8VnModjDLXwn5eID4FHibtkdWh78MbzJFrHitrUP10VGJwWSql+KaoqIMMufQsF3MjmuJ5XLZS3M1Alqh7i+1+WpTEUK11E2zAG+HPlHoQsLymIz7OLwR1lcQu7t5R4uTyeReHeiNQooiW9hvJOzRzm0loWoPBw+un8ZC+uN8GtdFVw+3y7LDt/oau3CODpDoeh0gkjsTbza0jF1g/EOqwxfCSLoW/bOqU7YblXgkLW1g7U5FbGHHxWpY40c3BUUes5/5PNobA08fO8+8haAmGHBOj6hnO779JHrSge0XWsuFXOjP3FD3Nr8gSomd0bbWeI28lbonZUcNlr++u0XZoHigJToiFSOW9JzD3wN+jz90UXnsnoT9+prHQs0y7EaUyY8lihQZFVaTm3MiLv5DRVFuqVXDySZp5zjoN6HaK/4bNRSy/u+VeL7zqEJ1B+TSlIcROvwf/sbBJg== +api: {"deprecated":true,"operationId":"updateObjectFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"contact"},"type":{"type":"string","enum":["common","standard"]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["name","type","field_mappings"],"title":"update_object_field_mapping"}}}},"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"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."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}},"description":"Update schema mappings","method":"put","path":"/field_mappings/_update_object","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"contact","type":"common","field_mappings":[{"schema_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings","_update_object"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/mgmt/update-provider.api.mdx b/docs/docs/api/v2/mgmt/update-provider.api.mdx deleted file mode 100644 index dd850406ef..0000000000 --- a/docs/docs/api/v2/mgmt/update-provider.api.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: update-provider -title: "Update provider" -description: "Update provider" -sidebar_label: "Update provider" -hide_title: true -hide_table_of_contents: true -api: eJztW1uP2kgW/is1zsOkJQwNuDHwtD3RjBTNziZK0lqtCCJluwyetl1eV7kJ2+K/7zlVvuNumCjRzCjuXBrqcm51Lt8p8KPBE5ZSGfD4tWcsjSzxqGRvU/4QeCw1BoakW2EsV0YxJIz1wEhoSiMm8d1y9WjE8Ab2JvmSTeDBxiDGISp38Dpl/82ClAEDmWZsYAh3xyJqLB8NeUhwq5BpEG+N43GtFzMhf+LeAVe097o8liyWOEWTJAxcJfzod8FjHKtI85i98ZV8ORPu/M5ciToFMsQBN43gHYgNJpABE4pmJncbvaEt3cBgcRahMTiumhjroxLHD7a1xSUXjwk3DRKUDoZvY6JniNxRSYTkKRPkjSI0un37mtyzw4i6LhMCX5KUhXAQHnFBdVA3oKEYnghbWhwsgVY/NehAy9olX5OUWrYRLoyJ2mqapvSApylZJLoODCxQSXgpGzcMYMezEhdrBAP6sptz5RqrE8LdZNbd23K1m7qcrG1bu7At+Cz7TKMkZJ1nYkSH9o4Te6/QF4faZmKILk7xRcqop6Sqz0UJjcGaXZMeQzfpmOD7GIK1m17Oa5/CGT/JrGtWc9Mz6xM/ODlpw54ups4NtcwbNrk2rZk1N+c29U3HdiYL215MfW/8xLktjYU1dubWjJo3dO6a1tyZm841G5swPPMsx7X8MQWnOFbRrVPZpjyPPFLRwbQC54P2wy4QBP76PCV+wEKPRHCS4H6C7HcsJgeeEWBCScQ9FpJMwBRZvdHk1y93UiZiORp53BVDkSV0G2YMjTpKILiBaDTKRRnxB5Y+BGx/NSQfdqzN7CW9p2T1XqW2L6P7QudFcXVFdixlhMI/wSRxDqjEAJISIx57YCEG64DQ2FNDpQSYag/KDjQMcUtK3AySWIRudRLlIEqk0/GZNPJEltAFpSP/FmFmQKbkGVSBY1FMOpNJ+zxf+6j0gOwDUEIcYheVFFpNyLXK6nDgseRK+5TuN+p4XR5mUQwThHpegMRIvkRrmqf2IQEGMZc1Jj6T7k7ZLCdO0aGGDV2mkzn4tDM151PrxrSc64npzGZjk7Hx1LF8eza/np3kO2UilaKEhNOiqfctzX17obmrHbZtMzqfzMwb256Z1tSyzQVzmWnZjuOMbdf1POtJpWpRXMTqEasvDB42hU9+ub45oXMq0ISHId3kGbJKHOcZnMMP5ZHVS0c1CpzOH8mrQqyWDdWOnMC6smNBfJOLDLuUR349cypy52MQ0xsKR7ivIkinuiDWSaUG6YZdh+EHqZAbpRxooOP263Au0tmPAiaD1DMB5MoDKXAvBDwPyUs23A7JexoyAbnQZVdNIX9B6f6lhGudSsNGLcFrp1RfVpyMrmodxILG1rLONcNEQzQohFueHp7zSQTD6+c8L1+3yxyRcPQCUZoBXSIAhdLgAV//j8Vg+Xso3mGIyoqNdwCygSs209nNRu3DZXzHNxqDuzQRWcg69UGB1LK2GSqoXsLwmqpFCBwHTzcALN7SLYuwnej7gL4P6PuAvg/o+4C+D+j7gL4P6PuAvg/4LvuAGia+pB3gmQQ04eItvzoaXjQGIffl03i+xuXrw/qYk9r6Htf3uL7H9T2u73F9j+t7XN/j+h7X97j+O8T1Md+Uyy4B9pAlWQrpD4a2XM2EQcxo+jSmr3P4QlC/frK8o5UUTZHwWGjHnFxf46+mF9S+u3TxV4We9/9zeeTatVxnMfZNNl1MAPf4N+Z8MbXMsW0tZlN77C+mE/Tmmgxnc9PEnrKxa9+YU4A/kF4X1Fw4c2a6M+pa17bnLybU+AOf7Ayan3WwOA3cXf4mouk9k7BnA6fEIyUgHkndYeqyaXrll6jKIx/8oeYK7RFsoBVqEs9n/+wPogb1xjb3/47+dlAPkzw+gEgIv50Ap2eCgbeWRuYNaTeV5d2QZ94mRz2bxlmJkLr3TSNVqndGovGX71vrylTtE4idCbRKDNpDJWt1tg5kaEbj07yfZmwJ4JyR9zlWhhz/5hY218tNQ2LyC/wPm+5gE5aKXGDvzLa63PhtxG/eftf4/f1byK9+l9DAo5c0n5dePtQJX9iY/pVuK6rvt7K+Q+475L5D/n465KejV5MZXR7EPyMzsM9F0cbyxe0w7uaqo1kxOJDf8tEv4/NC28TMaX+r6O5vHvqbh/7moX3z0NqtUEiry210+fVbgLYbNRr9Y9vCd+o2gCRVcx8xueP4sUOSKcfBJ42WxqhYIUaPteeRjthHQcIonljK0hDbqDzfQCNapZuAj6JtJEcPk5NjLtoLAn2RgXcVgOMywLYHhUu0y342gZqJbW3N65PgV1becixra/LHpHYAupVSrd5Mt19YaSEr8X2VwYQa010ZOpwSCIyGVxvvquenfq4+tqq15lUHXjWJ/adaf/KnWjVEXmDH6sm6Aus1sMeFqGldx0cVydtOkpdhlnUXFFk1ql+7xHVUuFKqMi5eVfWwXUFW7WLQkbbbWbueNNXVYnVZlt9h5XyL65QjhqPPUUbMFDoIr4fj2XBRu2r5TV1P4OWMCjt9zUi1ajnBIlFgCo9ogLkGMc0/6pgG5ppZqDF5kgBfwA95HcuUe5mLYx/hz79ZCItZAcWbkhFgmeEbXfPIfwDluTRWFyUSgSGugZ36uqWsUgj+2VY/EioUUAL9YqZ4iiFyXf2wepepXuAtFxK2V8gtzeJhAmMxplEnkxIYi4ftVbViv98PE71NIbtC69Gep/cioS4rh8wkc6CUVJASmSs7/ESFynnk7t0/cfDTp08f4zPZPF+Fls351w7stLw0rF/6rGSfJYLRQNFR5/eYl56qI8fWfVl/GBZcbwcscc3jowOy36Xh8YjDkKnRHVfw8oGmAXXUTc+j4QUCX4MT+3hRdSJOebNtvHyXF+Argj7aJWZRhWKsNw8U/XJpwEtVpBpP7arIzosRiqFXvNLMzA+6cBcUTq7U8Ss5egckF5bIZ9euaxX87d0HWOvkD/xiEwKD0HrCIP6/ND7CH0whSn+VI9X4oxHSeJuB98IaTRZ//g9u5CUG -sidebar_class_name: "put api-method" -info_path: api/v2/mgmt/management-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

    Update provider

    - - - - - - - -Update provider - -## Request - -

    Path Parameters

    Body

    required
      oneOf
      config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
      • config objectrequired
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - -Provider - -
    Schema
      config object
      - -An object that stores Oauth2/API key/access key related credentials. - -
      oauth objectrequired
      credentials objectrequired
      objects object
      - -This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers. - -
      common object[]
    • Array [
    • ]
      • standard object[]
    • Array [
    • ]
      • entity_mappings object[]
      - -This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. - -
    • Array [
      • object object
      field_mappings object[]
    • Array [
    • ]
    • ]
    - \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-schema.api.mdx b/docs/docs/api/v2/mgmt/update-schema.api.mdx index 1364f7c11e..ce4cc373ab 100644 --- a/docs/docs/api/v2/mgmt/update-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/update-schema.api.mdx @@ -5,7 +5,7 @@ description: "Update schema" sidebar_label: "Update schema" hide_title: true hide_table_of_contents: true -api: eJztV1tvIjcU/ivu9GUjZYbA0nB56m61laK2qygXVRVBxNhnwLszY9f2QBDiv/cczwADZMPLvlTaECXm+Nz9fWc860iCsSC4BxkNvS3hMtIGLPdKFzcoikojcfNezCHn0WXk+cxFw1FUCVw0vowMtzwHD5Y21lGBX9DOBYWJkmikChQY7ue4tvBvqew+WqUXDdeRX5lg6K0qZqgJLzw3GYl4v9OWvwxk3J92RdzlchBzABG3O4OO7ECn37tqR5vNuPIOzn/UckUuj4MJXXgoPG1xYzIlQp2tL04XJDvJRU+/gPCYi7HUFa/A0W5V4lsZ56u4drYJUVM1O+82VZBJ19Dj1vIV9c9D7r5HWtzoLOOTVFnnJ0H9EgHghFWGGoEa/+jSskZvWEiKkW5CteS4B3JyPtTvFOPzayEe5lB7XVEwUTqvc7AMXbuEPcyVY/jL2a3VCyXBxs6AUGghm8mwT8ksYbsoLNWW3fMMHC4E5bppYm1UNWdMUp5lejnhUipKiGeT4HVClWERzT5Ptc6AFycV3NcJObacg59j7oeVCF4w9M8KWH6jly5pNivlmYPjhGs0nM8XYe+VzxqkqwH3agt2cGyYCQvI8UlF9ckWuJvK3hlduApgnasr+nfUjO1o+E7kwonxJrCuu4NpG7qDuNPrdOLuNX8f8x704vaV4Bx6fd59nxJSGzlMzvmUfQHT92mKA6aXxt2U9+JpX0Lc7w5wxKTXgl8PyOcP4v8g/v+Q+OEhfMSHy2+Pg8YA2Bx34DHMCOa2pMcH/1zTPcGUAZf0kB9GrWrftda7a8AGdx3YxfaaUNoMFefeGzdstbhRiSsNn2UlJEq38lnuW4vO6QHUOuzD7U1ED3wHorTKr8IUqtjwEqO3+CusmoQy6g9YbYseNnTq28kcOCLuJB6GYajFvGbhNJiEBWTEPRdkQoDD1bxOCNtF4+5ufwv5tD3q3cVoPyGaA2I7AvYXqNcoe0DCBtOoE2fRvQObKlJNMeksqjKvkvZ1Moj2EPiLF3yGDS18KKwa7lz4Rh3boyA851zRaUot3K+7YxQ6x73Dcz7YPAHXz/jDbgpvtSwFyZ7w8zdkqAzUburzYWYMQ5b0JeA6YTjFAglLhwY0UEgHLfNgtSeqwkfVrLrl4sQpJMP6CggxXUJRRz+N7soC9ditdh7Nx++2NdiySAzKCgLqtPQeA7vF7GKvsVwuE1OZUaG7qltLbb86wwXsRLEpp0jLlsbDWChYXlDw0IeP3AVUsce7P0n4/Pz8VJzhS61Fna3jNw7smLoHvd8xxcOLb5mMq+AlnN66pvWongw0m4b7+z1ib47BaH+9nmLWjzbbbEiMLLDIwhEuF9wqPiVsIcKlcrSWNSZPUtndJKJ3d/UYu2CEztdS3DK8IC4vOCFyGOEyDIDGa8hmjMo1zSmJav+3KlT8QF729icXmM3l1uIDct74N3XHjbl4+/iAutP6hSTXkkwsX9KrEP4dRk/4ieitK4AvvLWQfB1lvJiViFrUqdzSz391174y +api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","deprecated":true,"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,9 +38,9 @@ Update schema ## Request -

    Path Parameters

    Body

    required
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +

    Path Parameters

    Body

    required
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    Schema -
    Schema
      config objectrequired
      fields object[]required
    • Array [
    • ]
    +
    Schema
      config objectrequireddeprecated
      fields object[]required
    • Array [
    • ]
    \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx b/docs/docs/api/v2/mgmt/update-sync-config.api.mdx index bb0b088d24..d5fc4ee3c7 100644 --- a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/update-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Update Sync Config" sidebar_label: "Update Sync Config" hide_title: true hide_table_of_contents: true -api: eJztWNtu4zYQ/RVWfUmAyBf57qfupn0I2gJBdoOisA0vRVI2dyVKJSk7huF/7wwl27KUbIJigb7EAQKbHM59zhG199JMaGplqu64N/XyjFMrPu0Uu01VJFfejWfpynjTmXdeNN7ixsuopomwQuPm3lPwA84bEFoyJ7WUHE5LBasZtWv4rsU/udQC7FidixvPsLVIqDfde3aXudNWS4U2xRNNshiX+GDcE2wU+IMB7/v9qDfwJ8Ph2I+GbDSYDEd9xrre4bAotAtjP6Z8hyrrxsApK5TFLZplsWQu6PZXkypca/iShl8Fs+BLpjFFVgqDuxxMSOXOYoDf9X0oRiGl47E/7nPu93nI/EknoH63PwgCFkzGfRF6B2dhI7nQryocRaNAsM7IFwPW9fujiPtjFg18Mepy3u2NRz0aocKiAG8JJqJ5bJcvy0O4TMsMw4Xlovx50S8kdcuGRKkmc2+dbucesSnBFmg1TMFXmfJlYipWJFRkJTTIJlLJJE+86bADn0rI5e9LNz6vBSn0kSupSCLjWBoBQXBzjR7oXBELMoUnkA9IJXT1avdsdhXanXlRHsd4ShGpmBYJ9AqNYd+tpyreYdNf+jGfz58/hhtkC245VyhxQugNKHKeRVIbi5s3jbNOzrTISTna/q5CsRF6hxsuVprbdGks1XYJLQpJUVBJWTR5GXuYprGgqlHeu4i4WTklrzDplBHUm0DhGY3jHdmi1yh2NkCkIRAFJJq35urXorWmTuNcwYhW539W6YdKeRaud5MEHC868DhyFSc/ECi2JWlEPuUZXcW5IKUslj4sHAcXELmKcKnWdIdQZMVF+70wFOXyM63S7MKaC8ShYHViEXUoaKuHXxpZHFx3UsWp5m+JmVEjfCOUkVZuBLkvkeN/TEHNBZcCcoV+kpOf1xc5uX1DTmAU5NGb/xaD07B7FVJ7dBz0O5PIZ5NxBBgdDPww5GO/1+sNuOhF3YCxhqdn3eBsba+GqQAaIBvXuRFYljbU1rjlkhhOqF7RWIzbsiDtZUU/qC6UmwwQukhI0Ok0O+uC6X8QRb6W8v5wEHEWjvxgGAKldyYdfzzpM384YjTsdztBEDparPjwahkng1HAO+PQj7pQy/6YMZ9OJoHfFeGo0+vyXjSkqPOdvt/p+52+3+n7nb7f6ftH07cj6RppNRjndVKv0/ihXrZHR/cEqZucuBuu4usUb/BZ7pKJN+6p164oM+395e38gLMr9OZ4hc91DEfW1mZm2m7TTLZMOR8tmbaTVWLbm6DRRKcZ+nB/5+E9HKA815DfT/i4UBTzyQdt/jdRRXBY+V1gQ5RvDs4y5UuDtaDcsUttmO7vCEjhqACUpVvCAUBjbB03PpQxYYzDNucQZA+fXx7OLwd+OzZP8zL/NsqvMf7baL3K6k3ertBrSZlnznuR2l6mCgTtZ7B4doaGM7ItnkOwquRtRfI817OLEX3jHDpskCpKMWbsu6KknVZ32Jp45xH4kyq6coG6It6cvJ2eXjQd2w7RIKESO5enzPxyalkIHvYue/piszFXP8OH3CmrU567RM7h7y8Rg7DA1sKeuvSMgMnc1QPFW+TvNAeIVyQH9LRrIFSUgZOJO0VYboCEAWvdk1PxGGYI5L5Cw6aFVmc/zR5yrDe5T42F44urYwz4oJDBmsKhDHNrwbDZrK7PEtvttpUVxzDQU9Ttbaq/mYwycVryszwEuGqnUIyNFNtrNO7y8BEZAN1/fPgDF798+TJXr2BDKeWeiQv7lYI9i1oXBThBgxVPtp3FVDpVroT7EtFmVXjEh49p7Y0jNOkabKPkfh9CEI86PhxwGQBAwzjN4OuGaklDbDVoYy4NfocujmhsRMOp063Iu3oo0f6anLn50tkjuCmEsQ3FBp168NVhX/3t6AEfmEqYQ08KodvCnv8ZVZ2VNG5kh5vjiQ+AeZn9ruyiwhD3j59BNizfkyYpxyOabvENLfyHB2P4gx/lBcG9TMX1vRdTtcqhk0GmUIuffwGv/aT0 +api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"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":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","deprecated":true,"items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}]}},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -46,7 +46,7 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    • SyncConfig @@ -62,5 +62,5 @@ A list of Supaglue objects to be synced. A list of case-sensitive Provider objects to be synced. -
  • Array [
  • ]
    • entities object[]
  • Array [
  • ]
    • +
  • Array [
  • ]
    • entities object[]deprecated
  • Array [
  • ]
    •  \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx index ca4b27cf75..9e2d0c4edc 100644 --- a/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Use this to override SyncConfig and Destination configurations on sidebar_label: "Upsert connection sync config" hide_title: true hide_table_of_contents: true -api: eJztWm1v2zYQ/iuc9mEJEMttPwyYMQxLXz4EW7EsTTAMtpHS0tlmK5EqSdkxDP/33ZF6tWUn7dJu3dwCSUQeeW/P3ZEHrgOVgeZWKHkRB4Mgzwxo+0JJCRENvlnJCL+mYhacBTGYSIuMxpH0xgCzc2GYVUwtQGsRA6vpGZcxewnGCum2Z5Ebzj0zw3CEM+TNotxYlYLuRRVXNuFGmJC9CmchW6mcRVzWPOwcmJq8Q1LkPeeWcQ3MIGOI927IDVtCktDv1j6WTxLoRypJCkK3Ic6Ymgdtv9TCWpBMSKtCNIXlMxMMhkGXpUwwPgsMRDmuWSHROrjr8Uz03gN9jTc4m3HNU7CgjZuX+IEWvetVoosYmQgy8xx4DBq/TDSHlAeDdWBXGZEbq4Ukv8AdT7OEhtJVvcXTYLPtsmvUuJxnFy+9srkUH3JIVgxtIq2YCjDONBWhkOQDzXiWJSJy7kOmGj7kQgOCxuocNmcNLTKtFriZ7rmRT9HD8ATMVOkIupUoObCCw5YwYz+C4Huu4hWxahOcBQgNdKelqYZa/XeGWKx3ZfRYQE7IGTFm0Ug0G9f4vvX4LkYb8p7LAkmtQCELxzDleWL3R4mHcwUxAp6S8NvUgabNpQg6k0GELoyI16UydqbRmw0pCbpbGllhnc1L8h0l/YIOd8k8pRjIyoXjzSHv7nrR0xK4votZIt4DSU2BjL9Ddk25pSBJEYuMJxoxtGJwJ4wN2Zs847Mkx9gUGNhSWRbhvAUmcPJi6kYKc0B85gxe7FaNErRpvLJU0xNu2wmw3EActtBZRsbt09tC3c2micGh170yxpii4153PRez33PQqwe6qyT/aHdNxOyDW0juirnlBuzD/FUQH3RYSfNIHiu323FZZa2Pdlmp8h6fldMdThsMBigijKTTdIqi51gaBNUyTJ98wUVC5YREvNSwELB09gGqLVU6dZWP0ukrzEA60wIrTZZwGbIhgsJyJM3N+CTFzawaWODpz6awWxip9JRhWmSpIsYS/0yd5uFIonAjOZIdwHqt5Ey9fN7E1egQskr6k0KJ04+GWEo7xBOHsLq2PgxkjVp8CGcNss+cHEpzPHJuaNgFjwSUOS2emLiOb4tzR0clQVugqmqK5yEDPQPSCCsWmL/KcljuUZ+PFJusisORU7ylNNrR7ejUsRzt3KpPXpdSHk+KRqlPOmGNIq41p1wkLKRO9LpQ7cPZeZLsIKsgehBSKq2L8kpnAXZCpmGVaU5bzikCbMclBVcX8veVx36VefbHxxfSgo6hk6QzEnf5OFLCAx1lm4doF1MdyHCg6Dyv+K0I+wSuMtTacZCu6EBEcpp95i7FP2j2+5PRFzP238hkj2L2xn6Hbf969eJe02+lH1KvFe272afyALs/D/m9WlkIPl8WalazrykP3d5G/41U5BQ5ZqMvbe9/OiE9xPKfkos2tcF9P+q2vgPfUhYp79qbjd/TZEoab/9nT57spq66S+PSBqs6Wsc2wLENcGwDHNsAxzbAsQ1wbAMc2wBf4dn7ePA+tgGObYBjG+BfkIqObYBjG+DztAEO3P+RKgU7V/R6Jcvd3ZzbOX70uxfRxdaAXpRvL3KdIPHc2swM+n2eibA6ZwvVT2ep7S+e7dixOlieX14Em8Z7jzd02vMYaLz6qNyCI78AJabqsURJs/1MYuvMd3nBkIocxpNELdH4C0gIcS6t8igC459tOIHQKNTDuKofQbwqXbGvW1EImNXX//IO33WY7TqnDmvYN+plx2CVItoB2U3aRHcLRuPdWtUhgY+R7vGHy+Gp94uyIe9NFdmRgOUpnoRPvw9/aKYNLvkM0SGt85JvP3GfJgo8lLii4KG7Hw7FKjKtux/OtUHbmtx5L/Mt/mMX0moV55G/9Y3kH5AgsUu97nLTkowhy5w+/KWS/Vm8wMrLF19EgytTt6r5UMjCrHzfRc+/6gg0IXEdfjO8yqW7GCPMcPn4pNRB5zLMcExS1E1ya5GxWcxOa4rlchlmfhkpWmndXyr93mQ8gmqol+WTRER9SlcuPxNzZ4fnlFVJ/JurX2nw7du3I3lP8BdUZNmCf8NhN65B2dDUX1Cjzjdz67rh+D9/PueTjYU7288SLpxxHajXRfoe7sn57nHdHN1AJOs1ago3OtlsaNj3swZD/HPBtfCxPaTgLLKq65cKQxNYLqY8MXDAQydXRZU6ZY/5cK5Td1cldh4ALjilgkHgctInC779WO6gANtv91oieKIXnlHv2ncwSoqdBnq94hzLU2YP0o4bZfzy5hppJ8XTvVTFtETzJQ7Sz0Ewwv/UBHe6u1rrxtdBwuUsx5yENH5bqoQ8J0A1S7Cvt8UfjTsBl6uGkM3a7PWgn41zYZv8R0orWNx/qsj9zN4FVan31OQHOvX8BV9vWnM= +api: {"operationId":"upsertConnectionSyncConfig","description":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}}}}},"method":"put","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_config":{"type":"postgres","schema":"customer_1_schema"},"standard_objects":[{"object":"Contact"},{"object":"Contact","table":"my_contacts"},{"object":"Contact","collection":"MyContacts"}],"custom_objects":[{"object":"Contact__c"},{"object":"Contact__c","table":"my_contacts"},{"object":"Contact__c","collection":"MyContacts"}]},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert connection sync config","description":{"content":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -34,11 +34,11 @@ Use this to override SyncConfig and Destination configurations on a per customer ## Request -

    Header Parameters

    Body

    required
      destination_config object
      +

      Header Parameters

      Body

      required
        destination_config object
        An object to override the default Destination configuration per connection. -
        oneOf
        standard_objects object[]
        +
        oneOf
        standard_objects object[]
        A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. @@ -51,11 +51,11 @@ A list of case-sensitive Provider standard objects to by synced. If specified, t Connection Sync Config -
        Schema
          destination_config object
          +
          Schema
            destination_config object
            An object to override the default Destination configuration per connection. -
            oneOf
            standard_objects object[]
            +
            oneOf
            standard_objects object[]
            A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. @@ -64,5 +64,5 @@ A list of case-sensitive Provider standard objects to by synced. If specified, t (Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. -
          • Array [
            • oneOf
          • ]
        +
      • Array [
        • oneOf
      • ]
     \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx index 7d4b32e031..3d2492d103 100644 --- a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx @@ -5,7 +5,7 @@ description: "Upsert customer" sidebar_label: "Upsert customer" hide_title: true hide_table_of_contents: true -api: eJzlWHlv2zYU/yqa+scawLITJ/ERDEMPdECwdQvaBMPgBipNUTYbidRIyq5m+LvvPVKSJTt2vK7YMCxOYol89/HjsfJlxhQxXIrryL/y80wzZV7n2siUKb/jGzLT/tXEr4a0f9/xNaO54qaAiZX/OSAZDx4Yvt2vYTYjiqTMIC2MdHzFfs+ZNq9kBCQr+8oVA21G5azjUykMEwanSJYlnFprep+0FDim6ZylBJ9MkTEwUU4/MWrAtEyh7YYzjbO0NDDkUYNYG8XFDIjZZ5JmCQ4VMldBRa2DXHAwL2ioDkDCuuMLcOKwpLfFa5lmRBTetaDIAoby5DAPekuoeZEW1PF24dtfrzuNuEyc7kpep+UbBNRw42QpRgwL8yzCr4oIhDlxOpNCu+D0T0/xK2KaKp6hk8BepdRzSQfNXy0ZDd4n8xGNKJuex3Ewmg7j4CImw2A6ilgwuhj3x/14QMlgjMH9byfYhlZArEC/bkggSpECBHDDUv10YJ/ynY1GEM4oDtg4Og0u+vQyGF+MLoN+NOyPRxBcFvfRmH81QWlRpyc4Q07wccGjIzgHw2FMY0oCGo/GwcX5aBiQM3gantHR6HLKBsMpbQncm2ORp9ho83wKbYJx1iRhOpaKYuNlPGOR4gt8/oMJ6JuHULMEezHVYVSAWE51eD64DC0fksm5DKlKsYlIpvMEeWVuoEfpHB5n0iommUwSWelLZIy6OTSdwjLp+AkXjCDw0gS+pxynB5pBI6Nuoh6YkS1rQzcIboU0kXkUEkplLkzIxIzMWIrdDPQJoQ+IHZtYblyv8KQdNcwo4MpMquJQBJ3LLWVMKE7n5cvGPJJDym3JwbCAYFXSW2Y5eTXEVTRrjJI2RIDHuXqiB+fGZPqq14Mq75ZuYhf2yt7UvbP++cXlAHjaiHhdavDu3v3kQXQ9M2de2bcs8qqi7aI1Dgoh+lkG6nUIZDGf7aLs7ZxrD35RXMxZEnkVi7ecM+EBWnmA38RLZcQSL9cw5U1+se2v759XrkSS6q7OMzJLcmadyRJiQGjac1Che3LB1IKz5TNnmj7perdg/5bSOVPMI/CnmfGmBepXtWe61I9+T36wjG8rxpc314fMgU1Ab9HvpbPU9NyKFDjDAmtAUBlw0sX0Hl7KZZoCLpV+fTlYlsMHS+W1K4kwtLhhTa1z+uWay+Kw4g7rt3iAlEqbuu/QABYdw/4D8v1s2ba2EC0TGpsGZ3HY8tRfb3PXfm1F5B4JsUkioqJ/NEP/+/TUUkWeJEdny3IKkF4citt+yHKie8cj1xtUBnE+CrpYSbzBLmdrhRYlhD1uxPFIZm0qvhDKcG8cbJt1fK2VwX9sZwOp2WmAPVLc7P5VuGrJ+rAAud+3w90uRTtbEjcqcdPlqjxblP3+NTuxjM7eVtouTOahmZ6MbWJdQXDhUt/Y03b/fhP/Fc1V0X2rYZKrKIAjMNTbTbmf8oyUifecdWdd7329cTvpHgkVrRhtGd7IV5NsP7BvyrF5kKyPJmEbK/wm7kzut4XxyN85SrTPAe29/fbGvLHD3NrePWrcrjc7uo88ODePyuvtXN/Zlq+TiiFnZi7xeiTLbQkTM4eXXo01uMEG/HI3Hivf7k8bm1C+gRcuHaws+jsl9r6kQXTy141blve4VLh2ady1bDou4z+yovL9qkGDMUVDGImsG219oMYDKihOj8CRZOlFbMESbE5txyhlWttitwZBmPAW4N3mMudNVRhbly/HHcBre9uH7PqMvf8gzUUsUSnG27ly2j0bdMeNY8NbIsrjiDW+UwlDtlJtFe6GRlwJXjRXAphr57I1uVM4z+AHnDBKRrkt2A/w+ZUlQMwwpBjLtmUeqMzxxaGW9xssqZQIWLsYIoldqZAztVx1SXp4YJy5azvtAUx7jcuFLmqdfDN5lwsEqBupDbBv1juVi24GYwKLcZobA4r1YnayoVgul93Msdn1sPK6t5TqQWeEsnooyPIpZLVev09QuY3DK6Jt5eBZCgc/fvz4QTzREyWVPcE7/Y2E7bZlK/p1Pxj22eAOg1s55VnRtezEp81rzDnowMHVagrG3qlkvcZhKFZVuKvLBVGcTEvw61SdhD1ue9DuTSF7wa1bQhcEC+pq9+ps3ak4XkJbZeYg7X0DcG7uboF2Wl6d4kYLBhVZwiD+v/I/wAcvGrL6YsmOr/yEiFkORQM0Tix2MBzB523ocDhRPqBj1ZQoGkY2McX5gf/Rq0fJv8O8Ayh9X5O7mb0MNUQ5akwd7l3/BCYd5wM= +api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["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"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","deprecated":true,"properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","deprecated":true,"items":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]},"connection_sync_config":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","oneOf":[{"description":"Config specific to Postgres destination","type":"object","title":"Postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the Postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to BigQuery destination","type":"object","title":"BigQuery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the BigQuery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]},{"description":":::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\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"connection_sync_config"}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; @@ -38,13 +38,26 @@ Upsert customer Customer upserted -
    Schema
      connections object[]
    • Array [
      • schema_mappings_config object
      +
      Schema
        connections object[]
      • Array [
        • schema_mappings_config objectdeprecated
        This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). -
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]
        +
        common_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • standard_objects object[]
      • Array [
        • field_mappings object[]required
      • Array [
      • ]
      • ]
        • entity_mappings object[]deprecated
        This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). -
      • Array [
        • object object
        field_mappings object[]
      • Array [
      • ]
      • ]
      • ]
      +
  • Array [
    • object object
    field_mappings object[]
  • Array [
  • ]
  • ]
    • connection_sync_config object
    destination_config object
    + +An object to override the default Destination configuration per connection. + +
    oneOf
    standard_objects object[]
    + +A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig. + +
  • Array [
    • oneOf
  • ]
    • custom_objects object[]
    + +(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig. + + +
  • Array [
    • oneOf
  • ]
  • ]
    • \ No newline at end of file diff --git a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx index c9e565c511..0e309b58f1 100644 --- a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Upsert entity mapping" sidebar_label: "Upsert entity mapping" hide_title: true hide_table_of_contents: true -api: eJytVm1v2zYQ/isc+2EJYNlulgWZP23dOiDYMgR5wVA4gUNLtM1WIlm+2DEM//fdkZKsF3ctgtpAIpPHu+funnvEHc24Njxljmd04oznA6o0N8wJJa9giXptuXHvpRNue820FnJJB9SxpaWTKW2tW/o0oJoZVnDHDe7vqIQf4OUlSb11quAmERmcFxIWV5xl3MAvm654wehkR91Wo7l1JsbhL6zQOS4V24OLt3Q/AOA2NUIjUNi+X3FS7ZOrP4hbMUe8FJ89z7dEZByALgS3sNEwFJJslTcE8OciDUlDUMM/e2GqguwHjSy0UWtwZpKw8po8LMu5XSiT8uNJVBFIGeGLYHgo/exQTs3cqnfg20CNz36+TOfpRXIxPhsn5z+NWXJ5fskTxhYsnbNscc4A7v4peufWvVPZFl12g6VKOgCGW42ajj5azG/Xx6LmH3nqAAukDbRz0CHcPeTWgw1FKw991UvcPZK39AWS1zomM2awgJER9Am8x/L2wu6blZ3G3dIYygJwY3dLlzNlZtHnrAQH54F/eTYrqmE5xGDGsC220fHCfnN1grtj+fVJhTCJWgTyh2PHmD9sUYJplecMghjrZiFNyACx8+z7RK6G8EecSWGyBJTDbclNxX+nVE5O+HA5JHf1zJy2Qf6J6P4J4Dr9adWoA7zRr6ZZ1RnwddyZaB0FqkvoDqQ6K/cb54MDq5W0sWVn4zH+a9cniie5ro91C/gQtJdE96So1Rf0daVQnLUP7MDBn9BRG4Yd7WrcexQnbtaVKnuTo245p+1kNGJaDK3XbJl7PhRqVCwLN1qf9fp5V9qQ326uKIqB5ak3EOEOxzom+pKAt+QT3zbprcVffFtNy6Rh0xXQdjwIQ8AKmEBYnqsNyfia5zgJNqylKbdR0AMgKB/qzO1Bod5XRGkpyoGuPSFpKEKJ9aA63emddgfxyMh0J6ZJWNQaIRcKw2NjYs7j4duL4S/0QLNrJtkSqitdyDJKLIuoS4xVX3A0CiawtZlK7a91T1OQtkGn6a3NHvPewIdcSWdU5gPHH+H7L8/BmGPtsehtZARCevwRtYR8UJ6kTBJvOc63DTZwsginmq9gx5fxvmEJVJ8c5soOMer0h+mtlygbN8o6OP50UuVgvBxqWJPI2rl3DgLb9fL0YLHZbIY6HsNE66xHG2U+Wc1SXi8l2s9BCkcKmrEWfHOKwUMd3jEbKEYebv/Gxefn50f5leEprbCyZfxGw740160e1KR0/MWNdM5E8Ba6uCtnvpammpYDOmmp1QqCo91uN4csHky+3+MyjIiBEZ3C45oZwebINWB0Jiw+A1UXLLe8B6l+v9OT21IgTwmy9RjUavwlDvqaIUMnFB6DOjQmMoxCqQGvBvE9L4BHs4mouxfZOi28mb0aePfS978AunfQFoRo9HsMlNzHW0pl0buSoYjXL5Obh3uwnZc3u0JleMSwDd4p4e+EPsIXVTPkE9Q+rO9ozuTSw1SDTXSLn/8A+xhPUg== +api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","deprecated":true,"properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","deprecated":true,"properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.16.9","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/create-attachment.api.mdx b/docs/docs/api/v2/ticketing/create-attachment.api.mdx index ed386dcf5d..29b3f489d4 100644 --- a/docs/docs/api/v2/ticketing/create-attachment.api.mdx +++ b/docs/docs/api/v2/ticketing/create-attachment.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Attachment object with the given values." sidebar_label: "Create attachment" hide_title: true hide_table_of_contents: true -api: eJztWf9z2jgW/1d03tmZdiYG8zXAXu8uX2iHtmlyQHfbCRlWtgWosS1XkiFsJv/7vSfZYEiT5jrb30IyCZbed7339LF064iUSaq5SAah03MCyahmR1rTYBGzRDsHTshUIHmKJEBwYggUoWRLRIT/hQWarLheEL1gZM6XLCFLGmVMVUCEpnPl9C6dLYtyrg6clEoaM80kTt46CTyAhhs3yJQWMZMuD4GZo9oFoyGT8KSCBYup07t19DpFcqUlT+Yww25onEY4FK+3ImrO3b4LY7CwmCeDU7CYapIl/GvGojXhIZjHZxx81GVCnpC1yCShaRrxwEQMlEr2NeOSQei0zNjdQcmLVIolCJOuGfkRPxSNmJoJGbBvO1FoILmGPWMgwooFmeR6beJ749KUu9cMn65wFumZ0sciXKMhu+wHTiASjSkAUyWnq18UGnB73wObBWAH2AVJpSGEVmwgZPh9uhmP2NRG77GgjCBFWaIWQldSmILAaB5cM/04l9dtdQI/aLttr+m5zYZH3U6zw1xKZzTwaThrUhNkY0Qmo8elLbROe9UqjTSQVgIRV9PDZtdHAXnQppb5MSFfUmbMz9JIQFKEU3/9OEO947eatXrLrXcOZ26z2wzdbrvF3EbQ8hsNL+jSdse5uyvnwWUpqptAlbzcs3fXmKt9WflKwridUalIlF28ulfDf7s5WuoQtq+Ezt+WVUxKIVWJjkpJ11hmmsXq+/wh05R/c5nv19ksiyJiFJKYKUXnMCRFbPqDZLHQjFzkpVghyGCdIDQJScSWLCJiRqxC6JEga0nlmvjrLdfOOt9OIEghmzi9pucdTBwf6hMeYFhpqjMF3yfW/4kD07lJZvTC+rjOey9ZMclIIjQ+87BHLm8n+HG4+h0H7ENvRiPFDuxDIc3O2H8bqZPyx5lOqS8yPQWLdsZJKEA1amU3XGk7mIu3Zu8IH55f9Ifjz9PT8/7ow3ja/zQYjXd4MHt3WPYUF3SRCMCpv1jYRyVnP8mRuysTdagEyaJ84zSxp0G3WW/VA7fr+S232QrrLg1rUKO0Oztst2rhYVi3rFAJcyHXhuv3o/eD06Px4PzDtD8cng9BAZDYbULZVadBAL64WDhSRC6NIrFyoaDMRgVLZ+SYNbTiZ24AZcfcUracfv5wdDY4KeahUsxwx2s1wtqh3w0p67bbTXf0NqcRSQJVA84ZuiAShXBbvW7EkrlemMlGu7YzhfVkA7JX3r8FCyoV068yPXM7hieEUBjaM5EckFqNjFhK6l69QeqNXqvWq9fJm7OxIU1YZCjzDFaZicp0Jqm1066zV/FqeTpIlgoJjU3spAB4j5LKeRPTm+k2U2CD6HjendFpRbggoqSZJWEqOECYnKGoKeinO5pwk1C4S1RAYQVCmIWziEpm9gsrubps/Fu9ej1fZZ/O/fNf66//atPFx7fv1M2X0/f00/iPL0K87ehjb9X8tX4Mv+9oFr0Z6Rvv9ZvrpHYh3orzm/o7+fpsxhd/fQhnR1/59dfDk3juh1G8enfcWVzHaYON/Xbnazqvee8/vY6Gcz76Olz4f5wdrj+PZqJz8im+OA6K7M6DMpciS388corJJZNF8uSe2xnoswHEVNJEmegWGMUQg0QXJL5q1FqNtud5vwHuCqIsZKPMPxUx5Yn6DXAPw13KiMNWajiF5HMOSXQEeZFqt59AD4WGbohu3HJyusI0d1sZiVAJn81yMpYsxdrNUjCS0dhFL3jAXM1jm6bdWkG4XKMLMBdBZ2BJ7mvxMDWLf48WYqoZ2jLj88yi7m+wAa6IHmAtDDIt0WwDaDDUlI0n9KN8UyizmrUIXX/tpsK2Kk5Dr15dZD4CQh1WrduwQd6s3Ta0sW6nHbTabvdGLer3xC251BmN3IWAlmjqfGMuSIQ11W6pOQKG//+641YKBIhFPObahWoDH0BnDLsnh4QRSWiXrwY54j3IB9lUUD1IAxs4ZJXJFFzg7oOEVm20ziV+l25fcs6Qg+4fiIsJv2GqH9eOm41Ou9GuH7a6x+2j5kkDaq9+dFprd447XuP09KR23D889O5/oMbvJgkCT1hvP2Lxg1D1PhAaZSmdA7DIwRCiFEKVEgFHcLd9/zPTu6DmbDAaDT68mQ77//04GPZPp68H/fenFr7r6An6j4gvOUMctRlFWLVVt4+8UBxSFJDtCcjrcfiEUbsrkV9uUeQzZnvGbM+Y7RmzPWO2Z8z2jNmeMdvPwWz7kM05Pjo1gKo/GtudyNnAqSdgmfx872mnszy8D9H2zwc5ng0eOCsqMYI/4XDuu6D1YTh5t/kcAF7SC4G3HSmUAyqnegFPVVq6njjI26G9mjAnwtvdIeUVlUPhChdVe64KWqrL+j3cusHMRxcDp3wmP0Koav0tncxvQ5bydwxjtrlQKGj2rxL2cPLFgAAV0YIY1AGAeQmtF6KrzJjZgg1sNgZBOHCfH26vAvoFvi0f3ZcO5/dP4LcH8E87ZS8fsj94kr5/kG5Py/cOy59+Is6TmUA3cEFtmLxKrV3plurlY4KXPiEZF4uJ8SEvLiRbcrZ6mVsEwAXlFJHI1xZfImL7IhCKQP1nkxzgEBq9kz07k/fudXq9HhQpmyTjBVdkxgAOQt3CV5FEa0KXoIVCAeB1VG4arqpiEV7AFZdVSE3wsqqPTTiV0H5JGtGkQi5PrBMkU1cv0GQtehq2zR2TX5IZHnULVAyBk7HZFSqTBIybJL/AhwwQ14aZhXHw8weLgJGhLZhaRTBNCDcRfQngPMiwvqxA8llkJKAJGAOc6C/Sg4gV1Ecui8vQTSn2seK2S1VQ4eXv6DrojMHV/K0Prd4ou3pRBByXpFL2rwqx0OhX1fK7ll9tC/mlUfGPy2GWmEhDn4hpshUps6QCgCNOsPz9TGvwRi3nL7cUq9Wqklo2o7LQX10Jea1S2BU2Q26a+QC6q2KJSAFyDZWbKB9TZcqUfBy+nyR//vnnJHlKD8pJTbu0JpRy1l7gEvrgFe/t9ormB297bcVqdqMx0twYkt+p2VZ76dDdm2DEJTh8e+uDyx9ldHeHw9CTpLmtPEDMyDHxzd3lQdH8zDs4VzgRFu/ED3vzYphvVi/J33kH/E1/TTO/d5dtggTjDt4U/7Dh+/e+jxqwfw29Y4IlOsmB9tjeARYU967nthwWsD9Ke1XaZy/OR2Mg9vOL5liEyCPpCi+t4W/PmcAPPOQo3+w9OH7rQNeaZ/B2gVuAkYvtnGaYReWt0u6L+RfMimIqWZesLO+h1hH8i259k/yfWHqwCf9rQ25nHmTYbMmWmluQdfc/JUxbsA== +api: {"operationId":"createAttachment","description":"Creates a Attachment object with the given values.","tags":["Attachments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}},"required":["record"]}}}},"responses":{"201":{"description":"Attachment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"file_name":"Screenshot.png","ticket":"0958cbc6-6040-430a-848e-aafacbadf4ae","file_url":"http://alturl.com/p749b","content_type":"jpeg","uploaded_by":"28b54125-287f-494d-965e-3c5b330c9a68"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create attachment","description":{"content":"Creates a Attachment object with the given values.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/create-comment.api.mdx b/docs/docs/api/v2/ticketing/create-comment.api.mdx index b088e11dd6..ceff8271ff 100644 --- a/docs/docs/api/v2/ticketing/create-comment.api.mdx +++ b/docs/docs/api/v2/ticketing/create-comment.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Comment object with the given values." sidebar_label: "Create comment" hide_title: true hide_table_of_contents: true -api: eJztWXtz2roS/yq6PnNm2pkYbF4BenrOzYN2aJsmF+hrQobKtgA1tuXKMoRm8t3vrmSDIUmb22nvXyGZBEurfWm1+7P22hIJk1RxEfcDq2v5klHFjkQUsVhZe1bAUl/yBOdh9kjPpoSSnIII7wvzFVlyNSdqzsiML1hMFjTMWFqB9YrOUqt7buX0qXWxZyVU0ogpJnHm2orhAXhf2X6WKhExafMAVnIUOGc0YBKeUn/OImp1ry21SpA8VZLHM5hhVzRKQhyKVhsWrnWzq/wI1CvmSf8Y1KWKZDH/mrFwRXgA6vEpB+tUmZDHZCUySWiShNzXjgKhkn3NuGTgMSUzdrNXsiKRYgHMpK1HfsaOlIYsnQrps7uNKCSQXMKOMuDhlPmZ5Gql/Xtl04TblwyfLnAW6VmqDkWwQkW2l+9ZvogVbj5MlYyufklRgevbFpgQAD1AL4glBS40bH0hgx/TZSk45rv+cPdps+HWGnatvT+1G51GYHdaTWbX/aZXrzt+h7ba6ClUnPrq+8yCgNWnntuyvTbz7Ea7Htht12/Y3n7bdZy225q6TWTm5d7Z5RRnYUg9ZGW8teH8YQ6Rv+RhiAGUMogcxWbmaKXEYyQQMfuHfBIZoUCTzkUWBgSsJ8MsoTM4MBWUO1dROPk/Cv/L+7uQD1+1Cor7l+xON94vf+q1/WbTa9mu77Xthtfw7c4UH/c7tUat7rbcToC8eTpJJF9AFinx94QIGY3L+6Qj+aYc2+cmUvKdWWu5xfJid0kehDBuZtIE/GHirua4+G8nweVpzaRBTEO/6DQwKYVMS3RUSopmcMWi9MfrA6YoD+/ak9v5YQq7RLRAErE0pTMYkiLSeU2ySChGzvIUUiG4wBhBaByQkC1YSMSUGIEmpBZUroi32qzaOlHXY3BSwMZWt+E4e2O9P/AAw6miKkvh+9jYP7ZgOldJj54ZG1d5wSBLJhmJhcJnHnTJ+fUYP7DF73HAPHSnNEzZnnkouJkZ82/NdVz+WJMJ9USmJqDR1jicDRCNUtkVT5UZzNkbtbeYD07PeoPRp8nxaW/4djTpfewPR1trMCtvLdkRXNCFwgejvrGgh0JOfpMhNxfa63AMJAvzOq99T/1Oo9aswTl1vKbdaAY1mwYupFbame63mm6wH9TMUjgJMyFXetX7gzf944NR//TtpDcYnA5AAJCY8paaXae+D7bYeHCkCG3IN2Jpw4HSBRa2TvPRe2jYT22fQgDapWg5/vT24KR/VMzDSdHDbadZD9x9rxNQ1mm1GvbwVU4j4hhODRin6fxQFMzN6bVDFs/UXE/WW+7WFJ4n45Cd4/3Mn1OZMvU8U1O7rdcE4ApNeyLiPeK6ZMgSUnNqdVKrd5tut1YjL09GmjRmoabMIzjNtFcmU0mNnmafnYrj5uEgWSKkmiixFQJgPXIqx01EryabSGk5jbbj3GiZhoUNLEqSWRwkAspBHnzd4kxlMtySNFcqSbvVKq2AwAq4MAumIZWs4ouoajhXF/V/0ucvZsvs46l3+mftxbcWnb979Tq9+nL8hn4cffgixKu2OnSWjT9rh/D7mmbhy6G6cl68vIzdM/FKnF7VXssXJ1M+//Y2mB585Zdf94+imReE0fL1YXt+GSV1NvJa7a/JzHXefHwRDmZ8+HUw9z6c7K8+DaeiffQxOjv0i+jOnTKTIkt+3nNQWRZMFsGTW25mIM/64FNJ41R7t8BWmhg42sDxed1t1luO4zyDwuuHWcCGmXcsIsrj9BngNRYKGmh2mEr1SiH5jEMQHUBcJMruxZBDIaFroiu7HJy20MndnIxYpDGfTnMyFi/Eys4SUJLRyEYruM9sxSMTph23IFys0ASYCyEzsDi3tXiY6M2/RQs+VQx1mfJZZsDEHcuqcMLvWVoopFOiLgOoMJwp40/IR3lRKC/VexHY3spOhElVnAZOrTrPPASyKqgas6FAXq3sFqSxTrvlN1t25yqd126xW3CpMhracwEpUZ/ztbrAEfZU2aXkCO8e/1t23HABB7GQR1zZCL4klDA7gurJIWBEHJjtA4jpOPeug2gqqO6lgQIOUaUjBTe4cy+hERuuco4/pNvlnC/IXxZ+wi/a/XpR7dA9bNTbrXqrtt/sHLYOGkd1OHu1g2O31T5sO/Xj4yP3sLe/79z+wBm/GccIHWG/AXpGEwOAHgKECmCbgyFEKYSmqfA5grvNS6ue3gY1J/3hsP/25WTQ+8+7/qB3PHnR7705NuhYhQ+Qf0A8yRniqPUowqqNuF3kheyQooBsD0Be34dP6LWbEvn5BkU+YrZHzPaI2R4x2yNme8Rsj5jtEbP9Hsy2C9msw4NjDah6w5GpRNYaTj0Ay+SXew+7VebBbYi2eznI8WJwz1pSiR78DZdzPwSt98PJm/VnD/CSmgtsziRwHFA4VXN4qvpFT2Uvz4WmnwJFAjsORWlIeCUtLpi5qJprUxBRXdRugdY1YD4461vlRsIQcaoxttRO2Pgr4a8ZOmzdBSlodvsfOyD5rE+AiihBNOQAtLyAvAuuTfWYrr8aM2uFwBdY5Aeb/kWvALflfoPpKDysbVDqGjysNVB0Bn7Fdf/Wbf+vu8Lf3OA/7Fp++1a+uHnn8VSgNzGuzG45FbdV6ZTO7LsYG2YBGRUxhdtEnpxJtuBs+dTaasnkoVFoii8ykXkZCYSf/nsdoxDVMLcdxFuTt3pi3W4XEgUbx6M5T8mUASSF3AFfRRyuCF2AFGxaYCsvVw2DK2Uhdi6LRh9SE2z09bAQgDfAsUlI4wo5PzJGgK8vnqDKSnQVlO4tlZ+SKV63CxQMjpOR3rfKOAblxvEf8CF9xNZBZqAk/HxgISxkqAtGeOFM7cK1R5/CtvsZHnPDUO+/T2O98QrtRXpgsYRjmvPiMrATirm06BSmFRR4/h5Nx6wBpuZvnqj1WtjFk8LhuCWVsn1V8IVCu6pmvW3Wp5t88lSL+Nf5IIu1pyFXRTTesJRZXAHQE8WYhbxMKbAmXcyebiiWy2UlMcu0yEJ+dSnkZZpAZVoP2UnmAfCvigWiFYg1FK69fEhTnS3Iu8Gbcfz58+dx/JBUmJPqlG1UKMWsaXsT/+6u+PWmR/QzDXKTQRW7UuhjrlXQ0X+dJ/pzyy81zxES4dj1tQeWvpPhzQ0OQ0aUusG7h3CVmybdOZa3PPXq13+e4kRQvI7fb8eTQV4nn5Jf2Ta/01hdSm61/7WHYNzC5vpPK77bKv+uArud+y0VDNFRjvFHyGdDcaszuFlh3hW+S3tRKvFnp8ORtek+RyLANZIusc8Pf7vWGH7gIX/B0JUPx68tSFazDF5sgMbwxSxOMwyhcqE2VTn/glFRTMWrkpblCm4Mwb9o1p3kf+GJAwjw95rczNy7YA0IDDU3+O7mv0GRuuY= +api: {"operationId":"createComment","description":"Creates a Comment object with the given values.","tags":["Comments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"]}},"required":["record"]}}}},"responses":{"201":{"description":"Comment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"user":"17a54124-287f-494d-965e-3c5b330c9a68","contact":"dde3fb16-b8eb-483d-81c4-b78100816f15","body":"When will these integrations be done? You all should use Supaglue.","html_body":"When will these integrations be done? You all should use Supaglue.","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","is_private":true}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create comment","description":{"content":"Creates a Comment object with the given values.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/create-ticket.api.mdx b/docs/docs/api/v2/ticketing/create-ticket.api.mdx index 8171a685ee..646f9ecb3a 100644 --- a/docs/docs/api/v2/ticketing/create-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/create-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Ticket object with the given values." sidebar_label: "Create ticket" hide_title: true hide_table_of_contents: true -api: eJztWntz2zYS/yoobzqXzBgSHxL16PV6fiVVEsc+S2mTszwqSIISY5JgAFCy4vF3vwVAvf2qp/3Psicxgd3F7mKx+4OWNxYrKCcyYXkvsrpWyCmRdJCEV1Rae1ZERciTQk3D5KGeFIggQ4BY8JWGEs0SOUFyQtE4mdIcTUlaUlEDdknGwupeWIZcWJd7VkE4yaikXE3cWDk8gORrHJZCsoxynETAmKjlJpRElMOTCCc0I1b3xpLzQpELyZN8DDP0mmRFqoay+UqEY91uqz4A7RbzqHcE2hKJyjz5VtJ0jpKI5jKJE7BNrhMmOZqzkiNSFGkSai/Bopx+KxNOwV2Sl/R2b82KgrMpCONYjzzHDkFSKmLGQ3q3EYsVULXCljLgYUHDkidyrv17jUmR4Cuqni7VrKKnQh6waK4U2WTfs0KWS/CFmlozuv5VKAVudi0wEQB6gF4QSBJcaMSGjEeP0xnH7fojL9OUBMohRq2Vf85SSgRFJIpQxjiFLZJ0bAJYKI8RIZJxTo34SizhnMzVbkiaiYfd77RIs+G4Dey2WzFudBoR7vhNir2wGXieHXaI37ZuYR19UBh/WJoXk3Yz9hu42XJauNH0XRx4cYjdsON7se+TmPh6m0s6iuBoPSzNtV0XOzZ2nIFtd/Xv/xS3kESWj9h1enb8cSegHmI4JDr2UfGAv39BPfnPNEUZuaJIzPMQhCCwg6CsDCcIGBPKf1DLhixNYf/1Jj1rX+KgHTabgY+dMGjjRtAIcSdWj62O23A9x3c6kd4XqVPNyEh6SGIC6qpjr4MmDFlpov5+BrvTbIdB6GPfbti44dkEtxttignsYhiQKG4QamzNJQkfEeY3Q6/RDAj22y0Q1mk1cLsFj1HkOU27E3p+iyhhkC5Bx5Gx6mGRLRWhkd3Anh25uBF7FAe00cRuq+21g7DT8BquEmmS8nM2ATShvOCJoOYIMDUuaTQij6gGketgx8V2ZzNyq80qefow/0TKQnTrdTlJeAQukXPBYjkD39RAiTrkFJVd6l49EaKkdZ3/QU9m0uBDkn/tvf1VG7NKhBdWlVoXR/xSKSo1uSmPi+3Y5quy3uXtrZkRBcS7yUSu7aj/tvK5qaJGqCp7f1H2pZwz/pQ9voc/opIkd27Jbj2KIVMjvSDKqBBkDEOcZbqOcpoxSdFZVbJqSDEYIxDJI5TSKU0Ri5FZEHAEyJoSPkfBfMW1sV83Q3BSRIdWt2Hbe0MrgDoGDzBssiD8PTT2Dy2YrlTSo2fGxnmFT9CMQjrLmVTPSdRFFzdD9bES8ZsaMA/dmKSC7pmHhTQzY/5bSh2uf6zRiASshNAWm+MoYrC0WpVeJ0KawUq8UXtD+Dnk7fPBl9HR6XH/42B0/LnXH2zwqFDdYNlaeEGXshCM+k6jY7XIyd9kyO2l9jqcAk7TClRq3xNIP27ThaRtB00ohJCgSORAbSWduOU3nagVuYYVTsKY8bnm+m3/Q+9of9A7/Tg6Pj8/PYcFgMTAKWF2HTI32ILVweEsxSRN2QzDgdKADrZOy9F7aMTHOCQQgHgtWo6+fNw/6R0u5uGk6OG23fQipxV0IkI7PtTw/ruKhuW5qWWaLkzZQrg5vTil+VhO9KTnOxtT6jwZh2wd75/CCeGCyp9LGeO25lGAQNOesHwPOQ7q0wJBJvWQ63WbTtd10duTgSbNaaopqwgWpfbKKObE6Gn22a7ZThUOnBaMQ1lhGyEA1itJ63GTkevRKlKg8rVt+1avaURgELG2Ms2jggFEqIKvuzhTkOE3VlokdFKDBWvgwjKK00U6N5LrU+8X8fOb8az8fBqc/ui++e6Tyad378X116MP5PPg96+MvWvLA3vW+NE9gN/3pEzf9uW1/ebtVe6csXfs9Np9z9+cxMnk+8co3v+WXH1rHWbjIEqz2fuD9uQqKzw6CPz2t2Ls2B8+v0nPx0n/2/kk+P2kNf/Sj1n78HN2dhAuortyypizsni+5wTlU8oXwVNZbmYgz4bgU05yob27wPKaGCRikPgzIATPt237JwBjYVpGtF8GRywjSS5+gvsBTRmJtDiVSjUnFMJxAkG0D3FRSHycQw6FhK6JrvF6cGKmk7s5GTkTeRLHFRnNp2yOywKUpCTDyookpFgmmQnTjrMgnM6VCTCXQmageWXr4mGkN3+HFnwqqdIlTsalAZh3sNXhhN/DulBIp0RdBpTCcKaMP1NVy3dY9V5EOJjjgplUlZDIduuTMlAXJxnVjdlQIK/n2Ic01mn7YdPHnWsxcXfETRMuS5LiCYOUqM/5Ul2QCHsq8VpyhLvun8uOKyngIJomWSKxAuQcShjOoHoCNAMPRmb7HIgR+14+iKYF1b00UMAhqnSkqA3u3Etolk3nlcRH6bYlVwzV5fQZftHu10zugXPQ8Nq+57utZufA328cenD23P0jx28ftG3v6OjQOThutezdD5zx22Fu0COD62d27z1iFwj1y4KMAVhUYEihFASXURYmCtytviPR05ug5qTX7/c+vh2dH//3U+/8+Gj0pnf84cgAZI07H1t/HwU8oQpHLUcVrFott428lDhFsYBsT0BeD8Mn5bXbNfKLFYp8wWwvmO0Fs71gthfM9oLZXjDbC2b7ezDbNmSzDvaPNKA67g9MJbJWX+M9jmUuzTd4T+tiJNEuRNv+bjBR3wvuWTPClQf/hi/nHgWt98PJ2+VnD/CSnDDVCSzgOKjFiZzAU11WLby9KhWa9p3+5nZVGYqkJioYXEtYxQMr1KfuDmZd4uX9s5613rfqK5hqbF3rXq3cVSTvqfLXsum2oNlut21h5LMeAiokGdKIA8DyFNIueFboMV1+NWTWCoErVI0/X7XLjhfYdr29VSnxYFdqoyl18bQW0+Vah+lpbaT1LtLdraJVp8i0g3bau39dy2er43PxtP7N5Vb7ZtWjWWvRPK0Ps9aGeVqvZafV8rR+yqrHvdYcudzujdzdANnsf/z5Jsd6j2PVyEjymKnIVGfU7Ktdc/xaZy39fcpVrzuquvhqB9XheHXG6TShs9fWRg+rivDFcVV3wszc6yIWiv8szzvoCHObpmxM7rSzu90u5Fw6zAeTRKAYor1U0SYQy9M5IlNYRfWAVRe+Uk0dVEFVXC179IoaqR798dL/EMAkr6GLQ2MEKsXlK6WyZF0JKGhD5dcoVp0LE+bwZ6bDvDbMQblh/g/4oJ66pkSlQeXw8ztNgZEqXVS2WDhTu3Dp0ddw1wrLDILCCERf4GCFcMBK0E8qexU9iJjB/lWyYNux3vdlk1/U1IIXvynTYc0MTK0u8Urr5WKXrxYOV1tSW7evDr6Qyq664ceGX6xy82u9xA8X52WuPQ1pPyP5SiQv8xrgxyxXGT0opQRrxHT8ekUxm81qhWHTSy7Wr88YvxIFFPnlEC7KAO5QdTZVwA9iTS2uvXygUo7yyafzD8P8jz/+GOZPKSsVqa5+RoW1mDXvqyB559ssN6tu2zNebDH5SdJrqTycaAWqNqapmBeWXL30oqClGrq5CcDMTzy9vVXDUFq4fjFjT8H+xLzwcKFgQlXD9NcoiVAT0eJrjfuteHVe4Y3X6K983eVOW3VN3nltRzsIxi31UsyzFd9+xeVBBbbfuNlQwRAdVnelgZKzotjpsK44zJ3rQdrLNah0dtofAHFQvVOTsUjxcDJT7+fAv11rCD/wUF3UNIRQ4zcWZKpxCRdEoDFyVQonpYqgdcRj4E31h4qKxVQ+X9NyHQoZQ9S/yqw7yf+ljhtgqX8vyc3MvQxLZGWoE4OTb/8PEOTelw== +api: {"operationId":"createTicket","description":"Creates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"create_ticket"}},"required":["record"]}}}},"responses":{"201":{"description":"Ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create ticket","description":{"content":"Creates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-account.api.mdx b/docs/docs/api/v2/ticketing/get-account.api.mdx index abb00bf28f..083bb78a0a 100644 --- a/docs/docs/api/v2/ticketing/get-account.api.mdx +++ b/docs/docs/api/v2/ticketing/get-account.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RV2+2IB3pXiuIa7KIqmTRAY7YPh2DUKybAp7khivEtueJEsCPvvndm7LjZSpw+tH2SJHM6cOTNzyE2gczDcSa0ukiAO5uDeCaG9csFxkIAVRua0iVtxHCvtYKKuF9KyGXDnDTD8qlW6ZnzJZcqnKa4odmlgKWHFnGYWUhCOCW+dzsCQNdPesA/KgcmNtMDylKuIjX/TynE09fbuKENnTscOePaL9Tmfpx4iobMBm2nDMk2BFX7NSuTRRCG4iZqoK0BQyjKuWJ0G09PPBGAl3YK5BbC5XIJiMsFDmKLjcxvE46C2tsHdcWBBeCPdGtc3wVPIcxk+Av26K3A354ZngOBtua/wB5IjlUh9AveGr+4T7ji6lkTaFw9mjT+sWEDGg3gTuHVOB6Zap8AJAjzxLE9xzRkPxS7rtwtA1IaorGMwjMEoBtbAoduEzYzOytzemoQhPrdmudFLmYCJguK4BfkUNmUIZdIgXABHu0MQrTNSzfsIg2zduXgT7IG9RgzNPrt4j5g41lNJZAFbBPEoJ2cSbAm2NcSGWVNL8DxPpSgrikENfPHSQNLw0suiSS4sV16Th+UpWOwfAYeTaCKwOsKzYHjVN/cdnzl3i70TX4dqdPLDuZiKs/BsdDIKT9+OeHh+eg4h5zMupjyZnXLES01owOZaWbDk8GQ0on/bWdQN/b7qRYGzheSTWY/l4WdLtpt9cNXQ4EEkAvXBySpSlfR+Csqn5ew3yXYp3fK1ddywK70WuuRa42wr2/PCjeE0ItJBZl8maFV5Cw15Iz1ANoo+1+OgLlgTBrly0qW9UtEROoQzvNC15FGiVLY4GNZWdrjpSltQV4FZNjPvTUoN51xu4+EQ9SFqNUrqoZPiERxCHy5P9kT0U23I3l1eBEVPbD5RCSqWe5LTkZTL34FYaoegsdlt/502uLxgaEXywdNUo3DAElKqqS3XhABbjWMJqCBvM02BKdvKxyh6cxb9GHRM3iia4oRdN5nSYXZUq/6g7jfU8q5n2sSpnqTuuJRoYbfUHfe2qd3a3BvU//6F9D3+sQvljE68oA26o24hxYNAWIj3hsySwpbRAUN2fIYzWzlkf2nPBF5rHvE5ypfs0cUKm6f2JU0Sbqu/jSjg+E9KHWNmmGo16iXqNtjdUUM4lSTq5zdELhzlNazOh9V523X5oAzx3fjKq5JpbV3GVefSeBXluKZoNqbeOczGLueDzmK1WkV5dawM2cQfrrR5tDkX0C6FuZ+ieg01dmfZaxS8ZPlXbsseZjdXf0zUw8PDRH3NgNam1Fw1hF7PfgTH+OHX0KaT1P9BH77mYVTpjoMnRz0gS4rK6dzUWjluFNWiedy7CFHVFsglWWw2U6zLjUmLgpar1xBJaCItcYL6O+OphRfY/eYH0DO5lPp66N225CRTcVDK85IbWd1s/wj00VV9JQ3Yc/EbYVfrfswGV4/O4g6ta3l/NYp/82X2Ap27L8yOy+NvAL77GnsRwO7jcAtCZYQTALnr7e29iaj07QPh44drtOWemr5/IVe3b/2FKnOwpP2bugpPnwTmoPlPpGF41f/cmlc7zx5oL/6moalhiuJvKI3THQ== +api: {"operationId":"getAccount","description":":::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\nReturns an Account object with the given id.\n","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"AccountData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}}}},"method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get account","description":{"content":":::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\nReturns an Account object with the given id.\n","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-attachment.api.mdx b/docs/docs/api/v2/ticketing/get-attachment.api.mdx index be82831a18..85cc96dc56 100644 --- a/docs/docs/api/v2/ticketing/get-attachment.api.mdx +++ b/docs/docs/api/v2/ticketing/get-attachment.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get attachment" hide_title: true hide_table_of_contents: true -api: eJzVVltvIjcU/ivu9CVIDBBCsoCqqml3tYq2D6tcuqoAETNzACczttf2QBDiv/ecuTFAoNtsH1oeErDP5TufP5/jtac0GO6Ekjeh1/dm4K6d48E8Bum8uheCDYzQtI+7/X5fKgdDeT8Xlk2Bu8QAw69KRivGF1xEfBLhimSfDSwELJlTzEIEgWNBYp2KwZA1U4lhH6QDo42wwHTEZYMNflMSczuW2NFZjMGc6jvg8S820XwWJdAIVFxjU2VYrCixxK9xCr4xlAhuKIfyFhCUtIxLtq2EqckTYVgKN2duDmwmFiCZCNEPq3R8Zr3+wNs6WG9U9ywEiRFuhVtr78XnWvjPQL9GG9zV3PAYsASb7kv8gRQJGURJCGPDl+OQO47RBVH3NQGzwh82mEPMvf7acytNDhOlIuCEAl54rCNccyaBzT73X+aAwA0RmudgmINRDjwJh2FDNjUqTsu7MCFDfG7FtFELEYJpeJt6CfLFLw7DF2GBcA4c7V6DaJ0RclZF6MWrbYhz7wDsPWIo9tnNe8TE8VSlQBZQKIhHOjEVYFOwpSHKZkXC4FpHIkjPFZMa+JoIA2HBS6WKojg/XXlLHZZHYFFFAbxeRJGB5RmOguGldMZbSjV38wOnbwPWal92g0lw5V+12i2/c9HifrfTBZ/zKQ8mPJx2OEImHRqwWkkLlgK2Wy36t1vIFtv7TJEB3jO632hZ4br5ZMl8fYgvuz3oiHRgu3AiSzYVEYyz+k+VchcYAGnnyjU0biHPTgTP4P6GgF5JQOc4AfUMRGKi09Hmzul+s8kjbA4RtZGmftfpTShATsY4cz4V5ElDCj/RkUKNhePJ6rRDuzu57Jy3L/12993U7/Q6od+7ugT/IricXFy0gh6/6uIhVhUyqLBaElWpcg/vLpjRhj51D9vSXOXtnE6NZNj3mlsd2OZ6R7Abui5gFkUzS/lMSbPEmhaNsgUL1cxQYbHNRftgRtzlhuz68423qXTRO1JVJpxKLy3pw5VPQB2yvN2Fzf693s2HaRhaUV/kUaSwI8ICIpKpTdeCAGzWZ1JAG4o2VZSYqs1itBrnV41eyrdLD+5BUnsK2X1RKTmzs3yo1fJTwFFFcXLAReGkABpeuBSqwO4MLzqvHWp3Ng860H9/3v6IH3YjnVFhEtAGjeAvEKEjEBbivSAzpbBktMaQnYT0lwVkf6qEBTi1E8TnqF6yxxBLFE8eS5jQ3x1rtkEJB39Q6ZgzxlKz7pWiLpONzgrC6Uga1fqayIWjupqZv5/5263Ka2mKHwa3iUyZVtbFXG5DmkQ2NK5JuhuTxDmsxi5mta3Fcrls6MwtTVnkby6VebaaB1Au+TqZYENuKlRnqjVKnrL8K7ephtnD7e9D+fj4OJTfckFzUxJXDqGi2Y/gGD/63ltvB8X/QIpvfPpl3cfBiyMliJSofJxkfXNQmZ8WPfq7ox473Bx5Jbv1eoJn9GCizYaWsycftdNQWCIHO/KURxZO0Pzdr7wjFaW99rXH6YJTy+p7aatecCMI6D8EfXabj68aO5a/aPJyVc1Z4NpldDNCh7zbvxnIv/kCPcHo/kt6S2f9O4DvvzpPAth/BO9AyIyucQhqV9k7ePXR6Zevho8f7tGWJ6T+6nzOhnH+hU7m1VOtDu4sPf0lMK+a/0QtDSf/z6V5tnPUoXwHFJomwWw2fwEYdiJn +api: {"operationId":"getAttachment","description":":::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\nReturns an Attachment object with the given id.\n","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"attachmentData","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}}}},"method":"get","path":"/attachments/{attachment_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get attachment","description":{"content":":::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\nReturns an Attachment object with the given id.\n","type":"text/plain"},"url":{"path":["attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"attachment_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-collection.api.mdx b/docs/docs/api/v2/ticketing/get-collection.api.mdx index 2fe0098041..2abbfc678b 100644 --- a/docs/docs/api/v2/ticketing/get-collection.api.mdx +++ b/docs/docs/api/v2/ticketing/get-collection.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get collection" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RV2+2IBXt2iOvKiKJo4aSDUD44vDQrJsKndkcR4l9yQXMmCoH/vDPcqyzZipw9tHhwtOZw5MzxzhhtPpaC5FUqOIi/w5mBPVBxDSCveoReBCbVI3VfgBUEglYWJvFwIw2bAbaaB4U8l4zXjSy5iPo1xRbIzDUsBK2YVM0D+WJgZqxLQZM1UptlHaUGnWhhgacxlm41PlLQcTTNzfZCgM6sCCzz53WQpn8cZtEOVtNhMaZYoCizxZ+LAtycSwU3kRJ4DgpKGcVYnwtT0K0FYCbtgdgFsLpYgmYjwGCZp+dx4wdirDxjv+tAzEGZa2DVubbx7n6fCvwP6ut7ibso1TwAzMG5f4gdWSMgwziK40Xx1E3HL0bugyn3LQK/xw4QLSLgXbDy7TunAVKkYOKGAe56kMa5ZncH2Yem/LACBa6pnEYNhDEYx8CIsuo3YTKvEpfdGRwzx2TVLtVqKCHTb2x5WIO/98i58EZUIF8DR7jGIxmoh502EXrKuXfS8PbCXiKHcZ6MPiInjpUqBVUCeIB5pxUyAcWArQ2TNmnjB0zQWIS8YqOFbJjREZV0aWZTJ+W7lNXkYHoNBEoXweBJlBFZEeBJMWFHnpi5pyu1i79D3Aev2fxmG0/DIP+r2u/7gTZf7w8EQfM5nPJzyaDbgCJl4qMGkSFgw5LDf7dJ/u4nUtP6QMzLENsMrIMtGrTtfDZlv9vHl3YMHsRyoFlbkwfLU97OQWexkoMy3zupzj53F3FLX7tX7JX7+QAWwmod3aMh4HDPLzZ1hGtA59gH2SBnGicVnR9HGFeWRXhLxdHRxSU6wq7ByN7Wvl7k5Gvam3Vn01h904cgfTI97/hD6b/z+sDcYvu13j7tTx0QehmDMTQxLiF8W4ezq/enoBKnR5N04vytkixU23uUrmm7JGrVsoYoRQFdN3A28Tm1oOpsdlm+px0AvSwXMdEztZ21qgk4H1bJdybZQHSvCO7CIvrPs782Vi8KQvTsbeduG9F4QFXO2NQS4qgeu/Akkq5UklDYPxWA3HoZhaEVEQfYolFEqNHHbuDVXfSdODtCWvM0UBaZscx/ddu+ofezVJb2SpGkRuywzpcPsoBiEraLvcLzVvVMlTr1PAw+XIhWanYGHe7ul3dnck63//oz+Gf+xkbRaRZkjE43tLxDjQSAsVPeymK6EVUVbDKuTJdiBuUP2t8pYyCWCwZOUL9mjixWSp/AldOTvzkLTpoDjvyh1jJlgqrnkOdRVsOuDsuB0Je1mfp20kJdOft7Pz5ua5S0X4qfxeSZdpZWxCZe1S53JdoprknpjmlmL2ZjlvFVbrFardpofcyHL+J2V0ncm5SFUS36aTVHFOwrZ6bhGwV2V33PjOMyuzk8n8vb2diK/p0ELUyd4OYQGZz8B8uTJN+Kmni7/Ayq+7rmYi4+Fe0tEEK5OrkU3hWyOG/pq8ESw+zxAgVtgWclus5niFV3peLul5fyZSGoaCUO1QUGe8djAM1X+4ZfhExk5qX3sQbvkpFiB55R6ybXIJ9GLQB+cF8OpxZ6KX2q8XDdjlrh2K7q9xgOF2L8ayL/5an2mog9f33U5D38A+MOX6rMAHj6cdyDkRu9wBqa2sbf3UqTbrx4Nnz5eoi3PiP3N8ZzP4uIH3cyjt9qc23l4+ktgHjX/lRQNB/9vlXm+8+SB6hlQcpoIs93+A3jPNso= +api: {"operationId":"getCollection","description":":::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\nReturns a Collection object with the given id.\n","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}}}},"method":"get","path":"/collections/{collection_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get collection","description":{"content":":::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\nReturns a Collection object with the given id.\n","type":"text/plain"},"url":{"path":["collections",":collection_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"collection_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-contact.api.mdx b/docs/docs/api/v2/ticketing/get-contact.api.mdx index adcc9ecc4f..5f043cf5bc 100644 --- a/docs/docs/api/v2/ticketing/get-contact.api.mdx +++ b/docs/docs/api/v2/ticketing/get-contact.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RV2+2IDXkm+RJaEooibGIGRPgSOXaOQDJvijiTGu+SGF8mCsP/emb1pZcmG4/Sh9YMskcOZM4dnZrgKdAqGO6nVRRQMgim4D1o5LlxwEERghZEpbeLWYDBQ2sFIXc2kZRPgzhtg+FWreMn4nMuYj2NcUeyLgbmEBXOaWYhBOCa8dToBQ9ZMe8POlQOTGmmBpTFXLTYs4zJvb/cSdOb0wAFP3luf8mnsoSV0ss8m2rBEU2CFX5MceWukENxIjdQlIChlGWeVNz3+RvEX0s2YmwGbyjkoJiM8gxk6PrXBYBiU1ja4PQgsCG+kW+L6KngMeSrDB6BftxnuptzwBBC7zfcV/kBupBKxj+DO8MVdxB1H15I4++7BLPGHFTNIeDBYBW6Z0oGx1jFwggCPPEljXHPGQ/aU9JsZIGpDTJYxGMZgFAOvwKHbiE2MTvLcjk3EEJ9bstTouYzAtILsoAb5GFa3EMqoQjgDjna7IFpnpJo2EQbJcu3iMNgCe4UYqn128RExcbxOJZEFVAjiUU5OJNgcbG2IelmSIniaxlLkF4pBDXz30kBU8dLIokouzFfekoflMViUj4DdSVQRWBnhWTCi0M3dms+Uu9nWideh6hy964mx6IbdzlEnPDnu8LB30oOQ8wkXYx5NTjjiJREasKlWFiw5POp06N9mFqWgPxZaJJhIPpk1WG5/s2S72gZXFA0eRCKwPThZRCqS3k5B+Tgv/SrZdUoftLd4v58MTIlpoLq+41GECdiXyZjikfcLvrSOm9DopdBU/+QknWkFd8onY7zvH0Lz7rDT6/U7R/3j4todotkJ43kX54/YHRz2EHZmrURwylFtXmEF3vBkbKdcWXLOhdC+YPz1znv9fg8OIQoPxWk3PBl3T8J+p38a9qPjU4BebzzpTlAATXUNg1Kim9SiRpx0cUOieC6jo9i7Zrrs9HTBJNdB0C6tbHu1lnRG1QRmXvU6b2IqNOdSO2i3sS+26tYsddtJ8QAOU2zPj7Zmx9fSkJ19uQiyRpP9StIr1NVotTVpuPIZqIHWxV/ZPC37zXgYhqEVXQ2PY40NE+YQk5ZtviYEspS3oRxQRt4mmgJTtoWPTuuw2+oHayavFXWviF1VmdJhtlcOu/2yzojrulbqxKsbwqVIC7sx1HBvk9qNza0G9d+fw7/iH7tQzujIC9qg0XwDMR4EwkK8V2TmFNaM7jNkxyfYqwqH7G/tmeAKweBJypfs0cUCxVP6kiYKN6eebVHA4V+UOsZMMNWixeWo62C3exXhdCWtZn5t5MJRXu3ifFict2uV7+chfhleepUzra1LuFq7NF61UlxTVBtj7xxmY+fT/bXFYrFopcWxPGQVv73Q5sGmXEC9FKZ+jF27rVGdudYoeM7yH9zmGmbXl3+O1P39/Ui9pkBL07ydFhAamv0EqJPdj8DVepT8D3T4hvdg0XYcPDqSgMwZyotzVbbKYVXkFs0HjfmPTW2GVJLFajXGa7k2cZbRcvEIpA4aSUuUYPud8NjCC+T+9LvvmVzy9rrruTrn1KUGQd6d59zIYkT9EOi9y3Iu7bPn4ld9XS2bMStcDTqzW7Quu/ubUfybD9IX6Hz6sF5zefATwJ8+Ql8E8PRNvAGhMDrDoZe6xt7WU5Cuvn4ffDq/QlvuSfTNeVwM3/IL3czOK20O6iI8fRKYnea/UQvDSf97bV7sPHugnvuVoEkwWfYPw3IkbA== +api: {"operationId":"getContact","description":":::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\nReturns a Contact object with the given id.\n","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"ContactData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}}}},"method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get contact","description":{"content":":::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\nReturns a Contact object with the given id.\n","type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-tag.api.mdx b/docs/docs/api/v2/ticketing/get-tag.api.mdx index 1993e04c78..5ca3d90b81 100644 --- a/docs/docs/api/v2/ticketing/get-tag.api.mdx +++ b/docs/docs/api/v2/ticketing/get-tag.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get tag" hide_title: true hide_table_of_contents: true -api: eJzVVm1v2zYQ/iuc9iUGIslNsyAzhmHdWhTB+qFInRWDbSRn6WyzkUiVpOwYhv/77kRJlu0k6Ms+bPkQ2+SRz3PPvfA2gS7QgJNaXaXBIJijG8I8OA1StImRBW/Q8mAwUNrhWA0X0ooZgisNCvqqVbYWsASZwTSjFSXeG1xKXAmnhcUMEyeS0jqdo2FroUsj3iiHpjDSoigyUJEY/aGVAzIt7eQkp8ucHjiE/DdbFjDPSowSnffETBuRawZW9DWvWEdjReTGaqyukUgpK0CQB0JPPzH2SrqFcAsUc7lEJWRK9uSdg7kNBqNgyJ+T08BiUhrp1rS2CR5CKGR4j/xrsqXdAgzkSJxtta/oB2kiVZKVKd4aWN2m4ICulazV5xLNmn7YZIE5BINN4NYFH5hqnSEwPD5AXmS05kyJ20OxPy6QGBtWsMYQhCEYg6R3dG0qZkbnlV8vTSqIn1uLwuilTNFEwfa0JfkQNuqHMm0YLhDI7jGK1hmp5l2GQb7eXfEiOCI7JA7Nvrh6TZyAwqgkqUCZQXyUkzOJtiLbGlKerDkToCgymVSBJFCDn0tpMG106XjROBdWK9/ih4UMLaVNgo870SCIGuFJMpQ7tzstC3CLI+svY9Q/++kymSYX4UX/rB+ev+xDeHl+iSHADJIppLNzIK6cgAZtoZVFyxee9fv8ceABzF/7HEyolEh0NumoG3+ybLc5JuYLhQ6SANQKnPQo3tnn6A9lco+OVsWr91fEsyvCyJ8n6k66rFaNbLZsRqW00HWzYVxWcBDEXJPxxqu75aCiWTYlV5qM4+1cYQdxTOUZtZ1B6tg1TOLl2VHr+lAbepadWv/ASnhnOxXfekwrfyLXcZuDjc1h9u3jEYwgK65eyDJNdYtLzFhaW60lCVpfDY1s3M0YmL31d/SjFxfRz8FOvRvFRZSKPc3FSd1re3XYqYPuQtc6zkHjnkpLqU7sXk+lvX1p9zaP6uS//wz8SH/iSjmj0zLhDX4ZPmJGB5G5sO6NmJWEraI9QeqUOZWOv1D8rUuRgCIydJL9ZXu6YkXJU98lTRruN18bMeDoL3adMHNy1VdcxboFm5w0gnNIoq5/MWnh2K/Ynw/9ebvL8l4F8cPoulSV0tq6HNTuSlOqqKA1xbUxLZ0jb+xy3ttZrFarqPDHKsgGP15pc28LSLBdCotySk0k1pSdVa4xeKXy72CrHBY31+/G6u7ubqy+pEBrU06umkInZ9+iE+54/tjsutr/IAe/chTx7cbhg+PQy0qZqig3dWsc+XHllN4W//RQE1uQdLyz2UwpDDcm22552c8e3DFTaVkGarMzyCw+I+h3jxtP+FC108empCVwVxoEVTdegpFM9CtJn1zXb01PPIXf9HG17mI2vGoptxOyrDv5NzP4N2egZ6Q8nOV2Op5+B/HDuedZAodj2B4Fb/SKHrjCdfaOphAOezsDvH0zJFsoOdG7b69/aOsvHJlHw9l9lD08/2cyj5r/wu2KXvVfW3O/8+SB9o1vkpkTZrv9B9TBlfs= +api: {"operationId":"getTag","description":":::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\nReturns a Tag object with the given id.\n","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TagData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}}}},"method":"get","path":"/tags/{tag_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get tag","description":{"content":":::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\nReturns a Tag object with the given id.\n","type":"text/plain"},"url":{"path":["tags",":tag_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"tag_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-team.api.mdx b/docs/docs/api/v2/ticketing/get-team.api.mdx index b1820828c1..297d9c3178 100644 --- a/docs/docs/api/v2/ticketing/get-team.api.mdx +++ b/docs/docs/api/v2/ticketing/get-team.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get team" hide_title: true hide_table_of_contents: true -api: eJzVVttuGzcQ/RV2+2IB3pXiuIa7KIqmTRAYzYPhyA0KSbCp3ZHEeJfc8CJZEPbfO8O9aHWxkTh9aPVgS+SQc+bMzBluAlWA5lYoeZUGcTAHOwSeB6dBCibRoqAdXI/jWCoLYzlcCMNmwK3TwPCrktma8SUXGZ9muCLZtYalgBWzihnIILEsccaqHDRZM+U0eyct6EILA6zIuIzY6A8lLUdTZyYnOV5mVWwRx2/GFXyeOYgSlffYTGmWK3Is8WvuYUdjieDGcixvAEFJw7hkFANT08/kfSXsgtkFsLlYgmQixRMYn+VzE8SjgExNMDkNDCROC7vGxU3wGPJChA9AvyYl7hZc8xwQtvH7En8gLUImmUvhTvPVXcotx3sF0fXFgV7jD5MsIOdBvAnsuqADU6Uy4OQfHnleZLhmtYNyn+9PC0DImkisfTD0wcgHsm/x2pTNtMp9YK91yhCfXbNCq6VIQUdBedqCfAybBIQibRAugKPdMYjGaiHnXYRBvt5e8So4ADtEDM0+u3qLmDhmUgpkAYsD8UgrZgKMB9saYqmsqRh4UWQi8blEpxq+OKEhbXjpRNEEF/qVl8RheAYGKyeB40E0Hljt4UkwVJt3WzILbhcH5l8HaXD202UyTS7Ci8HZIDx/PeDh5fklhJzPeDLl6eycI1iqQA2mUNKAoQvPBgP6txcConpbVWGC/YS0k02H3/5nQ4abQ2RVr+BBpAAFwYrKTRXuIX7pMt/vTaTbeK4zbqk3K4K34F5yB3Zyyq4wkHmlUMb3NbLRpXpUgZyU9DkNsEcXqlYyCocyEwd9Spjpb+q8lVQvoJdNNzudUSlZW5i438fOj1rdEapvRfIAFkH3l2cHwvixNmRvrq+CsiMjH4niisWOmLQ04MqfQBLRlndjs1/Yu/7QDUMrEgaeZQolAZaQUc6MX0sSMFWjeUAl3TZT5Jiire4YRK8uop9JA4X1hN9K6s+UDZtI6TA7qZW8V9cT6vO2JtrAqZpJsXEpVYnZUWzc26V2Z/OgBf/7Q+ZH/FBFapW6hDZo7nyCDA8CYSHeGzI9hS2jPYbsuBx7srqQ/a0cS3BUOcRnKV6yxytWWDz1XUKn4a6um4gcjv6i0NFnjqFWrexRt84mJw3hlJKoG1+/qJurX50Pq/NmW+U97+KH0Y2TnmllbM7l9krtZFTgmqTemDprMRqznPe2FqvVKiqqY95l47+/UvrBFDyBdiks3BTVqa+wOn2tkXPP8u/c+BpmtzcfxvL+/n4sv6ZBa1MqrhpCp2bfg2X2yPNms9XL/0ERfvNLp1IcC4+Wsi88Ob4vN7U+jvxAM2gbN5MNlWyB/NHeZjPFXNzqrCxpuXrbkGymwhAVqLYznhl4htTvfs48EYXX1GOvsCUnaYoDL8lLrkU1ab4J9MlNPWR67Cn/jZjLdddng6vhspygaa3nL4bwbz6ynuFy/7G4JfL0O4DvP6yeBbD/ztuBUBm9wTFX2M7ewSOH8t6+Bd6/G6Itd1Tr3Qlcjdv6C2XmaD67o7lyT38JzFHzX0i0cLb/2ppXO08eaCd9U81UMGX5D62Du8g= +api: {"operationId":"getTeam","description":":::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\nReturns an Team object with the given id.\n","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TeamData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}}}},"method":"get","path":"/teams/{team_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get team","description":{"content":":::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\nReturns an Team object with the given id.\n","type":"text/plain"},"url":{"path":["teams",":team_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"team_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-ticket.api.mdx b/docs/docs/api/v2/ticketing/get-ticket.api.mdx index 689769ff39..5023b59379 100644 --- a/docs/docs/api/v2/ticketing/get-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/get-ticket.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get ticket" hide_title: true hide_table_of_contents: true -api: eJzVV22P2zYM/iuq92E9oMqL7bxi2FtbtIcNW9FeV2x3h6ssyxettuRKctLgkP8+UrKT3Fva3fZhK4o2lijyIUU+pK4iXQvDnNTqOI/m0aVwJ5J/EC56EuXCciNr3IOd+XyutBNn6mQhLSkEc40RBH5qVa4JWzJZsqyEFUVeGbGUYkWcJlaUgjvCG+t0JQxKE90Y8lw5YWojrSB1yVSPnD7VyjEQbez54wqUOT13glXf26Zml2UjelxXR6TQhlQaDSv4WXngvTMF4M7UmXotAJSyhCkSvCA6+xPtr6RbELcQ5FIuhSIyhzPgoWOXNpqfRkHYRudPIit4Y6Rbw/JV9ImyWtIPAr/ON7BbM8MqAdCt31fwAaGRipdNLi4MW13kzDHQLDFkHxth1vBh+UJULJpfRW5d44FM61IwRCA+saouYc2ZRmxuxvzdQgBog4FsbRCwQdAG3IADtTkpjK68a4nJCeBza1IbvZS5ML1o82QL8hPtLoHKvEO4EAzk7oJonZHqch9hVK13KobRLbAngKHbJ8fPABOD21QSogAJAniUk4UU1oPdCkK6rDEhWF2Xkvv7BKNGfGykEXkXlz0vOueoX3mIH5aVwkL2cHG3E50F0lq4F4zzaXOxC2fN3OLWgS8DNYhHU57xMR0P4gFNkwGj03QqKGMF4xnLi5QBXMxBI2ytlRUWFcaDAf53wwmP61nIRA51BaFHqb0Y9/+0KHp1G1uoGDgIYQBqcDIYCi7f9kA1pa/7ztedR68gxaG8WZ53FevEZaAai4Fn1spLJYL6Vi0zhmHFSCcqezhgwwkbpcM4pfF0UtB0luZ0Nh4JmvBRliQDPmPjKQQMAmCAq7Q5rC0p2HRUjFM6mgwnNB2NY5olBacxn42TYjyGWxj7bGkElvidodhpiwdxTIcDOhyeDAZz//cPPG0dsOZn/Pr11fNfbuXloQNPmS8h4NH74/0dOXZflyWp2AdB7FpxUBJopGr4gsBBKcwjNMt1iYztL+lB91JkUz4aZWM65NmUplnK6azAz8ksTuNkOB7Ocn8vbfUETYc0AvV59vBJw7luQjYfqKXZtpbS+2splAa0nMPKxiOepKOM0fF0Aspmk5ROJ/CZ58lwNJjxZDxhqAyoFzBeBK8Oq5xghuaDlCaDPKZpkQiaiXRE48k0mWZ8liZpjCpDe3rIJYhtew0loHHdifyCfQYaZO6QDmM6mF3P3PayGlMePr9wrrbzft8tpMl9N7K6cCuIDfbvPnAKsks/6UtrG9H3bQRw6tByD2l+efzipXdmx66nUcvQXYmfI1BX7rgZDmzwDPTshW7nG6Q25Ol51A9Ctn+1ZfIN9hBhll2H9w5vvYJpoLedR6RuzwPS/jK+NTC9aQXJD6+Oo83eaPEGKTfQ3t6AsbvmWv4k8J63La+TudnsrtsDMwSkcFhgZalhTBBLUSKHW7/GubCh+XpAG9RWaDSM3gYdg95w3JtFuzC+Vdiz83acQtZAM4/bCe8oulZELeDOcbw+nORgKdfcXpvkYO96aK9t3mrL//3h8yv4Q46VMzpvPH3iPPpOlHBQIBaMexdMH8JtRI8IRKepoGSDQvI7kDkHUm8An0N/UR5UrCB5Wl1QXPT6rGd7aPD0N3QdbFbgamjtHvXW2PnjLuB4Jb19//oQC4d+9cN5Gs7bXZYfeROPTl83ykdaW1cxtVNpGtWrYU1hbWSNc+CNXV4e7SRWq1WvDse8yc5+f6XNB1szLrZLtG4ymFb6GrLT5xoa91H+EdscxuTt65/P1Pv378/UlxRoK+oZJ0DYy9kX8FZwdz58rnYT1P8gDR/wBgqs48QnhxkgfYBang88edqSqQXp+W7mBUZbQBxx/+oqgzt5a8rNBpfDuwfpM5cWAwLMW7DSigOh/cdPnXs88dx61wttyZCi5pGn5iUzMkyxfwv049dtLzoi99nvSF2t9212uHbR3JyDcMvsDwbxbz7BDkTz5lNyF8on/wD4zWfXQQA3X4HXIAShH6Dh1W5v79bzB29+Oxm8eH4CsqzBjN/vxaHxtj/wZu680f0mHczjvwjmTvFvkL6gy3+7FQ879x7Y9vwunzFhNpu/AOTaDr4= +api: {"operationId":"getTicket","description":":::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\nReturns an Ticket object with the given id.\n","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TicketData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}}}},"method":"get","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get ticket","description":{"content":":::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\nReturns an Ticket object with the given id.\n","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/get-user.api.mdx b/docs/docs/api/v2/ticketing/get-user.api.mdx index 67fee400bd..6274aa82a6 100644 --- a/docs/docs/api/v2/ticketing/get-user.api.mdx +++ b/docs/docs/api/v2/ticketing/get-user.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: eJzVVt9zGjcQ/lfU64uZ4QBj6mCm02napKmnfcg4djMd8GBxt4DiO0mRdGCG4X/vru4nYHvipC/xAwZppf322293tQ2UBsOdUPIyDkbBAtyNBRO0gxhsZISmHVwfjUZSOZjI66WwbA7cZQYYflUy2TC+4iLhswRXJHtvYCVgzZxiFhKIHIsy61QKhqyZygx7Kx0YbYQFphMuO2z8u5KOo2lmb09SvMypkQOe/mozzRdJBp1IpS02V4alihxL/Jp62J2JRHATOZFXgKCkZZxRCEzNPpHztXBL5pbAFmIFkokYD2B4ji9sMBoHZGqD23ZgIcqMcBtc3AYPIdcivAf6dbvDXc0NT8GRLe1L/IGsCBklWQxTw9fTmDuO9wpi63MGZoM/bLSElAejbeA2mg7MlEqAk3944KlOcM2ZDHaHdH9cAkI2xGHhg6EPRj6QfIfXxmxuVOoDOzMxQ3xuw7RRKxGD6QS7dgXyISz5D0VcIlwCj32ajyBaZ4RcNBEG6aa+4jQ4AnuNGMp9dvkGMXFMpBTIAmoD8Ugn5gKsB1sZolI2pAWudSIin0p0auBzJgzEJS+NKMrgQr/yNXFYnoBF4UTweBClB1Z4eBJMhqKZ1mRq7pZH5l8Gqdf/aRjNovPwvNfvhYOzHg+HgyGEnM95NOPxfMARLCnQgNVKWrB0Yb/Xo3/7IZCU3+QqjLCckHayafDb/WTJcHuMLK8VPIgUYD9wIneTh3uMX2aJL/cy0jqeP0XC/gCxIIKBCnnK4xih2+dpWEKi92qdzgs7xZaAVft8Ac15YqmCqF803XBjOBWhcJA+6r6Owl/RxHM+PJ315vGrcNCD83AwuzgNh9A/C/vD08HwVb930ZtRWtoBdj7Hzcs4Wjqn7ajbreIVqusVheTPRQJTLaKOxkvIQS2qcVDIcp/XJk8oEydcUkoUL9jRHdi4lqro7pRjkuso8D5td1uIeUdFBGZVtrjMJA2s2A47TbxORPfgMNLuqn80LD4Uhuz1+8tg1+itH0h3ubQaHbbOmBZ/AaWsqvnS5rDa9/2hG4ZW1C15kijsk7CChIRs/VoUIVG++3hAJC2cH+SYos3v6HVOzzsXQU3gjaSmFbPrMlI6zE6K6dYqigyJrwulCrxMEi7FKrL7ym4fUHso++9t8P6If+xSOqPiLKINmsUfIcGDQFiI95JMT2HFaIshO1mKjSq/kP2rMhZxiWDwJMVL9njFGsVT3CVMHO4PO9shh+N/KHT0mWKoeX/zqCtntycl4ZSSTjO+LnLhKK5ufj7Mz9ta5S3v4ofxVSY908q6lMv6SpPJjsY1SbUxy5zDaOxq0aot1ut1R+fHvMvSf3etzL3VPIJqKdTZDFt2V6E6vdbIuWf5N269htnN1d8TeXd3N5FfUqCFKYmrgNDQ7Dug5B9X1bYeIt+BCF/6+ssbjoMHR8kXnhtfltuiPY59B6X2OiqnPTayJdJHe9vtDFNxY5Ldjpbz9x51zVhYYiKuZsqTnH7zE++JKHxLfexluuLUmUaB78grbkQ+nV4E+uSqGEct9pT/spfLTdNniavkcneLpkU7/2oI/+fD8xkuDx/QNZHtbwB++Nh8FsDh23cPQm70Gqecdo29o4cf5b16Crx7e422PCOtNwdwPm2LL5SZR/PZnMy5e/okMI+a/0w9C0f7L5V5vvPkgWrQl2omwex2/wHrmReN +api: {"operationId":"getUser","description":":::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\nReturns a User object with the given id.\n","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"UserData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get user","description":{"content":":::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\nReturns a User object with the given id.\n","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-accounts.api.mdx b/docs/docs/api/v2/ticketing/list-accounts.api.mdx index 250571242b..2ecb239220 100644 --- a/docs/docs/api/v2/ticketing/list-accounts.api.mdx +++ b/docs/docs/api/v2/ticketing/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: eJzVV21zGjcQ/ivq9Ys9Y17dZCZM06ljPCmOobED9oBhEvlOgPCddJF0wJnhv3dXAu4Mjos9+dB6bMxJK+2zz77ewpMxU9RwKRqBV/NCrs2J78tEGO0deQHTvuIxbsNmrVYT0rC+aI+5JkNGTaIYga9ShCmhU8pDehfCiiCfFZtyNiNGEs1C5hviJ9rIiCmUJjJR5EwYpmLFNSNxSEWR3J5KYSiIJnpwEMFlRtYMo9GfOonpKExY0ZfRIRlKRSKJigV8jSz2Yl8AuL7oiysGoIQmlKApRA7Jyhwi7yaAQ4MoGGboSHu1W29j6+DI08xPFDcprC+8eYHGvHDP8GmwhN2YKhoxgKztvoAHoCSSAR9yFnylQ9iCizkS9T1hKoUH7Y9ZRL3awjNpjOLaKC5GsOOQw0pADSsYDpcdeWxOozhEuWq5elwoVwvV43a5XLO/xXK53POW2z5pDEms5JQHLDgiMx6GzhnK0rC2maxhEguTGPQfaraKl0cbc4Bn9lXzB7a/JRnoSvV4F18rie5AI/hBMZ2EgAVCYoUOIo+gxiI5aNJ5jVTAxMM8HPCHli9gNcPi18tps96YX7RP8K/66eHk4bzd+tCcXIbN8lmlmf5Wbj5cPjQn3bB535g1TzsPl+2T2a4B7TFDkFzYQCMOEplSiMc81HlhHeAFHqwRjxkNbFTsAzlKsysqT+NY75NGHXxIIVMEB1bA3+B/YdDFwG9eEFIxxWSjcRxy35oAShX7nnDFIOGNStgjK1bBpAp25TV2aBoyDfHtsx+QudJAVhq2wAxwRcdSaKZRUbVcxn+P71mnbZ0aClf4UDjAfpTLGVqaaBRe7KJ2aQEHAQsEoeFOVebmf5cVbG6e4kEkoS2Czpo8Lyw9j3unjbeNyWXaavtvehP/4aI9qkBImla9c9w8Lb/pTrrHFzfXk250edysn09aUWPeOm3ohjgPg+g69asd/nfUG9/91QqHl+/fI8MxllqZ6Nei+TDp1cdRN+rdX9x03rQiRHM26wGa3uRyfnEDyTHpVLqTIGp9bPzWSrfQiKs0uLl+h0iMNDT8aj2TAyNsBciHCOT5cpl3/K2jM2fLwO77UgV5u6hSFCsANyzSe/jIBvVLWLmhqTZUkSuZ+tKGr4RGJPbB8EQmzNxtBYW3YfPyljt2uxxYq4HgN9zYw9SF+O6RXJRmHA2WSysIHWossZGPmOWDmjE8lGjW0jVT03UTS1SI2W1MrGulEjS84qbVclky3L+HDiFGpWl1Zxb4shIkJ58b3jLXPb9gsjn+cz00oy/mnxjyt6k4a5ntWrOV8Z8bBKSwe9AwlDMSsCkL0du2o4CBTLvaZwEt8bahRMVorbujXKy8Lb7zMo47wnXF9tpSPEwOVsPL4aqywEiSRdPGcPQ0DinYw6WvHw0psPeY2kebO1Xxvz9X/Qo/pCGMkkHi4waOWjcshIMMsSDvazIthRtGDwmwk0RQnd2FpCsT4lMBYJibQ1AerphB8Kzu4ioowLhl0k2vwKmtL26v0XTQGYGprqhb1Btlg4M14eiSYt6+EnBh0K6SO19w53UW5YdWxS+3V4mwTEttIiqyK1UiijGsCcyNu8QYsEZPR4eZxGw2K8bumFW51l+aSXWvY+qzzVIhTu6gT5UkRKeNNVRuWf5AtY1h0rm66Itv3771xT4JuhK1DcFByMXsBY7C9Adj/SJrn/+DSNx/wnf1xkBjQd9zS43NysWqLN56NDf9j4E1XFss7sADHRUul7jshk4slgHXaDsU1yENNXuGxZ8wk/8Av62luy8dbhqteXYg3R/ny2fzZ2HlXx5eiei5YftZ3Zs3hUzxAB8Ud43+FgeKVWt5mTMPrla995D8zBH8GVu2XyVeyeUW8O2x+1kA228BjyA4IUg6Fpvc3s7kjR7YzCMfz9ogSxNMvPww4Dr/6gt6Zr0l0tzd+SnBqcdPBPOk+O9YP2HM+GMjnr2vPXlgM3Q4aSQDJ6p/AKZy7w8= +api: {"operationId":"listAccounts","description":":::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\nReturns a list of Account objects.\n","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AccountsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":":::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\nReturns a list of Account objects.\n","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-attachments.api.mdx b/docs/docs/api/v2/ticketing/list-attachments.api.mdx index a9191367ac..d8f4291394 100644 --- a/docs/docs/api/v2/ticketing/list-attachments.api.mdx +++ b/docs/docs/api/v2/ticketing/list-attachments.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List attachments" hide_title: true hide_table_of_contents: true -api: eJzVV21T2zgQ/is63xeYwYnzRiFzvTkKnV4oyRWawPCSoYqtEAVbciU5iWHy329XzosTaApMP9wxEGJrtfvss6vd1aMjY6ao4VI0AqfuhFybA2OoP4iYMNrZcQKmfcVjlID1er0upGE3oj3gmvQZNYliBL5KEaaEjigPaS+EN4J8UWzE2ZgYSTQLmW+In2gjI6ZQmshEkY/CMBUrrhmJQyoK5PpQCjBuSKK7WxEoM7JuGI3+0klM78KEFXwZbZO+VCSSaFjA18jCL9wIAHcjbsQZA1BCE0rQGyL7ZOkRkb0hQNEgDb4Zeqed+rWT97i742jmJ4qbFJYenYlLY+7eM3zqTmE1popGDIBruy7gAYiJZMD7nAW3tA9LoJsjXd8TplJ40P6ARdSpPzomjVFcG8XFHaxk+OFNQA1zDQdlOw6b0CgOUa7slSuuV3bLlbbn1e1vwfO8K2e6HplGn8RKjnjAgh0y5mGYhURZMuZukzlMYmESg1FEy9bwdGfhDrDNbjV/YC/3ZAm6VK48xddKoh5YhGgoppMQsEBizNBBChK0WCBbTTqpkxK4uJ2HA/HQ8hWsLrH4R17aPGpMTtoH+Ff+/HDwcNxufWgOT8Om97HUTKte8+H0oTm8DJv3jXHzsPNw2j4YP3WgPWAIkgubbiSDREYUsjIPdeLO09zlwRzxgNHAZsVLIEfpUkXpeRzzddI4ghhSOC+CAysQb4i/MBhi4DcvCAcyxSNH4zjkvnUBjCr2PeGKwck3KmErXsySSbn2zVv80DRkGvLbZz8gc2aBzCysgeniGx1LoZlGQ2XPw3+renIn94gaClp8qCDwiKI5X4tDjfKPT4FnJwM2AhzIQ8Mza8tI/1xWsIl5jgqRhLYaZg7lqWHpcXx12NhtDE/TVtuvXQ39h5P2XQmy0rSOOpXmoVe7HF5WTi7Oh5fRaaV5dDxsRY1J67ChG+I4DKLz1C93+D/R1aD3dyvsn75/jyTHWHNlot+K5sPw6mgQXUZX9ycXnVorQjQfx1eA5mp4Ojm5gPMx7JQuh0HU+tSottI1NOIsDS7O9xGJkYaGt75MRJ4aYYtAPkvgqE+n+dhfZ3TmfOnadV+qIO8XVYpiEeCGRfrnMerzkN1myb0pZ7/6ijGhB9IUYlhCR7h/z54N73KXt1/b83v+rrvrVT23WvGou1fdYy6lfer3aNCvUnsGLIhEhZu1DYyJ68UiDaE2htjwivG76n4PFcyS+zbbvEnJMGYWfhKHEs5scNtLN28o7/Vq1VK55pb33vXd6n41cPd3a8yt+LVepeL5+3R3z1kP1ZLVBVE5L9fwroLpTteV5Y7cMuAohoLQcQcSJ5Q7ayOmZgAPRboyq2imRvO+bGm2XGokM+aFxQzBZTEDCxwUR+UnQ87XmSA5+NJwprmB4CsWjyyfcmPBMiVj/plhTi6K6FxmvXyuFbEvDQJS2BBpGMoxCdiIhZi9tklS32c6K+cW0BS19SUaRm8zHV6htFvYt2EwNp4dkTX69txT3Ey2ZlPZ9iw4MGvZCpYBnjuOiYHTF44l0tcr0xeGcYXalcUnhf6/PzD+Dj+kIYySQeLjAs6QFyyEjQyxIO9zMi2FC0a3CbCTYPJlCsmlTIhPBYBh2WiF8qBiDMkz08VV4MIEadJF+8NZ9EZcn6PrYDMCV7MmZVEvjHW35oRjSAp5/4rAhUG/itl+N9uvl1m+bU38dn2WCMu01CaiYqlSJaIQwzuBZ6OXGAPe6NHd9lJiPB4X4mybNTm3XxxLda9j6rPFKzdOetB3ixKy0+YaGrcsf6Da5jDpnJ3ciG/fvt2IlxzQmahtcBmEXM6e4IxPf3xleVxOBP+DZHzV7SWrOgbaJWYAtwTNuktWH68dunqzGQB9+PrxsQeh6KhwOsXX2UCNVTPgGhmAQtunoWYbuPwF940fuGCL6tMLVTZp1x07bL8c5+vvHRth5S9Gb0S06SKx0fbiFrQ03MUHxbO57honpVmPeV0wt85mfXib/MrrxQZf1q9Jb+RyDfj6lWIjgPUbzgqETOgAWm9scmtPrhQYgcVs8uljG2RpgmcvPxVkI8DsC0ZmviTSnO78uJCZx08E86z4H1hIYd74cyG+vIs+u2ExfWTSSAZOV/8CTUk5SQ== +api: {"operationId":"listAttachments","description":":::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\nReturns a list of Attachment objects.\n","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AttachmentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List attachments","description":{"content":":::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\nReturns a list of Attachment objects.\n","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-collection-users.api.mdx b/docs/docs/api/v2/ticketing/list-collection-users.api.mdx index 927ea783bc..e7316c49d3 100644 --- a/docs/docs/api/v2/ticketing/list-collection-users.api.mdx +++ b/docs/docs/api/v2/ticketing/list-collection-users.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List collection users" hide_title: true hide_table_of_contents: true -api: eJzVV21T4kgQ/itzuS9SZSAgukrdXp2r3i6ucKsLWqIWOyQDDCYz2cyEFyn++3VPgERAD639cta6QtIz/fTT71NLhiyimktR9ayK5XOlT6TvMxcfNRWLlLVreUy5EQ/xEchUKhUhNbsXjT5XpMuojiNG4KMU/oTQIeU+7fjwRJBvERtyNiJaEsXwUuLGSssArgVpIuOInAnNojDiipHQpyJP7k6k0BREY/WwE8BlWlY0o8FfKg5pz49Z3pVBjnRlRAKJigV8DIwJ+XsB4O7FvbhiAEooQglaRGSXoC1EdgYAQoEcWKVpT1mVOyu1V1kPu5ZibhxxPYFXU2ts05Dbjwy/PczgbUgjGjCNvOB7AV+AkkB6vMuZ16ZdeAV3cyTqZ8yiCXxRbp8F1KpMLT0JUVzpiIsevEmQwxOPamZrDpftWmxMg9BHuZJT2rOdkl3aazhOxfzLO47TsmarPql2SRjJIfeYt0tG3PcTZ0SGhoXZZAGTGJhEo/9Qs1E8212aAzyztuJPbHtLUtDF0t46vnocdJD/LkBSsQ9YICTm6CAACWrMk50aHVdIEUzMZeGAP5R8A6spFvfUmdROq+OLxjH+lr4+HT+dN+qfaoNLv+acFWuTslN7unyqDW792mN1VDtpPl02jkfrBjT6DEFyYQKNJJDIkEI8ZqGO7UWA29xbIO4z6pmo2AZyMEmvKG7GsXhPqqfgQwqZIjiwAv4G/wuNLgZ+s4KQihNMNhqGPneNCaA0Yj9jHjHIex3F7JkV82CKbPPkPXYo6jMF8e2yF8icayBzDS+CgYwDo9opnSHV/bUD24FySvuHbsc9sA+ckmOX9xxqH5YPmU1pl7od6nXLFOBinkOYhlAQmMILS46Df54bsVImT6mmoMuF4gVwUTxDdmGg8Mx0HWSSmnAQ+IBE0DzRmIbaf8sKNtabzBaxbwrxgqCUBjY5D1sn1YPq4HJSb7j7rYH7dNHoFSEtdP20uVc7cfZvB7d7FzfXg9vgcq92ej6oB9Vx/aSqquLc94LriVtq8n+CVr/zpe53Lz9+RC+HWO5lrN6L5tOgddoPboPW48VNc78eIJqzUQvQtAaX44sbSNBBs3g78IL652q5PllBI64m3s31ESLRUlO/7cpYZKkRpgplIwJqzWyWjaW7hM6MLQ/mvSsjL2sXjSKKVYhrFqgtfGRi+S2sfOE++ZvxHlrDsA22qedBVG4kNz3WZ374rFPiea7a0FD5MAuhI6XPqMge7lJfMSQPuu02tm6wwlyRxXNwWOw4Xe+DXXbYgV3uHBXtQwZdrXRYLB9+KDlHTgczbteCuUHT6G0c9bUOVaVQWNrLZSGGZGwD+V3us3bI3XwIl6z5OKk5z3nN8gQVQHNtlOCFcMHKDZkETcPjYTYzgjAg9CWOUz1mQgELVsUquOmgUZguy9rMQEb18Ge4GCziyM8YCENIPmuk5u4jdG3RKwxLa/PZ97kgOf5WtWaZieY7Fp8kHjNzTermkH9l6OdlF1jIrNb/5/pADQEp7OjU9+WIeGzIfIx+0+Wp6wK7ph8ZQBiPMLKhYrQ2ucPJFw/yR1bKelMkk0pjYSkeJjvzgTI3r7TgrTS7loYvPItzlXTV83TYXaF2NVf+b7Pu7/BDqkJH0otNbOH4e8N8OMgQC/K+INNQuGQ0R4CdOIAoTC4ktzImLhUAhiWzIcrDFSMInvldPPJsiFw9WfZvHKbvxd01mg46AzA1aXIG9VLZw86CcHRJPmtfAbjQaFchOW8n51Ua5Tmj4re7q1gYpqXSARXplVEs8iE8E5gbnVhrsEYNe7lUYjQa5cPkmFG50F8YyehRhdRly0d2GHegbxckRKeJNVRuWP5ElYlh0ry6uBc/fvy4F9sk6FzUNMgEQiZmL3A9SQsDiTetXNN0rPgfROSW21dSdDR0WwwAbvgxqTmdF8w7K1Mw4UQlOwkmPEFx6wOlKDuddsA9zcifzfBxsiVgJfW4QkK8ZXN6kdpfsES9YJcptOtbYrI+VCyzQWyP8+3L1KuwstveOxG9th29qnu52qWKH/BLxJOO/yb/7VzNG3SOvKR10erEJKszZWIRYDOc+ub97t0gfuWu9gqHqzvnO324Anx1P3sVwOq6+AxCInQMY0CoM+/W1iP0/HJy+nzWAFkaYyHITijJODL/gJ7Z6NHs6JKox/8RzEbxP7Cow+zz51I8Xew3HlhOQok0koGz379vIqqz +api: {"operationId":"listCollectionUsers","description":":::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\nReturns a list of User objects.\n","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionUsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections/{parent_id}/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collection users","description":{"content":":::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\nReturns a list of User objects.\n","type":"text/plain"},"url":{"path":["collections",":parent_id","users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"parent_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-collections.api.mdx b/docs/docs/api/v2/ticketing/list-collections.api.mdx index e2c0a18319..dd56fe1223 100644 --- a/docs/docs/api/v2/ticketing/list-collections.api.mdx +++ b/docs/docs/api/v2/ticketing/list-collections.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List collections" hide_title: true hide_table_of_contents: true -api: eJzVV21T4kgQ/itzuS9aJRDQdZW6vTrfbg8XOHFBS9Ryh2SQwWQmOzPhRYr/ft0TIAFcT6z9cGetbjLT6X76vXviyIgpargUFd8pOwHX5kQGAfPwSDs7js+0p3iEr3BfLpeFNOxONHtcky6jJlaMwKMUwZjQAeUB7QRwIsiFYgPOhsRIohkyJF6sjQyZQmoiY0XOhGEqUlwzEgVU5MntiRSGAmms77dCYGZk2TAa/qHjiD4GMct7MtwmXalIKFGwgMfQws/fCQB3J+7EJQNQQhNKUBsiuyTViMhOH540UINuhj5qp3zrZDW+33E082LFzRiuJs4oRyOee2L4dj+F24gqGjIAru29gBcwTCh93uXMf6BduALeHM31PWZqDC/a67GQOuWJY8YRkmujuHiEmwQ/nPjUsJzhwGzHYSMaRgHSldzSbs4t5Uq7Tdct239513XbznTVM5UuiZQccJ/5O2TIgyBxibLGmKtN5jCJhUkMehElW8HTnYU6YG32oPkze7smKehiaXcdXz0OOyARvKGYjgPAAoExQwchSFBinmzV6KhMiqDidhYO+EPLDayaYvFO3XHttDKqNo/wt/Tl+ej5vFk/rvUbQc09K9bGe27tufFc698EtafKsHbSem40j4brCjR7DEFyYcONJJDIgEJUZqGOcvMwz3F/jrjHqG+j4i2Qw3HKovgyjvk9qZyCDynki+BgFfA3+F8YdDHYN0sICTnGlKNRFHDPqgBCFfsec8Ug842K2ZIWs2BSOXvyHj00DZiG+PbYD4w5k0BmElbA3OOJjiAnmUZBJdfF/5b5ZDL3lBoKXDyoIGACJM3oWuhrpJ+sA08yAz4EOBCHhifSUk//O61gI/OSKUQc2GqYKJQ1DRufR+2Tyn6l3xjXm96Hdt97rjYfixCVpn7a2q2duB9u+je71eur/k3Y2K2dnvfrYWVUP6noijgP/PBq7JVa/O+w3ev8VQ+6jU+f0MgR1lwZ6/eiOe63T3vhTdh+ql63PtRDRHM2bAOadr8xql5DfvRbxZu+H9Y/V/bq4xU04nLsX18dIhIjDQ0ePBmLrGmELQLZKIFUn06zvr9NzJnR5d7ee1L5Wb2oUhSLADcs1G/wkY3rTazSKJKLgBos0GvxuwmfP6FKGEW9JyAkFOqyofpJQ+kD5lCIoQrOxdi+1rAp7y3i+iGRtInEauVr00YDVZAJDymvzdjsHxQ7btf/mNtz2X5ur3NYzB0waEelg+LewceSe+h2bGZTz2NaPwRswILNJFy0jquVE2ctANBXkP6Gm6SGpwpMV2kzeZpGyf10agmhTfckjjWPzEYENT14KXhLA45majBv5rEKsMoZE+lyoQCNP78YPLgsGO49QacUj4VBaW0y+jojJEcXFWeamSK+YsVJgjAzS6RxHPEvDAN5UXnnNKs1d1keiCFAhfEDQSWHxEf7Y8jbzpo4xfYAC2iK3LoSBaO2CQ83X9zPHzqppVsimQ6ac03xY7I1G+W2Z+UVBrQ0pRaKY1bjyIazjPT00sgGd8umXbpc6w7//SnzV/ghFWGU9GMbSTh4XrMAPmSIBe0+N6Y14cKi2wSsE4eQmAlDciNj4lEBYFgyjyE9sBhC8Mx4ceXnIJnNeNEzcYC9E7dXqDrIDEHVpLNZ1Ath91tzg6NL8ln9CtGs6hSS73PJ9zqN8m0r4pfby1hYS0ttQipSlioW+QjOBOZGJzYGtNGDx+2UYjgc5qPkMytyLr8wlOpJR9Rji6NcFHegWRckRKeNNRRurXxMtY1h0rqs3olv377dibck6IzU1sEEQiZmq7gYeD/ecybpGPE/CMaNVp6k6hjosRgB3BrI5uZkVh9vHW95HeqB+fB4MumAK1oqmE7xOJnCsWr6XKMFoNB2aaDZK7b8CUvKD1SwRXV9C0vG87JjJ/S349x8WXkVVnabeiei17aPV2UvVqdU8D2+KJ705Fscr2Y9ZjNnbl3O+vA2+Zk7ySu6rO5W77TlCvDVPeRVAKtr0RKEhOgIWm9kMndrewh6YDGbfD5rAi2NMfeyU0EyAswe0DPzKzHO8M6OC4l4/ItgXiT/DQspzBu/L8jTBfbFDxbTR0KNxsDp6h9A0E6c +api: {"operationId":"listCollections","description":":::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\nReturns a list of Collection objects.\n","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CollectionsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collections","description":{"content":":::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\nReturns a list of Collection objects.\n","type":"text/plain"},"url":{"path":["collections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-comments.api.mdx b/docs/docs/api/v2/ticketing/list-comments.api.mdx index c2d6a06903..4db90a51fd 100644 --- a/docs/docs/api/v2/ticketing/list-comments.api.mdx +++ b/docs/docs/api/v2/ticketing/list-comments.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List comments" hide_title: true hide_table_of_contents: true -api: eJzVV3tT2zgQ/yo63z8wg/MOhEzbOwpML5TkCg0wPDJUlhWiYEuuJScEJt/9duU4cQKlwHRu7phCbWm9+9v37oOjIh5TI5Rs+U7TCYQ2uyoMuTTa2XB8rlksIryGy2azKZXhV7I7EJr0OTVJzAk8KhlMCB1REVAvgBNJvsR8JPiYGEU0DzgzhCXaqJDHSE1UEpN9aXgcxUJzEgVUFsjlrpKGAmmie2shMDOqaTgN/9RJRG+ChBeYCtdJX8UkVChYwmNosReuJIC7klfymAMoqQklqApRfTJThyhvCDg0kIJiht5op3npzHXtbTiasyQWZgLnD86dSyPh3nJ8603hNqIxDTlA1vZewguYJFS+6AvuX9M+XAFjgYb6nvB4Ai+aDXhIneaDYyYRkmsTC3kDNylyOPGp4a4RwGzD4Xc0jAKkq5QqVbdUcSvVbqnUtP8KpVLpwpmu+qTVJ1GsRsLn/gYZiyBInRFbM2Q6kwwmsTCJQf+hZCt4ujFXB+zMr7W45y/XZAG6XKk+xtdJQg8kgh9irpMAsEBIzNBB5BGUWCBrbXrXJGVQcT0PB/yh1SususDC9kqT9l7r7rC7g7+Vz/c79wfdzsf28Chol/bL7Umt1L4/um8Pz4P2bWvc3j25P+rujB8r0B1wBCmkDTSSQiIjCvGYh3rnZgHuCj9DPODUt1HxEsjhZMGi/DSO7J609sCHFDJFCrAK+Bv8Lw26GOybJ4RUnGCy0SgKBLMqgNCYf09EzCHhTZzwJS1mwRS79uQtemgacA3xzfgPjDmTQGYSVsD08ERHSmquUVClVML/lvlkabtHDQUWDAoHvCJdTtHiUCPxw2PUaVrAh4AFgtCIVNTCzT+nlfzOPGUHmQS2CKba5O3CJwfRxW5rszU8mnS6rH4xZPeH3ZsyhKTp7J1U27ul+vnwvHp4djo8D4+q7b2DYSds3XV2W7olDwI/PJ2wyon4O7wYeH91gv7R+/do4QhLrUr0W9F8HF7sDcLz8OL28Oyk3gkRzf74AtBcDI/uDs8gOYYn5fOhH3Y+tWqdyQoaeTzxz063EYlRhgbXTCUybxppK0A+RCDPp9O84y9Tc+Z06dl7pmI/rxeNY4oVQBge6p/7KNEg9/mStUXrtXKl5lYaW323tl3z3e3NOnerrO5VqyW2TTcbqBlLO9PzzHyfV/teedP1Gtxza42q7zbKrOZ6Ww3QuFHe7JfryMxT/uR1zjobcJkWd0hujZ3P8Ju0a2viceIryf8g5yohFGj0QCWBD12Uk69Z50S5AxMG1/+i8Hfeh0w+PFoIRrBb/sq86XsNVq97m26ZeQ235tWYu93H163tSq1SLW+Wt33kLfQ1TBMj6Go5/p5SAacy7ydbZVbCz0bKzDNzlEsse3hs0t6SFh9nusolVz8W0dubTi0hzA4DhSPWjWUdUTOAlyJbDFuAYZSNF0kcYN01JtLNYhFGkcJ8CBKqmAIEwxVHlUdTWmZzsvOl5Uxzc81XLINpZuSmm0VyReIzR/XnvSCjWe0Cy/JADAEq7OsQAGpMfD7iAeah7fWUMa7TrmQBoadgcEPBqG3Ko1Qobxa2nYWNT2Q6r3QzTfFjsjYbK9edpZScAc4UR2fj+IgpqZheGh/hbtm0S5eP+tV/f+L9HX5IS5pY+QnDCxyCz3gAH3LEgnbPjGlNOLfoOmQuSzD4UoY2hRmVNnfthIj0wGIMwTPjJWLfhUHYTOZdHOfpK3l5iqpjLIOqabu1qOfCemuZwdElhbx+RbCFQb2K6fdu+r1eRPm6FfHb5XEiraWVNiGVC5ZxIgsRnEnMDS8xBrTRo5v1BcV4PC5E6WdWZCa/OFbxrY4o4/MjN0o8mCCKCqLTxhoKt1b+SLWNYXJyfHglv337diVfkqAzUtuqUwi5mD3EJYX9YOF6WAw2/4NIfPnuldYbAy0ffS+saWxWPszK4qXDcnvZAKyGZw8PHnjgJA6mUzxO1wEslr7QqDsU1z4NNH/Gir9gW/oBfltLH6+D6Z7QdOyq8HKcr9+anoWVX+veiOi5NehZ2fMdbiG4hy+xSNv9JY56s9byOmeuHc967zr5lcvRM7qsLnlvtOUK8NWF6FkAq/vZEoSUaAc6bmRyd492IvTAfB75tN8FWppg4uWHgbTzzx7QM9mVnOR456eEVDz+RTBPkr/D+gljxoc5+WKTfvKD+dCRUqMxcKL6ByMJcuw= +api: {"operationId":"listComments","description":":::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\nReturns a list of Comment objects.\n","tags":["Comments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CommentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"],"title":"comment"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List comments","description":{"content":":::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\nReturns a list of Comment objects.\n","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-contacts.api.mdx b/docs/docs/api/v2/ticketing/list-contacts.api.mdx index f9d2532a53..2769a15091 100644 --- a/docs/docs/api/v2/ticketing/list-contacts.api.mdx +++ b/docs/docs/api/v2/ticketing/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: eJzVV/9TGjkU/1dye7/ojMCC1QpzvalVp4cVrlrQEWVs2A0Q3E22SRZYHf73ey+7wALWU6c/3HVa6yYveZ/3eV/z6MiIKWq4FHXfqTkB1+ZICkM9o50dx2faUzzCbdis1WpCGnYrWkOuSZ9REytG4FcpgoTQMeUB7QWwIshXxcacTYiRRLOAeYZ4sTYyZAqliYwVORGGqUhxzUgUUFEkN5liEuvuVgiXGVkzjIYfdRzRQRCzoifDbdKXioQSFQv4NbTYi7cCwN2KW3HBAJTQhBI0hcg+md8qeyPAoUEUDDN0oJ3ajbOwtbvjaObFipsE1h+daYFGvHDP8Ks7g92IKhoygKztvoAPoCSUPu9z5t/RPmzBxRyJ+hEzlcCH9oYspE7t0TFJhOLaKC4GsJMihxWfGlYwHC7bcdiUhlGAchW3sltwK4XKbst1a/Zv0XXdjjNb90m9TyIlx9xn/g6Z8CBInaEsDXObyRwmsTCJQf+hZqt4trMwB3hmd5o/sJdbsgRdruxu4mvGYQ80gh8U03EAWCAkMnQQeQQ1FslWg05rpAwmbufhgD+0fAWrSyzesZs0juvTs9Yh/qt8eTh8OG01PzVG50HDPSk3kndu4+H8oTG6Dhr39UnjqP1w3jqcbBrQGjIEyYUNNJJCImMK8ZiHOi3MA7zA/TniIaO+jYqXQA6T5RXlp3HM90n9GHxIIVMEB1bA3+B/YdDFwG9eEFIxwWSjURRwz5oAShX7EXPFIOGNitmKFVkwqYJdeYsdmgZMQ3x77CdkZhpIpmENTBdXdCSFZhoVVVwX/1u9Z562x9RQuMKDT7Af5XKGlkYahR83UadpAQcBCwSh4amqpZv/XVawqXmKBxEHtgim1uR5Yclp1Dmq79dH50mz5e11Rt7DWWtQhpA0zeP2buPI3bseXe+eXV2OrsPz3cbx6agZ1qfNo7qui9PADy8Tr9Lmf4edYe+vZtA///ABGY6w1MpYvxXNp1HneBheh537s6v2XjNENCeTDqDpjM6nZ1eQHKN2+Xrkh83P9XfNZA2NuEj8q8sqIjHS0ODOk7HIUyNsBciHCOT5bJZ3/E1KZ86Wrt33pPLzdlGlKFYAblioX+AjG9SvYeUIdEPKfFZsgAYx7EJ31PchIp/kd3lyAEc+TmiiDVUFJRNPYrey/hlKwe4yFl6FZq/sHhxU3Uo1q6sG0LzSzSdTaGqGjxk51BoaIhUGC3BLhuSKhj09oELj5dRbd9sLLj+oVg9YmfmFsvd+v/Cut/+uUHWr7wtVf/c9YwcHvf5+39nwdJr1q9RC0htu0sqdpjacWzuYy85lbHRnMysInXkocYAZMBsH1Azho+QtRxnN1HjevGMVYFUzJtK1UgkafXExYnBZMty7h84oBqVxZWMG+pYJksOvdWeWmxq+YZFJ4y43OyxDN+JfGMbuotLOZdZr7Ko+UENACp1Gg0BOiM/GLMAot50U/Ab82ZpvAc3wtr5ExWhteodbLO8Xq86S47ZIp4HW3FI8TLayoW07q6johUUWLQyf+w5nF+npleEM9lapXdnc6Ab//Xnyd/hD6sIo6ccebuCIecUCOMgQC/I+J9NSuGB0mwA7cQhdKb2QXMuYeFQAGJbOXygPV0wgeLK7uPILMGaaZNEjcVq9FTeXaDroDMHUtJlZ1Atl3a054eiSYt6+EnBh0K5Ser6QntfLKN+2Kn67uYiFZVpqE1KxvFLFohjBmsDc6MXGgDV6PNheSkwmk2KUHrMq5/pLE6nudUQ9tlgqRHEP+nNJQnTaWEPlluVPVNsYJu2Ls1vx/fv3W/GSBM1EbaFNIeRi9gyfAN5PnjOPy7HhfxCJL3/ZpPXGQENF33NLjc3Kx6ws3jhe7tUzBNZw7fGxBx5oq2A2w+V02MZi6XONtkNx7dNAs2dY/AVvkZ/gt7V087GVTuE1xw7iL8f5+jfJs7Dyj6Y3InrukfGs7sULaam4ix+Kpy37BgeprLW8zplbF1nv3Sa/8unxjC3rT6g3crkGfP258SyA9dfPCoRU6BA6bmRyexsvDvTAYh75fNICWRpj4uWHgbTzZ7+gZ+ZbIsndnZ8SUvX4E8E8Kf4H1k8YM/5ciC/fqU8eWAwdqTSSgRPVP6sZQT4= +api: {"operationId":"listContacts","description":":::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\nReturns a list of Contact objects.\n","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"ContactsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":":::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\nReturns a list of Contact objects.\n","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-tags.api.mdx b/docs/docs/api/v2/ticketing/list-tags.api.mdx index 34ed26adfb..e9e849e6ad 100644 --- a/docs/docs/api/v2/ticketing/list-tags.api.mdx +++ b/docs/docs/api/v2/ticketing/list-tags.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List tags" hide_title: true hide_table_of_contents: true -api: eJzVV21z2jgQ/is635cwE8AhbWfKXG8uTTI90kBLCslAwrSKLYKILbmSDDgM//12JcAOpFya6Ye7Tl9ia6199tm3p3NPJkxRw6VohF7di7g2HXqnvX0vZDpQPMEjOKjX60IadiM6I67JkFGTKkbgRymijNAJ5RG9jeCNIJ8Vm3A2JUYSzSIWGBKk2siYKbQmMlXkVBimEsU1I0lERYVcH0thKJimerAXw2VG1g2j8V86TehdlLJKIOMSGUpFYomOBfwYW9yVGwHgbsSNuGAASmhCCYZB5JBAKETejgGDBjMIymBs9WvPxjjY9zQLUsVNBu/m3qxME16+Z/g0WMBpQhWNGUDV9lzAA1ARy5APOQu/0iEcwaUcCfqeMpXBgw5GLKZefe6ZLEFzbRQXd3DiEMObkBpWNhwu2/fYjMZJhHY1v3ZY9mvl2mHH9+v2d8X3/b632MxFY0gSJSc8ZOE+mfIocklQNvxVvGQFk1iYxGDe0LN1vNhfhwP8sq+aP7DnR5KDPqgdbuNrpfEteAT+FdNpBFigFJbooNoIeqyQvSad1ckBhFgqwoF8aPkTrOZYghM/a540ZuedI/xT+/hw9HDWab1vjttR0z89aGav/OZD+6E57kXN+8a0edx9aHeOptsBdEYMQXJhC4w4SGRCoQ6LUGflVWGXebhCPGI0tFXxHMhxll9x8DSO1TlpnEAOKXSI4MAK5BvyLwymGPgtGkILZthkNEkiHtgQwKli31OuGDS5USl7FMWymFTZvnlJHJpGTEN9B+wHZC49kKWHDTADfKMTKTTT6Kjm+/jPxj3QsifUUPg8gGEBsaNNIcjqWKPhfBuxawn4EHBAARru3OQp/ndbwWbmKQ5EGtnB5yIpcsKys6R/3HjTGLezVid43R8HD+eduwMoR9M66R42j/3XvXHv8PzqctyL24fNk7NxK27MWscN3RBnURhfZkGtyz/F/dHt361o2H73DtlNcLzKVL8Uzftx/2QU9+L+/flV93UrRjSn0z6g6Y/bs/MraIxx96A3DuPWh8arVraBRlxk4dXlW0RipKHR10CmokiNsN1fLA/o8cWimPRrR2chloE9D6QKi3FRpSh2Pzcs1s/IkS3oXXXa4cE9DEBxR44+N7wtUPg91KLhxlrDsgCbDaNC0eSQB4uFNYRlMZK4R++YhUfNCB6qxm1UzdRktUtSFWGTGZPoerUKe6ey3nRcVs0KZ3VS21rFX5aGLobCEvuCde+oKKyynM2Ef2RI57rxVzabLf/YH7ghYIVDnEaRnJKQTViExNvBToOAaTeCVqTidkbHGK27w68cvKm89XJuu8Itp0cZIXtL7VBaNjkogjyx68AxpagRcJXKQD/SCHD2mNpHh1vD6b8va36HX6QhjJJhGuABKp0rFsGHDLEg7ysyLYVrRksE2EljGJTuQtKTKQmoADDMyQG0hyumUDzLu7gKy6B6TLYe2SicbsT1JYYOPmMI1c1Xi3rtbLC3IhxTUinGVwUuDMZVdd+X3fc6r/KSdfHb9UUqLNNSm5iK/EqVikoC7wT2xm1qDESjJ3el3GI6nVYS95l1ufJfnUp1rxMasPWrcpLewsqoSqhOW2vo3LL8nmpbw6R7cX4jvn37diOe06BLUzubHYRCzZ6jEjVPKOp5vsX+B1X4PHHt5oyB2Y4555YS243z5Si8dgIcZtYImMLn+fwWWO+qaLHA107v4YAMucaYYZgOaaTZDvZ+gRz+AXY7P7f1vhOCdc9qwefj/HlZvBNWUbe/ENEunbvT91qk544H+KC4Ux/XuM+X6+Tnkrl3sdy1JfIr1e+OWDZV/Au53AC+qXh3AtgU4I8gOKMj2LKJKZxtCV/MwFp/fDjtgC1NsemKAsBt++UPmJnVkcgKdxeVgXOPfyOYJ83/wJkJ0uLPtXn+X6UnP1gLDWeNZKCC+gdkMLmN +api: {"operationId":"listTags","description":":::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\nReturns a list of Tag objects.\n","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TagsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tags","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tags","description":{"content":":::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\nReturns a list of Tag objects.\n","type":"text/plain"},"url":{"path":["tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-teams.api.mdx b/docs/docs/api/v2/ticketing/list-teams.api.mdx index a9cbe46fce..a9e13cff60 100644 --- a/docs/docs/api/v2/ticketing/list-teams.api.mdx +++ b/docs/docs/api/v2/ticketing/list-teams.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List teams" hide_title: true hide_table_of_contents: true -api: eJzVV21zGjcQ/ivq9Ys9Y16Mm8yEaTp1jCfFARo7YI8xTCLuBAjfSRdJBxwM/7270gFncFzbkw+tx8actNI+++zrLT0ZM0UNl6IeeFUv5Nq0GY20d+QFTPuKx7gHO9VqVUjDeqI95poMGTWJYgS+ShGmhE4pD+kghBVBPis25WxGjCSahcw3xE+0kRFTKE1kosi5MEzFimtG4pCKIrk7k8JQEE10/yCCy4ysGgDyp05iOgoTVvRldEiGUpFIomIBXyMLvNgTAK4neuKKASihCSVoB5FDgrYQOZgACA1yYJWhI+1V7zxnZf/I08xPFDcpLC69eYHGvHDP8Km/gt2YKhoxAKvtvoAHICOSAR9yFnylQ9iCWzlS9D1hKoUH7Y9ZRL3q0jNpjOLaKC5GsOMww0pADSsYDpcdeWxOozhEuUq5clIoVwqVk3a5XLW/xXK53PVWu96oD0ms5JQHLDgiMx6Gzg3KErA2mKxhEguTGPQcaraKV0cbc4Bh9lXzBXu+JVvQx5WTfXytJBqARvCAYjoJAQsEQ4YOAo6gxiI5aNJ5lRyDiYd5OOAPLV/A6haLXyunzVp93mif4l/l0+J0cdFufWhOLsNm+fy4mf5Wbi4uF83Jbdi8r8+aZ53FZft0tm9Ae8wQJBc2xIiDRKYUIjEPdV5Yh3aBB2vEY0YDGxXPgRyl2yuOH8ex3if1GviQQo4IDqyAv8H/wqCLgd+8ICRhimlG4zjkvjUBlCr2PeGKQZ4blbAHVmTBpAp25TV2aBoyDfHtsx+QmWkgmYYdMH1c0bEUmmlUVCmX8d/OPZizNWoonPehXoDxKJSzsjTRKLnch+xyAg4CEIhAw52erY//XVawuXmMBJGEtvY5U/KksPQi7p7V39Ynl2mr7b/pTvxFoz06hng0rVrnpHlWfnM7uT1p3FxPbqPLk2btYtKK6vPWWV3XxUUYRNepX+nwv6PuePBXKxxevn+P9MZYYWWiX4vmw6RbG0e3Ufe+cdN504oQzfmsC2i6k8t54wYyY9I5vp0EUetj/bdWuoNGXKXBzfU7RGKkoeFXXyYiT42w6Z+PD0jy1Srv9TtHZ86Wvt33pQrydlGlKKY/NyzSz/CRjeiXsPI5pAbrsgvbbbS95g5CRUDqEJgj11O1bUDenuUIsr/aXc7F4pYJFENBaEJjiS16xKzV1IzhoWSyZq2Zmq6bVKJCzF5jYl0tlaChFTdNlMuS4f49dAAxKk0re13+SyZITj/XvVWuO37BfHIU53rk1ksx/8TQTZuKspbZrSUP9YEaAlLYHWgYyhkJ2JSF6FDbMajvM+1qmwW0wtuGEhWjte6OcvH4bfEdtnZurDc6wnW99tpSPEwOsrHkMCseMGxsA2ZjOMYsjh/Yo6WvH4wfsPeQ2gebe1Xvvz8x/Qo/GK5KBomPGzhE3bAQDjLEgryvybQUbhg9JMBOEkEBdheSW5kQnwoAw9ycgfJwxQyCJ7uLq6AA45RJN70AR7KeuLtG00FnBKa6um1Rb5T1D9aEo0uKeftKcZZ5JXe+4M7rbZQfWhW/3F0lwjIttYmo2F6pElGMYU1gbgwSY8AaPR0dbiVms1kxdsesyrX+0kyqex1Tn22WCnEygFZUkhCdNtZQuWX5A9U2hknnqtET375964nnJGgmamu+g5CL2QYOueaxaX25bY//gzB85uDuKo2BroFe55YUm4/LrBreeWY91I+BLFxYLgdAfEeFqxUuu1kSa2TANVoNBXVIQ82e4O8njNo/AG9L6P67hBsyq56dM5+P8+Uj95Ow8u8Er0T01Az9pO7NC8BWcR8fFHft9w5HhayjvMyZB1dZvz0kP3OyfsKW3TeEV3K5A3x3mn4SwO5w/wCCEzqFRhub3N7eTI0e2MwgH8/bIEsTzLr8DOAafvYFPbPeEmnu7vxw4NTjJ4J5VPx3LJswXfyxEd++hj16YDNrOGkkA6eofwCc5dzS +api: {"operationId":"listTeams","description":":::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\nReturns a list of Team objects.\n","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TeamsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/teams","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List teams","description":{"content":":::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\nReturns a list of Team objects.\n","type":"text/plain"},"url":{"path":["teams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-tickets.api.mdx b/docs/docs/api/v2/ticketing/list-tickets.api.mdx index 89403c0daa..f79c631465 100644 --- a/docs/docs/api/v2/ticketing/list-tickets.api.mdx +++ b/docs/docs/api/v2/ticketing/list-tickets.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List tickets" hide_title: true hide_table_of_contents: true -api: eJzVWOtT20gS/1dmtR8OqpCtl591e3cEqMRZ7A2sCcWryGg0wjLSSKsZYQzl//26R34ImziE2g93VCCWpqf71+9uPxtpxnOqolT0AqNrxJFUw4jdcyWNPSPgkuVRhqdw1u12Rar4tRiOIklCTlWRcwIfUxFPCX2gUUz9GN4I8iXnDxGfEJUSyWPOFGGFVGnCc6QmaZGTI6F4nuWR5CSLqaiRq4NUKAqkhbzZSYCZSruK0+Q/ssjoXVzwGkuTXRKmOUlSFCzgY6Kh164FgLsW1+KUAyghCSWoCUlDUmpDUn8MMCRQgl6K3kmje2UsNL3ZMyRnRR6pKbx+Nh5NmkXmPcenmxmcZjSnCQfAUp8LeACDJGkQhREPbmkIR8A3QjP9VfB8Cg+SjXhCje6zoaYZkkuVR+IOTkrc8CagipsqAmZ7Bn+kSRYjnWM5rmk5puMOLaur/9Usy7o0Zuse6YUky9OHKODBHplEcVy6ItdGWKhMFjCJhkkUeg8la8GzvaU6YGV+K6Mn/nZNVqBtx93ENygSHySCF3IuixiwQEDM0UHYEZRYIzt9+tglNqi4W4UD/pDpT1h1hYUdWtP+Ye/xeLiPv87vT/tPn4eDD/3xSdy3juz+1LP6TydP/fFF3L/vTfoHZ08nw/3JpgLDEUeQkdBhRkpI5IFCNFahPpqL8DajYIF4xGmgo+ItkJPpioX9Oo7FOekdgg8p5ImIwCrgb/C/UOhisG+VEBJxiqlGsyyOmFYBhOb8ryLKOWS7ygv+Qot5MOWmfvMePSSNuYT4Zvw7xpxLIHMJa2Bu8I3MUiG5REGOZeF/a3zKrD2kigIHBlUD1Eeyip71sUTa503QZVbARYACMaiiUtLKyz+mFfxRvWYGUcS6ApbKVM3Cp5+zy4Neszc+mQ6GrHE5Zk/HwzsbIlINDs/c/oHVuBhfuMfnX8cXyYnbP/w8HiS9x8FBT/bE5zhIvk6Zcxb9kVyO/E+DODz57Tc0cIZ1Ni3ke9F8GF8ejpKL5PL++PysMUgQzdHkEtBcjk8ej88hN8Zn9sU4SAYfe95guoZGnE6D868dRKJSReNblhaiahqhC0A1QiDNZ7Oq369Kc1Z0udHnLM2Dql40zykWgEjxRL7BRzqmf8YqX2JOoRnRIFj0F8XvytYoUUMqZXQnOH8LqNcKZIs2PNvxTKfdCk2v4wVmp9ngpssavutarEObbQNNw3LorFD4tnJzQ9puhE3PbLTsluk1mo7puyEzHdZpumGzSUPa1BlY8Fus9du5QcdxTNsybXvZcXS3kQp6/A/0+uPL0WAj17ddOKC6LEHX/769/0166h/QzhJ6z4mcCgZMsGdRkhRsROBixPNfUCxLY5wvtJPe5ZfQb7NGw2+aNvPbpud7zOyE+NjqOJ7j2k27E2i/KF12bktO2zhGABcrsg4atp4Sr1ywOo0281nTbFqeZXquRc221+YmBS8ynwahR3mpqx6QtjNrNpjrNXxqNtstYNZpeWa7BY9B4NoNq8PcZovq0kFzwHhbarWdZQsjNLA807UCx/RCl5s+9xqm02q7bZ91PNdzdA3QY9V7nMCXw2CZAim+VzhZ/QAaRK5t2o5pdV5G7txZRR5vvz9SKpPdeh2GojwAk6ipTEM1AdvgtFmHmoLVpe7WIykLXrfLohul5ai4jfOn3sdPxkapK7veIsVvEKjS5HM/zNZvVPrSqirezGaaEEbSUYpj+x3XFZCqETzU1XKAlzx/WAyt2hZLhWHArS0H6yid3wEl6g/OxuT/55yQ7H/pGbPKtPwndteyIlZm5lUEZNHvHENgOWEsaNZni5fyQAwBKpwWaRynExLwBx5jedcTJCQVl+WsowHNkFuYomDUtuRh1exmrWOsLHwmyil4uNAUL5Od+aqya7zIrzngheLoWVxJcGZPmXyxksDZS9O+ONyYgv73t6hf4Yf0hMrToNCVFRercx7DRY5Y0O4LY2oTLi26S8A6RQLZXDIkF1DnGdT7AvDpvQPpgcUEgmfOC/LO1Im3nA1xSbsWV19RdZCZgKrlFKdRL4Xd7CwMji6pVfWrgy0U6lUv75vlfbmK8l0t4per00JoS6dSJVSsWOaFqGXwTmBu+IVSoI18uNtdUUwmk1pWXtMiF/LrkzS/lxllfPnKzAofBtN6CtGpYw2Fayt/wA6INjk7Pb4W3759uxZvSdA5qS5GJYRKzB7j4qte3+GfV+Py/0EgvnmdL6uNgjkSPR9pw8xLf1kTrwy1WvVHYDJ89fzsg/nP8ng2w9flhomVMogkag6FNaSx5Fts+Dcs4N+Brwvp5jcM5erZNfT2+XacP7+Ib4VV/abgnYi2bdZbZS+/FlgJvsGHPCrH+itcH+Z95eecuXM677u75O/ct7fosv69wTttuQZ8fcfeCmB95X8BoSTah3abqcrZxp6NHljOIh+PhkBLC8y76iRQtv35B/TM4khMK7yrI0IpHv8imFfJ/4nFE2aMfy3JV1/OvHphOXGU1GgMnKb+C3+jLFQ= +api: {"operationId":"listTickets","description":":::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\nReturns a list of Ticket objects.\n","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TicketsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tickets","description":{"content":":::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\nReturns a list of Ticket objects.\n","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/list-users.api.mdx b/docs/docs/api/v2/ticketing/list-users.api.mdx index ebc06f9def..d54c9fc7e0 100644 --- a/docs/docs/api/v2/ticketing/list-users.api.mdx +++ b/docs/docs/api/v2/ticketing/list-users.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List users" hide_title: true hide_table_of_contents: true -api: eJzVV21TIjkQ/iu5uS9aJTCg6yp1e3Wueru4wq0uaIlSbpgJEMwks0kGGCn++3VneBnR9dTaL2epMJNO99NPd6c7U0/FTFPLlayFXtUT3NiWYdp4W17ITKB5jGuwUq1WpbLsRjYH3JAeozbRjMBXJUVK6IhyQbsC3kjyVbMRZ2NiFTFMsMCSIDFWRaAWpIlKNDmWlulYc8NILKgskutDJS0F0cR0NiJQZlXVMhr9ZZKY9kXCioGKNklPaRIpNCzha+SAF28kgLuRN/KcAShpCCXoB1E9gr4Q1R0CCANy4JWlfeNVr73My86WZ1iQaG5TeDn1JgUa88Idw6fODFZjqmnELMriuoQHICNSIe9xFt7SHiyBVo4U/UiYTuHBBAMWUa869Wwao7ixmss+rGSY4U1ILStYDsq2PDahUSxQruJXtgt+pVDZbvp+1f0Wfd9ve7P1aNR6JNZqxEMWbpExFyILg3YELBwmC5jEwSQWI4eWneHZ1tIdYJjdGn7PXu7JCnS5sv0YXyOJush8DyCZRAAWSIY5Okg4ghaLZKNOJ1VSBhc383AgHka9gtUVluDIT+tHtclp8wD/Kl/uD+5Pmo2P9eGZqPvH5Xq649fvz+7rwytRv6uN64et+7PmwfixA80BQ5BcuhQjGSQyopCJeaiTwiK1CzxcIB4wGrqseAnkKF2pKD+NY7FOakcQQwo1IjmwAvGG+EuLIQZ+84JQhCmWGY1jwQPnAhjV7EfCNYM6tzphD7yYJ5MuuDdv8cNQwQzkd8B+QubcAplbWAPTwTcmVtIwg4Yqvo8fD/W4mj2ilsL+AM4LcB6Fcl6WhgYlp48hZzUBGwEIZKDlmZ1VjP9bVrKJfYoEmQh39mWu5Elh6UncPqzt1oZnaaMZvGsPg/vTZr8M+WgbR63t+qH/7mp4tX16eTG8is6260cnw0ZUmzQOa6YmT0QYXaRBpcX/idqD7ueG6J19+ID0xnjCqsS8Fc3HYftoEF1F7bvTy9a7RoRojsdtQNMenk1OL6Eyhq3y1TCMGp9qO410DY08T8PLi31EYpWl4jZQicxTI1355/MDinw2y0f9OqMz50vHrQdKh3m/qNYUy59bFpkXxMhl9GtY+cwF+ZvxPnrDsPPc0jCEXHyS3NW2ARPxg+aE+7m5hR7GR3kIXaUEozK/uUeFYUgeNLiX+PqEF05FHs/uXrnr98L3hR2f7RZ2uvvlwh6DdlLZK+/sva/4+34XKhOMQqu2VL+Oo4G1samWSkt/uSolUIy3QH6PC3Yb86AYg5JHMc6K/SGveZ6g7i23zggqBAVrGnIFukqPzmzmBKEzDxTOLX3mUoHaATw4aGgGPkaLzp1okXMEunwx74zlwR20RdkvjSqPRp9vc0Fy8LXmzXIjwzc8ZLK8yw0Oq3DG/AvDeC6P2YXM+gH70B6YISCFLZMKocYkZCMmMMtdG6VBACy6A98BwryDaQgNo7eZDr9Y3i3ueyt2WzIbBZoLT3Ez2ZjPapvzExWisqqipeOLCOLgogLzMO231qhdr4n/2xj5O/yQmrRahUmACzhZXjIBGxliQd4XZDoKl4xuEmAniaArZQrJlUpIQCWAYdnwhfKgYgzJM9fFdViAGdOmywaJc+qNvL5A18FmBK5mzcyhXhrrbCwIx5AU8/6VgAuLfpWy/YVsv1ll+aYz8dv1eSId08rYiMqVSp3IYgzvJNZGN7EWvDGj/uZKYjweF+NsmzO5sF8aK31nYhqw5atCnHShP5cUZKfLNTTuWP5Ijcth0jo/vZHfv3+/kS8p0Lmoa4QZhFzOnuLknzx1hZmuZob/QRq+8DaTnTQWWilGnTtSXD1O56fhtZcsbjoDIAtfTKddIL6lxWyGr7MBG8/IkBv0Oly2l5/y9wvuHz8B747QxxesbPKuem74fjnO199DnoWVvyi9EdFzF4tnbS9vRSvDHXzQPOvZ1zg/zTvK64K5cT7vt5vkV143nvFl/dr0Ri7XgK9fMZ4FsH7jeQAhEzqARhvb3NqjiwZGYDmDfDpugixNsOryM0DW8OdfMDKLJZnmdOeHg8w8/kcwT4r/gccmTBd/LsVXd9MnNyxnjUwaycAp6l9RODkT +api: {"operationId":"listUsers","description":":::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\nReturns a list of User objects.\n","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"UsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List users","description":{"content":":::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\nReturns a list of User objects.\n","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx b/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx index b94997c65d..6eac5deee6 100644 --- a/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx +++ b/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx @@ -11,7 +11,7 @@ custom_edit_url: null import ApiLogo from "@theme/ApiLogo"; import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; -import Export from "@theme/ApiExplorer/Export"; +import Export from "@theme/ApiDemoPanel/Export"; Version: 0.16.9 diff --git a/docs/docs/api/v2/ticketing/update-ticket.api.mdx b/docs/docs/api/v2/ticketing/update-ticket.api.mdx index 60a93f5077..cb00591828 100644 --- a/docs/docs/api/v2/ticketing/update-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/update-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Updates a Ticket object with the given values." sidebar_label: "Update ticket" hide_title: true hide_table_of_contents: true -api: eJztWntz2zYS/yqobjqXzBgSSUnUo9fr+aEkSuLYZyttcpZHBUlQYkwSDAlKVj367rcLkHrasutp/7PssUVisdhd7OMHLu8qIuEpk4GI+16lW8kTj0k+CNwbLisHFY9nbhokOAyDn9VgRhjRBEQ437grySyQEyInnIyDKY/JlIU5z6owXbJxVuleVTR5Vrk+qCQsZRGXPMWBu0oMF8D5lrp5JkXEUxp4MDHA5SaceTyFq8yd8IhVuncVOU+QPJNpEI9hhN+yKAnxVjRfsTAri23RByBdOU76JyAtkySPg+85D+ck8HgsAz8A3eQ6YRCTuchTwpIkDFxlJVg05d/zIOVgLpnmfHGwpkWSiikwS6m68xw9MhbyzBepy+9XolyBFCs8KIxUNh+tzJkwOdmZ8DShDKvZdh3XprZhGbRRNxhtN9qcMuYz12Ge32Ag7gK2N+NungZyrjb3lrIkoDccr65xFNfmmTwS3hwX3BbFFbGEjcChNYvXvmWo/d2upNr9QFIwCnixhP3TbF2Reo/TaUPt6h3nYcgcVFyLtbLDechZxgnzPBKJlIN/SD7W0ZPhdrEsC8Yx1+wLtixN2Rz3QPIo229ms8WaDdNqUKvd8mmj0/Box25yWnebTr1uuB1mt8HMYKiUMynS/dzqPms3fbtBmy2zRRtN26JO3Xep5Xbsum/bsHe28rGcjzCu93OzDMuipkFNc2AYXfX7P5ydSSbzR/Q6O+992vHmfROOmQo8kuyx9y+kL/8ZhiRiN5xk89gFJgT0YCTK3QmBiQFPf8BlXRGGsP9qk561L77TdptNx6am67Rpw2m4tOPjZatjNay6aZsdT+1LEXOa0z6OAYiLOUc5jeuKXHv9ngjsLCOw8XAE6hBi7iPM7KZbbzQdRu12C5h1Wg3absGl59XNptFx63aLITPI1SDjSGu1n2ULPdQzGrRueBZt+HVOHd5oUqvVrrcdt9OoNyxkqSvCczYBJOFpkgYZ1yEg8L7k3og9Ihp4rklNixqdTc8tNitPw/3zJ1ImWbdWk5Mg9cAkcp4JX87ANlUQogY5BbNLrV4LsiznNVV8QE6h0+A+zu/6b98pZVaJ8KpS5PUyxK9RUKnIdW0ut2N7XpH1rhcLPZIl4O86E1mGgf+2ioku4ZopFom/KPvyNBXpU/b4gfkelyy4d0t2i6EPmZqoBUnEs4yN4VYqIlXEUx4Jycl5US+rBCdoJQiLPRLyKQ+J8IleEEAM8JqydE6c+WrWxn7dDcFIHh9Wug3DOBhWHKhjcAG3dRaE70Ot/7ACw4VI6u651nFegCMy45DOYiHxOvC65OpuiJ9KkP2KN/RF12dhxg/0RclNj+h/S67D9U9lNGKOyMG1s837xBOwNK7Kb4NM6psFey32BvMLyNsXg6+jk7Pe5afBqPelfznYmIOuujFla+GSLhQuKPUH93q4yOnfpMjiWlkdoiDlYYFole0ZpB+raUHSNpwmFEJIUMwzobayjt+ym6bX8iw9FSJhLNK5mvXr4cf+yeGgf/Zp1Lu4OLuABYBEY7lM7zpkbtCFYuCkIqQsDMWMQuAqNAlbp/ioPdTsfeoycEC65i0nXz8dnvaPy3GIFHW7bTTrntlyOh7jHRtq+OX7gkbEsa5lis4NRclcRy8NeTyWEzVYt82NIYwnbZCt8P7JnbA04/LnXPq0reZgUlC0pyI+IKZJLnlCIJPWiVXvNs2uZZG3pwNFGvNQURYenOXKKiM/ZVpOvc9G1TALd0h5IlIoK2LDBUB75LTuNxG7Ha08BSpf2zAWak3NggKLtZV57CUCIELhfN0ypiDDb6xUJnRWhQWrYMLc88MynWvOtWn9l+znN+NZ/uXMOfvRevOHzSaf33/Ibr+dfGRfBr99E+J9Wx4Zs8aP1hH8fmB5+PZS3hpv3t7E5rl4L85urQ/pm1M/mPzxyfMPvwc331vH0djxwmj24ag9uYmSOh84dvt7MjaNj1/ehBfj4PL7xcT57bQ1/3rpi/bxl+j8yC29uzDKOBV58nzLZTyd8rR0nkJzPQJ51gWbpizOlHVLLK+IgSMFjj8DQqjbhmH8BGDMDXOPX+bOiYhYEGc/weGEh4J5ih2mUjUTCuE4ACc6BL9IJO3FkEMhoSuiW7runFSo5K4jIxZZHPh+QcbjqZjTPAEhOYsoahG4nMog0m7aMUvC6RxVgLEQMgOPC13Li5Ha/B1asKnkKIsfjHMNMO+ZVoMIf2BqKZBKiaoMoMAQU9qeIdbynalqLzzqzGkidKoKmGdYtUnu4MFJejWtNhTI2zm1IY112rbbtGnnNptYO+ymQSpzFtKJgJSo4nwpLnCEPZV0LTnCQfvPZccVFzAQD4MokBQBeQoljEZQPQGagQU9vX0m+Ijx4DzwppLqQRoo4OBVylNwgzsPEuplw3nB8VG6bc7FhOJw+gy7KPOrSdaRedSot+26bbWanSP7sHFch9izDk9Mu33UNuonJ8fmUa/VMnY/EOOLYazRo4DjZ/TgOWIXCF3mCRsDsCjAEKIUAodR4QYI7lYPaNTwJqg57V9e9j+9HV30/vu5f9E7Gb3p9z6eaICscOdj6x8SJw044qjlXYRVq+W2kReyQ4oSsj0Bee2HT2i1xRr51QpFvmC2F8z2gtleMNsLZnvBbC+Y7QWz/T2YbRuyVY4OTxSg6l0OdCWqrB7jPY5lrhHNzFiK6v4NT9IeRZgPY7/F8nMA4EZOhKcbSy52llSDqVup6QeUWe1u2YJaYPNLJTHd9VPPXFc5PQmqWQFgq4Eo5sNytam1gzaXSPfwvF9Z7zhdIsDUiq/1nVa2S4IPHI237NWVNNtdui10e94nQEWkIAorAMydQsIEM2fqniqcCuwqgcAuWJ0vVo2uXolK1xtThRB7+0kb7aSrpzWHrtd6Q09rAK33f+5v8qx6PLqRs22hv7BZs9WruXpa5+V6q/Gy6q6sNVee1kFZa6A8rUuy0yR5Widk1Rpfa2tcb3c17m9dbHYu/nx7Yr07sWpBBLEv0DMxRvW+GlXTrnbWEtfnGFvkXtH8xx3E4Hh1nvJpwGevKxvdp8LDy3DF01ykT2SecLP/LOMdZISxTVU2Bne64N1uF7IlH8aDSZARH7w9R2/LiIjDOWFTWAW7t9i8L0TDQM04+tWytY/UBFv7vaX9wYFZXCVXx1oJkmfXr1BkKboS8MuGyK+Jjz0H7ebwNVJuXh3GINww/gd8SB8PGF6u8TT8/MZDmMhRFswWpTGVCZcWfQ2nJDePwCk0Q/IVAsuFAMtBPon6Ij2wmMH+Fbxg26na9+W7AVkVF7z6FVWHNSNQtTh+o9TLxa5flQbHLamu61cDW0jUq6bnUz0/W+Xm12qJH64u8lhZGvBLxOIVyzSPq4D8ohgzupNLCdpk0/HrFcVsNqsmeppasly/NhPpTZZAeV7eoknuwOmnJqYI2cDXcHFl5SNMOWiTzxcfh/Hvv/8+jJ9SVgpSVQq1CGs+q19zIfLel2DuVn2yZ7wPo/OT5LcSLRwoAYoGpK6eV0VwY/rvrl7hgNSACBHH7+4c0PlzGi4WeBvqTKrerzhA9B7o9xbwAUiQ4XevfCDxsBavLoou4mvykIhlDY2xWip14Aq+qhK79qYJIJeDspA+W4i/8lWde7XRUm+/crRUC9+hebbg26/n7BVg+22hDRE00XFx1BognxXFToN2NUMf2fbSXq+Bt/PDwfE7oHaKd3Ii4eGklM3wXSH4260M4QcuioOeAjJ4/64C+XKcwwETaDRjLCQsRz9ex10aZBVf0C3udad1QKY1wb+o173k/8KgB0T37yW5HnlwwhLfaepA4+zF/wEbxRwQ +api: {"operationId":"updateTicket","description":"Updates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"update_ticket"}},"required":["record"]}}}},"responses":{"200":{"description":"Ticket updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"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\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"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\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"patch","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.16.9","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::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#### Introduction\n\nWelcome to the Unified API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Update ticket","description":{"content":"Updates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/ticketing/unified-ticketing-api-preview custom_edit_url: null @@ -13,8 +13,8 @@ custom_edit_url: null import ApiTabs from "@theme/ApiTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; diff --git a/openapi/v2/mgmt/components/schemas/create_destination.yaml b/openapi/v2/mgmt/components/schemas/create_destination.yaml index fdb293b26e..f40c97991b 100644 --- a/openapi/v2/mgmt/components/schemas/create_destination.yaml +++ b/openapi/v2/mgmt/components/schemas/create_destination.yaml @@ -1,14 +1,4 @@ oneOf: - - type: object - title: postgres - properties: - type: - type: string - enum: - - supaglue - example: supaglue - required: - - type - type: object title: postgres properties: @@ -26,6 +16,17 @@ oneOf: - name - type - config + - type: object + title: supaglue + description: A Supaglue-hosted Postgres database destination for Listing APIs. + properties: + type: + type: string + enum: + - supaglue + example: supaglue + required: + - type - type: object title: bigquery properties: diff --git a/openapi/v2/mgmt/components/schemas/objects/connection.yaml b/openapi/v2/mgmt/components/schemas/objects/connection.yaml index e3ab879643..e6062d05eb 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection.yaml @@ -24,6 +24,8 @@ properties: $ref: ./schema_mappings_config.yaml entity_mappings: $ref: ./connection_entity_mappings.yaml + connection_sync_config: + $ref: ./connection_sync_config.yaml required: - id - application_id diff --git a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml index 3613395f50..43c1e461c8 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_id: type: string @@ -7,6 +8,6 @@ properties: field_mappings: type: array items: - $ref: ./entity_field_mapping.yaml + $ref: ./entity_field_mapping.yaml required: - entity_id diff --git a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml index 3698cc62c2..d0300b32a9 100644 --- a/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/connection_entity_mappings.yaml @@ -1,5 +1,6 @@ type: array description: This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). +deprecated: true items: $ref: ./connection_entity_mapping.yaml example: [] diff --git a/openapi/v2/mgmt/components/schemas/objects/customer.yaml b/openapi/v2/mgmt/components/schemas/objects/customer.yaml index 4698c8fabe..2910d33598 100644 --- a/openapi/v2/mgmt/components/schemas/objects/customer.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/customer.yaml @@ -1,3 +1,4 @@ +# Supaglue Customer with connections type: object properties: application_id: diff --git a/openapi/v2/mgmt/components/schemas/objects/destination.yaml b/openapi/v2/mgmt/components/schemas/objects/destination.yaml index 10466ff3c2..f276507db0 100644 --- a/openapi/v2/mgmt/components/schemas/objects/destination.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/destination.yaml @@ -12,7 +12,7 @@ example: user: myuser oneOf: - type: object - title: supaglue + title: postgres properties: id: type: string @@ -20,20 +20,30 @@ oneOf: application_id: type: string example: 726fb798-d854-4c59-9a23-57e3e2f73eae + name: + type: string + example: My Postgres Destination type: type: string enum: - - supaglue - example: supaglue + - postgres + example: postgres + config: + $ref: ./postgres_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id + - name - type + - config - version - type: object - title: postgres + title: supaglue + description: A Supaglue-hosted Postgres database destination for Listing APIs. properties: id: type: string @@ -41,24 +51,19 @@ oneOf: application_id: type: string example: 726fb798-d854-4c59-9a23-57e3e2f73eae - name: - type: string - example: My Postgres Destination type: type: string enum: - - postgres - example: postgres - config: - $ref: ./postgres_config_safe.yaml + - supaglue + example: supaglue version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id - - name - type - - config - version - type: object title: bigquery @@ -81,6 +86,8 @@ oneOf: $ref: ./bigquery_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id @@ -109,6 +116,8 @@ oneOf: $ref: ./mongodb_config_safe.yaml version: type: number + example: 1 + description: A monotonically increasing version number of the destination configuration required: - id - application_id diff --git a/openapi/v2/mgmt/components/schemas/objects/entity.yaml b/openapi/v2/mgmt/components/schemas/objects/entity.yaml index cd9b6df10b..4b9e9061fb 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml b/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml index d29ade6ae6..b135fc9888 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity_config.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: fields: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml index 9227c65a57..b4099b81f6 100644 --- a/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/entity_field_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_field: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml b/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml index a70e13a6d6..c874cea1c4 100644 --- a/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/magic_link.yaml @@ -5,7 +5,8 @@ properties: example: ec208408-db29-4705-b39e-4d33070b4ef6 status: type: string - example: created + description: '`new` or `consumed`' + example: new application_id: type: string example: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 @@ -29,6 +30,7 @@ properties: type: string format: date-time example: '2023-02-23T00:00:00Z' + description: Any ISO formatted date-time string indicating when the magic link expires. required: - id - status diff --git a/openapi/v2/mgmt/components/schemas/objects/provider.yaml b/openapi/v2/mgmt/components/schemas/objects/provider.yaml index de56bf796a..3ea3ab3b4a 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider.yaml @@ -13,6 +13,7 @@ properties: enum: - oauth2 - api_key + - access_key_secret example: oauth2 name: $ref: ./provider_name.yaml diff --git a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml index 16a081d365..0074ceb601 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mapping.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: entity_id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml index 61d5f01872..885062de8c 100644 --- a/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/provider_entity_mappings.yaml @@ -1,4 +1,5 @@ type: array +deprecated: true description: This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. items: $ref: ./provider_entity_mapping.yaml diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml deleted file mode 100644 index 769ac01bc5..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_at_least_safe.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE - secret_access_key: - type: string - example: A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS -required: - - region - - bucket - - access_key_id diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml deleted file mode 100644 index a00a342e93..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_safe.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE -required: - - region - - bucket - - access_key_id diff --git a/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml b/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml deleted file mode 100644 index 52c27063f4..0000000000 --- a/openapi/v2/mgmt/components/schemas/objects/s3_config_unsafe.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -properties: - region: - type: string - example: us-west-2 - bucket: - type: string - example: my-test-bucket - access_key_id: - type: string - example: AKIAIOSFODNN7EXAMPLE - secret_access_key: - type: string - example: A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS -required: - - region - - bucket - - access_key_id - - secret_access_key diff --git a/openapi/v2/mgmt/components/schemas/objects/schema.yaml b/openapi/v2/mgmt/components/schemas/objects/schema.yaml index ea11b278cf..91bf5bbf55 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: id: type: string diff --git a/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml b/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml index 87dc8aa60c..a59c8c41ee 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema_config.yaml @@ -1,4 +1,5 @@ type: object +deprecated: true properties: fields: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml b/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml index dc4ce86ec5..d37cdcbdfd 100644 --- a/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/schema_mappings_config.yaml @@ -1,5 +1,6 @@ description: This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). type: object +deprecated: true properties: common_objects: type: array diff --git a/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml b/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml new file mode 100644 index 0000000000..d3a99b452b --- /dev/null +++ b/openapi/v2/mgmt/components/schemas/objects/simple_customer.yaml @@ -0,0 +1,19 @@ +type: object +properties: + application_id: + type: string + example: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 + customer_id: + type: string + example: your-customers-unique-application-id + name: + type: string + example: MyCompany Inc + email: + type: string + example: contact@mycompany.com +required: + - application_id + - name + - email + - customer_id diff --git a/openapi/v2/mgmt/components/schemas/objects/sync.yaml b/openapi/v2/mgmt/components/schemas/objects/sync.yaml index 80eea61cc3..25aa7757f7 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync.yaml @@ -1,7 +1,7 @@ # this is verbose because our docs generator can't handle allOf with nested oneOf correctly oneOf: - type: object - title: 'Data model: Entities' + title: 'Data model: Objects' properties: id: type: string @@ -9,11 +9,19 @@ oneOf: type: type: string enum: - - entity - example: entity - entity_id: + - object + example: object + object_type: type: string - example: 94e6cb6c-0ec8-423f-8873-21054979a6b1 + enum: + - common + - standard + - custom + example: standard + object: + type: string + example: contact + description: The Provider's object name (case sensitive) connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -26,12 +34,13 @@ oneOf: required: - id - type - - entity_id + - object_type + - object - connection_id - sync_config_id - paused - type: object - title: 'Data model: Objects' + title: 'Data model: Common Schema' properties: id: type: string @@ -45,13 +54,11 @@ oneOf: type: string enum: - common - - standard - - custom example: standard object: type: string example: contact - description: The Provider's object name (case sensitive) + description: Supaglue's object name connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -70,7 +77,8 @@ oneOf: - sync_config_id - paused - type: object - title: 'Data model: Common Schema' + title: 'Data model: Entities' + deprecated: true properties: id: type: string @@ -78,17 +86,11 @@ oneOf: type: type: string enum: - - object - example: object - object_type: - type: string - enum: - - common - example: standard - object: + - entity + example: entity + entity_id: type: string - example: contact - description: Supaglue's object name + example: 94e6cb6c-0ec8-423f-8873-21054979a6b1 connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -101,8 +103,7 @@ oneOf: required: - id - type - - object_type - - object + - entity_id - connection_id - sync_config_id - paused diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml index ee8adc65f3..2b87adfcc0 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_config_data.yaml @@ -49,6 +49,7 @@ properties: - object entities: type: array + deprecated: true items: type: object properties: diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml index 8337052e6d..30be38a404 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_run.yaml @@ -2,6 +2,12 @@ oneOf: - type: object title: 'Data model: Objects' properties: + id: + type: string + example: 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 + sync_id: + type: string + example: 629525f8-f6f7-436c-80fa-1cb23acc5bf8 object_type: type: string enum: @@ -44,6 +50,8 @@ oneOf: nullable: true example: 100 required: + - id + - sync_id - object_type - object - start_timestamp @@ -58,9 +66,17 @@ oneOf: - num_records_synced - type: object title: 'Data model: Entities' + deprecated: true properties: + id: + type: string + example: 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 + sync_id: + type: string + example: 629525f8-f6f7-436c-80fa-1cb23acc5bf8 entity_id: type: string + deprecated: true error_message: type: string nullable: true @@ -95,6 +111,8 @@ oneOf: nullable: true example: 100 required: + - id + - sync_id - entity_id - start_timestamp - end_timestamp diff --git a/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml b/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml index 29ab482762..cec6a7ee87 100644 --- a/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml +++ b/openapi/v2/mgmt/components/schemas/objects/sync_with_provider_and_customer.yaml @@ -1,7 +1,7 @@ # this is verbose because our docs generator can't handle allOf with nested oneOf correctly oneOf: - type: object - title: 'Data model: Entities' + title: 'Data model: Objects' properties: id: type: string @@ -9,11 +9,18 @@ oneOf: type: type: string enum: - - entity - example: entity - entity_id: + - object + example: object + object_type: type: string - example: 70da3830-b717-49cb-91f0-22fb3f09a97a + enum: + - common + - standard + - custom + example: standard + object: + type: string + example: contact connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -32,14 +39,15 @@ oneOf: required: - id - type - - entity_id + - object_type + - object - connection_id - sync_config_id - paused - provider_name - customer_id - type: object - title: 'Data model: Objects' + title: 'Data model: Entities' properties: id: type: string @@ -47,18 +55,11 @@ oneOf: type: type: string enum: - - object - example: object - object_type: - type: string - enum: - - common - - standard - - custom - example: standard - object: + - entity + example: entity + entity_id: type: string - example: contact + example: 70da3830-b717-49cb-91f0-22fb3f09a97a connection_id: type: string example: 3217ea51-11c8-43c9-9547-6f197e02e5e4 @@ -77,8 +78,7 @@ oneOf: required: - id - type - - object_type - - object + - entity_id - connection_id - sync_config_id - paused diff --git a/openapi/v2/mgmt/openapi.bundle.json b/openapi/v2/mgmt/openapi.bundle.json index 6b910af825..f081526cdb 100644 --- a/openapi/v2/mgmt/openapi.bundle.json +++ b/openapi/v2/mgmt/openapi.bundle.json @@ -38,7 +38,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/customer" + "$ref": "#/components/schemas/simple_customer" } } } @@ -100,17 +100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/customer" - }, - "examples": { - "Example": { - "value": { - "application_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69", - "name": "MyCompany Inc", - "email": "contact@mycompany.com", - "customer_id": "your-customers-unique-application-id" - } - } + "$ref": "#/components/schemas/simple_customer" } } } @@ -134,17 +124,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/customer" - }, - "examples": { - "Example": { - "value": { - "application_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69", - "name": "MyCompany Inc", - "email": "contact@mycompany.com", - "customer_id": "your-customers-unique-application-id" - } - } + "$ref": "#/components/schemas/simple_customer" } } } @@ -163,153 +143,6 @@ } ] }, - "/destinations": { - "get": { - "operationId": "getDestinations", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "summary": "List destinations", - "description": "Get a list of destinations", - "responses": { - "200": { - "description": "Destinations", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/destination" - }, - "example": [ - { - "id": "92bc3460-a301-4116-8d1f-6e5f8252c2e2", - "application_id": "9b9a31bb-9fe4-4fa5-ba84-4c035a27f258", - "name": "My Postgres Destination", - "type": "postgres", - "config": { - "host": "production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com", - "port": 5432, - "database": "my_database", - "schema": "public", - "user": "user", - "password": "password" - } - } - ] - } - } - } - } - } - }, - "post": { - "operationId": "createDestination", - "summary": "Create destination", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_destination" - } - } - } - }, - "responses": { - "201": { - "description": "Destination created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - } - }, - "/destinations/{destination_id}": { - "get": { - "operationId": "getDestination", - "summary": "Get destination", - "tags": [ - "Destinations" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Destination", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - }, - "put": { - "operationId": "updateDestination", - "summary": "Update destination", - "tags": [ - "Destinations" - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/update_destination" - } - } - } - }, - "responses": { - "200": { - "description": "Destination", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/destination" - } - } - } - } - } - }, - "parameters": [ - { - "name": "destination_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, "/magic_links": { "get": { "operationId": "getMagicLinks", @@ -911,161 +744,6 @@ } ] }, - "/providers": { - "get": { - "operationId": "getProviders", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "summary": "List providers", - "description": "Get a list of providers", - "responses": { - "200": { - "description": "Providers", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - } - }, - "post": { - "operationId": "createProvider", - "summary": "Create provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_provider" - } - } - } - }, - "responses": { - "201": { - "description": "Provider created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - } - }, - "/providers/{provider_id}": { - "get": { - "operationId": "getProvider", - "summary": "Get provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "put": { - "operationId": "updateProvider", - "summary": "Update provider", - "tags": [ - "Providers" - ], - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/update_provider" - } - } - } - }, - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "delete": { - "operationId": "deleteProvider", - "summary": "Delete provider", - "tags": [ - "Providers" - ], - "security": [ - { - "x-api-key": [] - } - ], - "responses": { - "200": { - "description": "Provider", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/provider" - } - } - } - } - } - }, - "parameters": [ - { - "name": "provider_id", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ] - }, "/sync_configs": { "get": { "operationId": "getSyncConfigs", @@ -1629,15 +1307,6 @@ "allOf": [ { "$ref": "#/components/schemas/connection" - }, - { - "type": "object", - "properties": { - "user_id": { - "type": "string", - "description": "The id of the user associated with this connection. This is sometimes also known as the owner." - } - } } ] } @@ -1757,6 +1426,7 @@ }, { "name": "entity_id", + "deprecated": true, "in": "query", "schema": { "type": "string", @@ -1812,19 +1482,6 @@ "application/json": { "schema": { "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "description": "The entity id to filter by" - } - }, - "required": [ - "entity_id" - ] - }, { "type": "object", "title": "Data model: Objects", @@ -1872,6 +1529,20 @@ "object_type", "object" ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "description": "The entity id to filter by" + } + }, + "required": [ + "entity_id" + ] } ] } @@ -1918,20 +1589,6 @@ "application/json": { "schema": { "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "example": "cfba6060-c43a-4a63-8a8c-501c6099f8b0", - "description": "The entity id to filter by" - } - }, - "required": [ - "entity_id" - ] - }, { "type": "object", "title": "Data model: Objects", @@ -1948,13 +1605,28 @@ }, "object": { "type": "string", - "example": "contact", - "description": "The object to filter by" + "example": "contact", + "description": "The object to filter by" + } + }, + "required": [ + "object_type", + "object" + ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "example": "cfba6060-c43a-4a63-8a8c-501c6099f8b0", + "description": "The entity id to filter by" } }, "required": [ - "object_type", - "object" + "entity_id" ] } ] @@ -2010,23 +1682,6 @@ "application/json": { "schema": { "oneOf": [ - { - "type": "object", - "title": "Data model: Entities", - "properties": { - "entity_id": { - "type": "string", - "description": "The entity id to filter by" - }, - "perform_full_refresh": { - "type": "boolean", - "example": true - } - }, - "required": [ - "entity_id" - ] - }, { "type": "object", "title": "Data model: Objects", @@ -2081,6 +1736,24 @@ "object_type", "object" ] + }, + { + "type": "object", + "title": "Data model: Entities", + "deprecated": true, + "properties": { + "entity_id": { + "type": "string", + "description": "The entity id to filter by" + }, + "perform_full_refresh": { + "type": "boolean", + "example": true + } + }, + "required": [ + "entity_id" + ] } ] } @@ -2183,6 +1856,7 @@ }, { "name": "entity_id", + "deprecated": true, "in": "query", "schema": { "type": "string", @@ -2206,7 +1880,7 @@ "type": "string", "example": ">2021-01-06T03:24:53.434326Z" }, - "description": "The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp." + "description": "The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp." }, { "name": "end_timestamp", @@ -2215,7 +1889,7 @@ "type": "string", "example": ">2021-01-06T03:24:53.434326Z" }, - "description": "The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp." + "description": "The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp." } ], "responses": { @@ -2372,6 +2046,33 @@ "customer_id" ] }, + "simple_customer": { + "type": "object", + "properties": { + "application_id": { + "type": "string", + "example": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69" + }, + "customer_id": { + "type": "string", + "example": "your-customers-unique-application-id" + }, + "name": { + "type": "string", + "example": "MyCompany Inc" + }, + "email": { + "type": "string", + "example": "contact@mycompany.com" + } + }, + "required": [ + "application_id", + "name", + "email", + "customer_id" + ] + }, "provider": { "type": "object", "properties": { @@ -2390,7 +2091,8 @@ "type": "string", "enum": [ "oauth2", - "api_key" + "api_key", + "access_key_secret" ], "example": "oauth2" }, @@ -2405,6 +2107,7 @@ }, "entity_mappings": { "type": "array", + "deprecated": true, "description": "This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.", "items": { "$ref": "#/components/schemas/provider_entity_mapping" @@ -2436,7 +2139,7 @@ "oneOf": [ { "type": "object", - "title": "supaglue", + "title": "postgres", "properties": { "id": { "type": "string", @@ -2446,27 +2149,39 @@ "type": "string", "example": "726fb798-d854-4c59-9a23-57e3e2f73eae" }, + "name": { + "type": "string", + "example": "My Postgres Destination" + }, "type": { "type": "string", "enum": [ - "supaglue" + "postgres" ], - "example": "supaglue" + "example": "postgres" + }, + "config": { + "$ref": "#/components/schemas/postgres_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ "id", "application_id", + "name", "type", + "config", "version" ] }, { "type": "object", - "title": "postgres", + "title": "supaglue", + "description": "A Supaglue-hosted Postgres database destination for Listing APIs.", "properties": { "id": { "type": "string", @@ -2476,30 +2191,23 @@ "type": "string", "example": "726fb798-d854-4c59-9a23-57e3e2f73eae" }, - "name": { - "type": "string", - "example": "My Postgres Destination" - }, "type": { "type": "string", "enum": [ - "postgres" + "supaglue" ], - "example": "postgres" - }, - "config": { - "$ref": "#/components/schemas/postgres_config_safe" + "example": "supaglue" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ "id", "application_id", - "name", "type", - "config", "version" ] }, @@ -2530,7 +2238,9 @@ "$ref": "#/components/schemas/bigquery_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ @@ -2569,7 +2279,9 @@ "$ref": "#/components/schemas/mongodb_config_safe" }, "version": { - "type": "number" + "type": "number", + "example": 1, + "description": "A monotonically increasing version number of the destination configuration" } }, "required": [ @@ -2885,6 +2597,7 @@ }, "schema": { "type": "object", + "deprecated": true, "properties": { "id": { "type": "string", @@ -2911,6 +2624,7 @@ }, "schema_config": { "type": "object", + "deprecated": true, "properties": { "fields": { "type": "array", @@ -2953,7 +2667,8 @@ }, "status": { "type": "string", - "example": "created" + "description": "`new` or `consumed`", + "example": "new" }, "application_id": { "type": "string", @@ -2983,7 +2698,8 @@ "expires_at": { "type": "string", "format": "date-time", - "example": "2023-02-23T00:00:00Z" + "example": "2023-02-23T00:00:00Z", + "description": "Any ISO formatted date-time string indicating when the magic link expires." } }, "required": [ @@ -3027,6 +2743,7 @@ }, "entity": { "type": "object", + "deprecated": true, "properties": { "id": { "type": "string", @@ -3053,6 +2770,7 @@ }, "entity_config": { "type": "object", + "deprecated": true, "properties": { "fields": { "type": "array", @@ -3262,6 +2980,7 @@ "schema_mappings_config": { "description": "This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).", "type": "object", + "deprecated": true, "properties": { "common_objects": { "type": "array", @@ -3313,10 +3032,14 @@ "entity_mappings": { "type": "array", "description": "This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).", + "deprecated": true, "items": { "$ref": "#/components/schemas/connection_entity_mapping" }, "example": [] + }, + "connection_sync_config": { + "$ref": "#/components/schemas/connection_sync_config" } }, "required": [ @@ -3438,6 +3161,7 @@ }, "entities": { "type": "array", + "deprecated": true, "items": { "type": "object", "properties": { @@ -3633,7 +3357,7 @@ "oneOf": [ { "type": "object", - "title": "Data model: Entities", + "title": "Data model: Objects", "properties": { "id": { "type": "string", @@ -3642,13 +3366,23 @@ "type": { "type": "string", "enum": [ - "entity" + "object" ], - "example": "entity" + "example": "object" }, - "entity_id": { + "object_type": { "type": "string", - "example": "94e6cb6c-0ec8-423f-8873-21054979a6b1" + "enum": [ + "common", + "standard", + "custom" + ], + "example": "standard" + }, + "object": { + "type": "string", + "example": "contact", + "description": "The Provider's object name (case sensitive)" }, "connection_id": { "type": "string", @@ -3666,7 +3400,8 @@ "required": [ "id", "type", - "entity_id", + "object_type", + "object", "connection_id", "sync_config_id", "paused" @@ -3674,7 +3409,7 @@ }, { "type": "object", - "title": "Data model: Objects", + "title": "Data model: Common Schema", "properties": { "id": { "type": "string", @@ -3690,16 +3425,14 @@ "object_type": { "type": "string", "enum": [ - "common", - "standard", - "custom" + "common" ], "example": "standard" }, "object": { "type": "string", "example": "contact", - "description": "The Provider's object name (case sensitive)" + "description": "Supaglue's object name" }, "connection_id": { "type": "string", @@ -3726,7 +3459,8 @@ }, { "type": "object", - "title": "Data model: Common Schema", + "title": "Data model: Entities", + "deprecated": true, "properties": { "id": { "type": "string", @@ -3735,21 +3469,13 @@ "type": { "type": "string", "enum": [ - "object" - ], - "example": "object" - }, - "object_type": { - "type": "string", - "enum": [ - "common" + "entity" ], - "example": "standard" + "example": "entity" }, - "object": { + "entity_id": { "type": "string", - "example": "contact", - "description": "Supaglue's object name" + "example": "94e6cb6c-0ec8-423f-8873-21054979a6b1" }, "connection_id": { "type": "string", @@ -3767,8 +3493,7 @@ "required": [ "id", "type", - "object_type", - "object", + "entity_id", "connection_id", "sync_config_id", "paused" @@ -3780,7 +3505,7 @@ "oneOf": [ { "type": "object", - "title": "Data model: Entities", + "title": "Data model: Objects", "properties": { "id": { "type": "string", @@ -3789,13 +3514,22 @@ "type": { "type": "string", "enum": [ - "entity" + "object" ], - "example": "entity" + "example": "object" }, - "entity_id": { + "object_type": { "type": "string", - "example": "70da3830-b717-49cb-91f0-22fb3f09a97a" + "enum": [ + "common", + "standard", + "custom" + ], + "example": "standard" + }, + "object": { + "type": "string", + "example": "contact" }, "connection_id": { "type": "string", @@ -3821,7 +3555,8 @@ "required": [ "id", "type", - "entity_id", + "object_type", + "object", "connection_id", "sync_config_id", "paused", @@ -3831,7 +3566,7 @@ }, { "type": "object", - "title": "Data model: Objects", + "title": "Data model: Entities", "properties": { "id": { "type": "string", @@ -3840,22 +3575,13 @@ "type": { "type": "string", "enum": [ - "object" - ], - "example": "object" - }, - "object_type": { - "type": "string", - "enum": [ - "common", - "standard", - "custom" + "entity" ], - "example": "standard" + "example": "entity" }, - "object": { + "entity_id": { "type": "string", - "example": "contact" + "example": "70da3830-b717-49cb-91f0-22fb3f09a97a" }, "connection_id": { "type": "string", @@ -3881,8 +3607,7 @@ "required": [ "id", "type", - "object_type", - "object", + "entity_id", "connection_id", "sync_config_id", "paused", @@ -3898,6 +3623,14 @@ "type": "object", "title": "Data model: Objects", "properties": { + "id": { + "type": "string", + "example": "20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9" + }, + "sync_id": { + "type": "string", + "example": "629525f8-f6f7-436c-80fa-1cb23acc5bf8" + }, "object_type": { "type": "string", "enum": [ @@ -3955,6 +3688,8 @@ } }, "required": [ + "id", + "sync_id", "object_type", "object", "start_timestamp", @@ -3972,9 +3707,19 @@ { "type": "object", "title": "Data model: Entities", + "deprecated": true, "properties": { + "id": { + "type": "string", + "example": "20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9" + }, + "sync_id": { + "type": "string", + "example": "629525f8-f6f7-436c-80fa-1cb23acc5bf8" + }, "entity_id": { - "type": "string" + "type": "string", + "deprecated": true }, "error_message": { "type": "string", @@ -4022,6 +3767,8 @@ } }, "required": [ + "id", + "sync_id", "entity_id", "start_timestamp", "end_timestamp", @@ -4308,22 +4055,6 @@ }, "create_destination": { "oneOf": [ - { - "type": "object", - "title": "postgres", - "properties": { - "type": { - "type": "string", - "enum": [ - "supaglue" - ], - "example": "supaglue" - } - }, - "required": [ - "type" - ] - }, { "type": "object", "title": "postgres", @@ -4349,6 +4080,23 @@ "config" ] }, + { + "type": "object", + "title": "supaglue", + "description": "A Supaglue-hosted Postgres database destination for Listing APIs.", + "properties": { + "type": { + "type": "string", + "enum": [ + "supaglue" + ], + "example": "supaglue" + } + }, + "required": [ + "type" + ] + }, { "type": "object", "title": "bigquery", @@ -4881,6 +4629,7 @@ }, "provider_entity_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_id": { "type": "string", @@ -4902,6 +4651,7 @@ }, "connection_entity_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_id": { "type": "string" @@ -4992,6 +4742,7 @@ }, "entity_field_mapping": { "type": "object", + "deprecated": true, "properties": { "entity_field": { "type": "string", diff --git a/openapi/v2/mgmt/openapi.yaml b/openapi/v2/mgmt/openapi.yaml index 03e0812f72..4a1a5faa18 100644 --- a/openapi/v2/mgmt/openapi.yaml +++ b/openapi/v2/mgmt/openapi.yaml @@ -31,10 +31,6 @@ paths: $ref: paths/customers.yaml '/customers/{customer_id}': $ref: paths/customers@{customer_id}.yaml - '/destinations': - $ref: paths/destinations.yaml - '/destinations/{destination_id}': - $ref: paths/destinations@{destination_id}.yaml '/magic_links': $ref: paths/magic_links.yaml '/magic_links/{magic_link_id}': @@ -55,10 +51,6 @@ paths: $ref: paths/entities.yaml '/entities/{entity_id}': $ref: paths/entities@{entity_id}.yaml - '/providers': - $ref: paths/providers.yaml - '/providers/{provider_id}': - $ref: paths/providers@{provider_id}.yaml '/sync_configs': $ref: paths/sync_configs.yaml '/sync_configs/{sync_config_id}': @@ -119,6 +111,8 @@ components: $ref: ../../common/components/schemas/pagination.yaml customer: $ref: ./components/schemas/objects/customer.yaml + simple_customer: + $ref: ./components/schemas/objects/simple_customer.yaml provider: $ref: ./components/schemas/objects/provider.yaml destination: diff --git a/openapi/v2/mgmt/paths/connections@{connection_id}.yaml b/openapi/v2/mgmt/paths/connections@{connection_id}.yaml index f1a2998517..53ac00ffdb 100644 --- a/openapi/v2/mgmt/paths/connections@{connection_id}.yaml +++ b/openapi/v2/mgmt/paths/connections@{connection_id}.yaml @@ -13,11 +13,6 @@ get: schema: allOf: - $ref: ../components/schemas/objects/connection.yaml - - type: object - properties: - user_id: - type: string - description: The id of the user associated with this connection. This is sometimes also known as the owner. delete: operationId: deleteConnection summary: Delete connection diff --git a/openapi/v2/mgmt/paths/customers.yaml b/openapi/v2/mgmt/paths/customers.yaml index 350cec9bef..6394948820 100644 --- a/openapi/v2/mgmt/paths/customers.yaml +++ b/openapi/v2/mgmt/paths/customers.yaml @@ -15,7 +15,7 @@ get: schema: type: array items: - $ref: ../components/schemas/objects/customer.yaml + $ref: ../components/schemas/objects/simple_customer.yaml put: operationId: upsertCustomer summary: Upsert customer diff --git a/openapi/v2/mgmt/paths/customers@{customer_id}.yaml b/openapi/v2/mgmt/paths/customers@{customer_id}.yaml index fc72ac3cf0..a099c9a9fd 100644 --- a/openapi/v2/mgmt/paths/customers@{customer_id}.yaml +++ b/openapi/v2/mgmt/paths/customers@{customer_id}.yaml @@ -11,14 +11,7 @@ get: content: application/json: schema: - $ref: ../components/schemas/objects/customer.yaml - examples: - Example: - value: - application_id: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 - name: MyCompany Inc - email: contact@mycompany.com - customer_id: your-customers-unique-application-id + $ref: ../components/schemas/objects/simple_customer.yaml delete: operationId: deleteCustomer summary: Delete customer @@ -32,14 +25,7 @@ delete: content: application/json: schema: - $ref: ../components/schemas/objects/customer.yaml - examples: - Example: - value: - application_id: d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 - name: MyCompany Inc - email: contact@mycompany.com - customer_id: your-customers-unique-application-id + $ref: ../components/schemas/objects/simple_customer.yaml parameters: - name: customer_id in: path diff --git a/openapi/v2/mgmt/paths/sync_runs.yaml b/openapi/v2/mgmt/paths/sync_runs.yaml index 09007f670e..8558a91ca2 100644 --- a/openapi/v2/mgmt/paths/sync_runs.yaml +++ b/openapi/v2/mgmt/paths/sync_runs.yaml @@ -48,6 +48,7 @@ get: example: account description: The object to filter by - name: entity_id + deprecated: true in: query schema: type: string @@ -64,13 +65,13 @@ get: schema: type: string example: '>2021-01-06T03:24:53.434326Z' - description: The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp. + description: The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp. - name: end_timestamp in: query schema: type: string example: '>2021-01-06T03:24:53.434326Z' - description: The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp. + description: The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp. responses: '200': description: SyncRun diff --git a/openapi/v2/mgmt/paths/syncs.yaml b/openapi/v2/mgmt/paths/syncs.yaml index c38821e3bb..7d6c295d44 100644 --- a/openapi/v2/mgmt/paths/syncs.yaml +++ b/openapi/v2/mgmt/paths/syncs.yaml @@ -49,6 +49,7 @@ get: example: contact description: The object to filter by - name: entity_id + deprecated: true in: query schema: type: string diff --git a/openapi/v2/mgmt/paths/syncs@_pause.yaml b/openapi/v2/mgmt/paths/syncs@_pause.yaml index cef2836916..1ebe5df622 100644 --- a/openapi/v2/mgmt/paths/syncs@_pause.yaml +++ b/openapi/v2/mgmt/paths/syncs@_pause.yaml @@ -11,14 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - description: The entity id to filter by - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -53,6 +45,15 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + description: The entity id to filter by + required: + - entity_id responses: '200': diff --git a/openapi/v2/mgmt/paths/syncs@_resume.yaml b/openapi/v2/mgmt/paths/syncs@_resume.yaml index a8b79124ca..5066fe139c 100644 --- a/openapi/v2/mgmt/paths/syncs@_resume.yaml +++ b/openapi/v2/mgmt/paths/syncs@_resume.yaml @@ -11,15 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - example: cfba6060-c43a-4a63-8a8c-501c6099f8b0 - description: The entity id to filter by - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -38,6 +29,16 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + example: cfba6060-c43a-4a63-8a8c-501c6099f8b0 + description: The entity id to filter by + required: + - entity_id responses: '200': description: Sync resumed diff --git a/openapi/v2/mgmt/paths/syncs@_trigger.yaml b/openapi/v2/mgmt/paths/syncs@_trigger.yaml index 927f3fa8a1..ace03a81d9 100644 --- a/openapi/v2/mgmt/paths/syncs@_trigger.yaml +++ b/openapi/v2/mgmt/paths/syncs@_trigger.yaml @@ -11,17 +11,6 @@ post: application/json: schema: oneOf: - - type: object - title: 'Data model: Entities' - properties: - entity_id: - type: string - description: The entity id to filter by - perform_full_refresh: - type: boolean - example: true - required: - - entity_id - type: object title: 'Data model: Objects' properties: @@ -61,6 +50,18 @@ post: required: - object_type - object + - type: object + title: 'Data model: Entities' + deprecated: true + properties: + entity_id: + type: string + description: The entity id to filter by + perform_full_refresh: + type: boolean + example: true + required: + - entity_id responses: '200': diff --git a/packages/schemas/gen/v2/mgmt.ts b/packages/schemas/gen/v2/mgmt.ts index 0a6e73584e..91a930c504 100644 --- a/packages/schemas/gen/v2/mgmt.ts +++ b/packages/schemas/gen/v2/mgmt.ts @@ -30,26 +30,6 @@ export interface paths { }; }; }; - "/destinations": { - /** - * List destinations - * @description Get a list of destinations - */ - get: operations["getDestinations"]; - /** Create destination */ - post: operations["createDestination"]; - }; - "/destinations/{destination_id}": { - /** Get destination */ - get: operations["getDestination"]; - /** Update destination */ - put: operations["updateDestination"]; - parameters: { - path: { - destination_id: string; - }; - }; - }; "/magic_links": { /** * List magic links @@ -198,28 +178,6 @@ export interface paths { }; }; }; - "/providers": { - /** - * List providers - * @description Get a list of providers - */ - get: operations["getProviders"]; - /** Create provider */ - post: operations["createProvider"]; - }; - "/providers/{provider_id}": { - /** Get provider */ - get: operations["getProvider"]; - /** Update provider */ - put: operations["updateProvider"]; - /** Delete provider */ - delete: operations["deleteProvider"]; - parameters: { - path: { - provider_id: string; - }; - }; - }; "/sync_configs": { /** * List Sync Configs @@ -439,6 +397,16 @@ export interface components { email: string; connections?: (components["schemas"]["connection"])[]; }; + simple_customer: { + /** @example d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 */ + application_id: string; + /** @example your-customers-unique-application-id */ + customer_id: string; + /** @example MyCompany Inc */ + name: string; + /** @example contact@mycompany.com */ + email: string; + }; provider: { /** @example 0c4cb91f-e392-46f5-8934-17496371f932 */ id: string; @@ -449,11 +417,14 @@ export interface components { * @example oauth2 * @enum {string} */ - auth_type: "oauth2" | "api_key"; + auth_type: "oauth2" | "api_key" | "access_key_secret"; name: components["schemas"]["provider_name"]; config?: components["schemas"]["create_provider_config"]; objects?: components["schemas"]["objects"]; - /** @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. */ + /** + * @deprecated + * @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers. + */ entity_mappings?: (components["schemas"]["provider_entity_mapping"])[]; }; /** @@ -476,25 +447,33 @@ export interface components { id: string; /** @example 726fb798-d854-4c59-9a23-57e3e2f73eae */ application_id: string; + /** @example My Postgres Destination */ + name: string; /** - * @example supaglue + * @example postgres * @enum {string} */ - type: "supaglue"; + type: "postgres"; + config: components["schemas"]["postgres_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example d455d20b-f6dc-4bc3-ab14-b4f21c4b4835 */ id: string; /** @example 726fb798-d854-4c59-9a23-57e3e2f73eae */ application_id: string; - /** @example My Postgres Destination */ - name: string; /** - * @example postgres + * @example supaglue * @enum {string} */ - type: "postgres"; - config: components["schemas"]["postgres_config_safe"]; + type: "supaglue"; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example e888cedf-e9d0-42c5-9485-2d72984faef2 */ @@ -509,6 +488,10 @@ export interface components { */ type: "bigquery"; config: components["schemas"]["bigquery_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }, { /** @example e888cedf-e9d0-42c5-9485-2d72984faef2 */ @@ -523,6 +506,10 @@ export interface components { */ type: "mongodb"; config: components["schemas"]["mongodb_config_safe"]; + /** + * @description A monotonically increasing version number of the destination configuration + * @example 1 + */ version: number; }]>; postgres_config_safe: { @@ -637,6 +624,7 @@ export interface components { /** @example mysensitivepassword */ password: string; }; + /** @deprecated */ schema: { /** @example 649b1e49-2722-46a3-a7e7-10caae78a43f */ id: string; @@ -646,6 +634,7 @@ export interface components { name: string; config: components["schemas"]["schema_config"]; }; + /** @deprecated */ schema_config: { fields: ({ /** @@ -668,7 +657,10 @@ export interface components { magic_link: { /** @example ec208408-db29-4705-b39e-4d33070b4ef6 */ id: string; - /** @example created */ + /** + * @description `new` or `consumed` + * @example new + */ status: string; /** @example d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69 */ application_id: string; @@ -689,6 +681,7 @@ export interface components { return_url: string; /** * Format: date-time + * @description Any ISO formatted date-time string indicating when the magic link expires. * @example 2023-02-23T00:00:00Z */ expires_at: Date; @@ -705,6 +698,7 @@ export interface components { /** @example 18000 */ expiration_secs: number; }; + /** @deprecated */ entity: { /** @example 649b1e49-2722-46a3-a7e7-10caae78a43f */ id: string; @@ -714,6 +708,7 @@ export interface components { name: string; config: components["schemas"]["entity_config"]; }; + /** @deprecated */ entity_config: { fields: ({ /** @example apolla_first_name */ @@ -792,7 +787,10 @@ export interface components { * @example https://app.hubspot.com/contacts/123456 */ instance_url: string; - /** @description This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). */ + /** + * @deprecated + * @description This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings). + */ schema_mappings_config?: { common_objects?: ({ /** @example Contact__c */ @@ -806,10 +804,12 @@ export interface components { })[]; }; /** + * @deprecated * @description This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping). * @example [] */ entity_mappings?: (components["schemas"]["connection_entity_mapping"])[]; + connection_sync_config?: components["schemas"]["connection_sync_config"]; }; /** * @example crm @@ -862,6 +862,7 @@ export interface components { */ object: string; })[]; + /** @deprecated */ entities?: ({ /** @example 3a82409f-c98f-4d25-bbd8-3335de3f12cc */ entity_id: string; @@ -940,22 +941,6 @@ export interface components { /** @enum {string} */ provider_name_no_category: "intercom" | "gong" | "linear"; sync: OneOf<[{ - /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ - id: string; - /** - * @example entity - * @enum {string} - */ - type: "entity"; - /** @example 94e6cb6c-0ec8-423f-8873-21054979a6b1 */ - entity_id: string; - /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ - connection_id: string; - /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e5 */ - sync_config_id: string; - /** @example false */ - paused: boolean; - }, { /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ id: string; /** @@ -1003,16 +988,15 @@ export interface components { sync_config_id: string; /** @example false */ paused: boolean; - }]>; - sync_with_provider_and_customer: OneOf<[{ - /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ + }, { + /** @example 7026e4e8-15d7-48d8-b997-f2592b654619 */ id: string; /** * @example entity * @enum {string} */ type: "entity"; - /** @example 70da3830-b717-49cb-91f0-22fb3f09a97a */ + /** @example 94e6cb6c-0ec8-423f-8873-21054979a6b1 */ entity_id: string; /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ connection_id: string; @@ -1020,11 +1004,8 @@ export interface components { sync_config_id: string; /** @example false */ paused: boolean; - /** @example hubspot */ - provider_name: string; - /** @example my-customer-1 */ - customer_id: string; - }, { + }]>; + sync_with_provider_and_customer: OneOf<[{ /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ id: string; /** @@ -1049,8 +1030,32 @@ export interface components { provider_name: string; /** @example my-customer-1 */ customer_id: string; + }, { + /** @example 971cb76d-9558-42fe-8f3b-8a531c32bd5f */ + id: string; + /** + * @example entity + * @enum {string} + */ + type: "entity"; + /** @example 70da3830-b717-49cb-91f0-22fb3f09a97a */ + entity_id: string; + /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e4 */ + connection_id: string; + /** @example 3217ea51-11c8-43c9-9547-6f197e02e5e5 */ + sync_config_id: string; + /** @example false */ + paused: boolean; + /** @example hubspot */ + provider_name: string; + /** @example my-customer-1 */ + customer_id: string; }]>; sync_run: OneOf<[{ + /** @example 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 */ + id: string; + /** @example 629525f8-f6f7-436c-80fa-1cb23acc5bf8 */ + sync_id: string; /** @enum {string} */ object_type: "common" | "standard" | "custom"; object: string; @@ -1072,6 +1077,11 @@ export interface components { /** @example 100 */ num_records_synced: number | null; }, { + /** @example 20eb4da3-6b38-4ec6-a82d-ecee59a9d6d9 */ + id: string; + /** @example 629525f8-f6f7-436c-80fa-1cb23acc5bf8 */ + sync_id: string; + /** @deprecated */ entity_id: string; error_message: string | null; /** @example 2023-02-22T19:55:17.559Z */ @@ -1161,12 +1171,6 @@ export interface components { config: components["schemas"]["entity_config"]; }; create_destination: OneOf<[{ - /** - * @example supaglue - * @enum {string} - */ - type: "supaglue"; - }, { /** @example My Postgres Destination */ name: string; /** @@ -1175,6 +1179,12 @@ export interface components { */ type: "postgres"; config: components["schemas"]["postgres_config_unsafe"]; + }, { + /** + * @example supaglue + * @enum {string} + */ + type: "supaglue"; }, { /** @example My BigQuery Destination */ name: string; @@ -1386,12 +1396,14 @@ export interface components { type: "standard" | "custom"; name: string; }; + /** @deprecated */ provider_entity_mapping: { /** @example apolla_contact */ entity_id: string; object?: components["schemas"]["standard_object"]; field_mappings?: (components["schemas"]["entity_field_mapping"])[]; }; + /** @deprecated */ connection_entity_mapping: { entity_id: string; object?: components["schemas"]["standard_or_custom_object"]; @@ -1413,6 +1425,7 @@ export interface components { is_additional: boolean; })[]; }; + /** @deprecated */ entity_field_mapping: { /** * @description The name of the field in your application. @@ -1547,7 +1560,7 @@ export interface operations { /** @description Customers */ 200: { content: { - "application/json": (components["schemas"]["customer"])[]; + "application/json": (components["schemas"]["simple_customer"])[]; }; }; }; @@ -1579,7 +1592,7 @@ export interface operations { /** @description Customer */ 200: { content: { - "application/json": components["schemas"]["customer"]; + "application/json": components["schemas"]["simple_customer"]; }; }; }; @@ -1595,74 +1608,7 @@ export interface operations { /** @description Customer */ 200: { content: { - "application/json": components["schemas"]["customer"]; - }; - }; - }; - }; - /** - * List destinations - * @description Get a list of destinations - */ - getDestinations: { - responses: { - /** @description Destinations */ - 200: { - content: { - "application/json": (components["schemas"]["destination"])[]; - }; - }; - }; - }; - /** Create destination */ - createDestination: { - requestBody: { - content: { - "application/json": components["schemas"]["create_destination"]; - }; - }; - responses: { - /** @description Destination created */ - 201: { - content: { - "application/json": components["schemas"]["destination"]; - }; - }; - }; - }; - /** Get destination */ - getDestination: { - parameters: { - path: { - destination_id: string; - }; - }; - responses: { - /** @description Destination */ - 200: { - content: { - "application/json": components["schemas"]["destination"]; - }; - }; - }; - }; - /** Update destination */ - updateDestination: { - parameters: { - path: { - destination_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["update_destination"]; - }; - }; - responses: { - /** @description Destination */ - 200: { - content: { - "application/json": components["schemas"]["destination"]; + "application/json": components["schemas"]["simple_customer"]; }; }; }; @@ -2009,89 +1955,6 @@ export interface operations { }; }; }; - /** - * List providers - * @description Get a list of providers - */ - getProviders: { - responses: { - /** @description Providers */ - 200: { - content: { - "application/json": (components["schemas"]["provider"])[]; - }; - }; - }; - }; - /** Create provider */ - createProvider: { - requestBody: { - content: { - "application/json": components["schemas"]["create_provider"]; - }; - }; - responses: { - /** @description Provider created */ - 201: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Get provider */ - getProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Update provider */ - updateProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - requestBody: { - content: { - "application/json": components["schemas"]["update_provider"]; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; - /** Delete provider */ - deleteProvider: { - parameters: { - path: { - provider_id: string; - }; - }; - responses: { - /** @description Provider */ - 200: { - content: { - "application/json": components["schemas"]["provider"]; - }; - }; - }; - }; /** * List Sync Configs * @description Get a list of Sync Configs @@ -2392,10 +2255,7 @@ export interface operations { /** @description Connection */ 200: { content: { - "application/json": components["schemas"]["connection"] & { - /** @description The id of the user associated with this connection. This is sometimes also known as the owner. */ - user_id?: string; - }; + "application/json": components["schemas"]["connection"]; }; }; }; @@ -2432,7 +2292,10 @@ export interface operations { object_type?: "common" | "standard" | "custom"; /** @description The object to filter by */ object?: string; - /** @description The entity id to filter by */ + /** + * @deprecated + * @description The entity id to filter by + */ entity_id?: string; }; }; @@ -2458,9 +2321,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** @description The entity id to filter by */ - entity_id: string; - }, { /** * @description The object type to filter by * @example standard @@ -2484,6 +2344,9 @@ export interface operations { * @example contact */ object: string; + }, { + /** @description The entity id to filter by */ + entity_id: string; }]>; }; }; @@ -2507,12 +2370,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** - * @description The entity id to filter by - * @example cfba6060-c43a-4a63-8a8c-501c6099f8b0 - */ - entity_id: string; - }, { /** * @description The object type to filter by * @example standard @@ -2524,6 +2381,12 @@ export interface operations { * @example contact */ object: string; + }, { + /** + * @description The entity id to filter by + * @example cfba6060-c43a-4a63-8a8c-501c6099f8b0 + */ + entity_id: string; }]>; }; }; @@ -2547,11 +2410,6 @@ export interface operations { requestBody: { content: { "application/json": OneOf<[{ - /** @description The entity id to filter by */ - entity_id: string; - /** @example true */ - perform_full_refresh?: boolean; - }, { /** * @description The object type to filter by * @example standard @@ -2579,6 +2437,11 @@ export interface operations { object: string; /** @example true */ perform_full_refresh?: boolean; + }, { + /** @description The entity id to filter by */ + entity_id: string; + /** @example true */ + perform_full_refresh?: boolean; }]>; }; }; @@ -2609,13 +2472,16 @@ export interface operations { object_type?: "common" | "standard" | "custom"; /** @description The object to filter by */ object?: string; - /** @description The entity id to filter by */ + /** + * @deprecated + * @description The entity id to filter by + */ entity_id?: string; /** @description The status to filter by (case-insensitive) */ status?: string; - /** @description The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp. */ + /** @description The start time to filter by. Should start with one of [`>`, `<`] followed by an ISO 8601 timestamp. */ start_timestamp?: string; - /** @description The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp. */ + /** @description The end time to filter by. Should start with [`>`, `<`] followed by an ISO 8601 timestamp. */ end_timestamp?: string; }; }; diff --git a/packages/types/magic_link.ts b/packages/types/magic_link.ts index f6074911d4..d0c6d006f4 100644 --- a/packages/types/magic_link.ts +++ b/packages/types/magic_link.ts @@ -15,7 +15,6 @@ export type MagicLink = { expiresAt: Date; url: string; returnUrl: string; - // TODO: Make enums status: string; };