From 13688c0026e3a21a675d701d1ff563e5f0b46233 Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Tue, 12 Nov 2024 18:04:55 -0500 Subject: [PATCH 1/8] feat(cli): Add endpoint tree-shaking --- .../generators-yml/definition/generators.yml | 6 ++ .../openapi/openapi-ir-parser/src/options.ts | 5 +- .../openapi/openapi-ir-parser/src/parse.ts | 7 ++- .../src/OpenApiIrConverterContext.ts | 62 ++++++++++++++++++- .../src/buildFernDefinition.ts | 26 +++++++- .../openapi-ir-to-fern/src/buildServices.ts | 8 ++- .../src/buildTypeReference.ts | 6 +- .../generators-yml/GeneratorsConfiguration.ts | 1 + .../convertGeneratorsConfiguration.ts | 19 +++++- .../types/ApiDefinitionSettingsSchema.ts | 2 + .../generators/types/OpenApiSettingsSchema.ts | 2 + .../types/ApiDefinitionSettingsSchema.ts | 2 + .../generators/types/OpenApiSettingsSchema.ts | 2 + .../lazy-fern-workspace/src/OSSWorkspace.ts | 11 +++- .../workspace-loader/src/loadAPIWorkspace.ts | 7 ++- .../workspace-loader/src/types/Workspace.ts | 1 + 16 files changed, 153 insertions(+), 14 deletions(-) diff --git a/fern/apis/generators-yml/definition/generators.yml b/fern/apis/generators-yml/definition/generators.yml index ed18a57e80e..0ce8f17badd 100644 --- a/fern/apis/generators-yml/definition/generators.yml +++ b/fern/apis/generators-yml/definition/generators.yml @@ -135,6 +135,9 @@ types: message-naming: type: optional docs: What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. + only-include-endpoint-referenced-schemas: + type: optional + docs: Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. UnionSettingsSchema: enum: @@ -222,6 +225,9 @@ types: respect-readonly-schemas: type: optional docs: Enables exploring readonly schemas in OpenAPI specifications + only-include-endpoint-referenced-schemas: + type: optional + docs: Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. OpenAPISpecSchema: properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts index 38ab1438a55..493484fe5c6 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts @@ -15,6 +15,8 @@ export interface ParseOpenAPIOptions { cooerceEnumsToLiterals: boolean; /* Whether or not to respect readonly properties in schemas */ respectReadonlySchemas: boolean; + /* Whether or not to only include endpoint referenced schemas */ + onlyIncludeEndpointReferencedSchemas: boolean; } export const DEFAULT_PARSE_OPENAPI_SETTINGS: ParseOpenAPIOptions = { @@ -24,5 +26,6 @@ export const DEFAULT_PARSE_OPENAPI_SETTINGS: ParseOpenAPIOptions = { audiences: undefined, optionalAdditionalProperties: true, cooerceEnumsToLiterals: true, - respectReadonlySchemas: false + respectReadonlySchemas: false, + onlyIncludeEndpointReferencedSchemas: false }; diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts index 3addc7a18d5..eab6e6df1f4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts @@ -30,6 +30,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; + onlyIncludeEndpointReferencedSchemas: boolean; } export type Source = AsyncAPISource | OpenAPISource | ProtobufSource; @@ -196,7 +197,11 @@ function getParseOptions({ respectReadonlySchemas: overrides?.respectReadonlySchemas ?? specSettings?.respectReadonlySchemas ?? - DEFAULT_PARSE_OPENAPI_SETTINGS.respectReadonlySchemas + DEFAULT_PARSE_OPENAPI_SETTINGS.respectReadonlySchemas, + onlyIncludeEndpointReferencedSchemas: + overrides?.onlyIncludeEndpointReferencedSchemas ?? + specSettings?.onlyIncludeEndpointReferencedSchemas ?? + DEFAULT_PARSE_OPENAPI_SETTINGS.onlyIncludeEndpointReferencedSchemas }; } diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts index 536a4092213..e4608d9d77b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts @@ -36,6 +36,11 @@ export interface OpenApiIrConverterContextOpts { * If true, the converter will respect readonly properties in OpenAPI schemas. */ respectReadonlySchemas: boolean; + + /** + * If true, the converter will only include schemas referenced by endpoints. + */ + onlyIncludeEndpointReferencedSchemas: boolean; } export class OpenApiIrConverterContext { @@ -49,15 +54,33 @@ export class OpenApiIrConverterContext { public detectGlobalHeaders: boolean; public objectQueryParameters: boolean; public respectReadonlySchemas: boolean; + public onlyIncludeEndpointReferencedSchemas: boolean; + private enableUniqueErrorsPerEndpoint: boolean; private defaultServerName: string | undefined = undefined; private unknownSchema: Set = new Set(); + + /** + * The set of referenced schema ids to include in the generated definition. + * If this value is undefined, _all_ schemaIds should be treated as referenced, + * and included in the generated definition. + */ + private referencedSchemaIds: Set | undefined; + + /** + * Whether the current schema being processed is part of an endpoint. + * This is used to determine whether certain properties should be included + * in the generated definition (e.g. endpoint tree-shaking). + */ + private inEndpoint = false; + /** * The current endpoint method being processed. This is used to determine * whether certain properties should be included in the generated definition * (e.g. readonly properties are excluded for POST/PUT endpoints). */ private endpointMethod: HttpMethod | undefined; + /** * Whether the current schema being processed is part of a request body. * This is used to determine whether certain properties should be included @@ -74,7 +97,8 @@ export class OpenApiIrConverterContext { globalHeaderOverrides, authOverrides, objectQueryParameters, - respectReadonlySchemas + respectReadonlySchemas, + onlyIncludeEndpointReferencedSchemas }: OpenApiIrConverterContextOpts) { this.logger = taskContext.logger; this.taskContext = taskContext; @@ -90,6 +114,8 @@ export class OpenApiIrConverterContext { this.globalHeaderOverrides = globalHeaderOverrides; this.objectQueryParameters = objectQueryParameters; this.respectReadonlySchemas = respectReadonlySchemas; + this.onlyIncludeEndpointReferencedSchemas = onlyIncludeEndpointReferencedSchemas; + this.referencedSchemaIds = onlyIncludeEndpointReferencedSchemas ? new Set() : undefined; const schemaByStatusCode: Record = {}; if (!this.enableUniqueErrorsPerEndpoint) { @@ -113,6 +139,19 @@ export class OpenApiIrConverterContext { } } + public markSchemaAsReferenced(id: SchemaId): void { + if (this.referencedSchemaIds != null) { + this.referencedSchemaIds.add(id); + } + } + + public getReferencedSchemaIds(): SchemaId[] | undefined { + if (this.referencedSchemaIds == null) { + return undefined; + } + return Array.from(this.referencedSchemaIds); + } + public getSchema(id: SchemaId, namespace: string | undefined): Schema | undefined { if (namespace == null) { return this.ir.groupedSchemas.rootSchemas[id]; @@ -163,6 +202,27 @@ export class OpenApiIrConverterContext { this.endpointMethod = undefined; } + /** + * Returns whether we're currently processing an endpoint + */ + public isInEndpoint(): boolean { + return this.inEndpoint; + } + + /** + * Sets that we're currently processing a request + */ + public setInEndpoint(): void { + this.inEndpoint = true; + } + + /** + * Unsets that we're currently processing a request + */ + public unsetInEndpoint(): void { + this.inEndpoint = false; + } + /** * Returns whether we're currently processing a request */ diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts index 7f3e07e03d6..578421a6b95 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts @@ -71,7 +71,11 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef if (context.ir.hasEndpointsMarkedInternal) { context.builder.addAudience(EXTERNAL_AUDIENCE); } - const { schemaIdsToExclude, sdkGroups } = buildServices(context); + + const convertedServices = buildServices(context); + const sdkGroups = convertedServices.sdkGroups; + let schemaIdsToExclude = convertedServices.schemaIdsToExclude; + buildWebhooks(context); // Add Channels @@ -80,6 +84,26 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef buildChannel({ channel, context, declarationFile }); } + const allSchemaIds = new Set(Object.keys(context.ir.groupedSchemas.rootSchemas)); + for (const schemas of Object.values(context.ir.groupedSchemas.namespacedSchemas)) { + for (const schemaId of Object.keys(schemas)) { + allSchemaIds.add(schemaId); + } + } + + const referencedSchemaIds = context.getReferencedSchemaIds(); + if (referencedSchemaIds != null) { + // If we're restricting to only referenced schemas, we need to + // exclude all schemas that aren't referenced. + const schemaIdsToExcludeSet = new Set(schemaIdsToExclude); + for (const schemaId of allSchemaIds) { + if (!referencedSchemaIds.includes(schemaId)) { + schemaIdsToExcludeSet.add(schemaId); + } + } + schemaIdsToExclude = Array.from(schemaIdsToExcludeSet); + } + // Add Schemas addSchemas({ schemas: context.ir.groupedSchemas.rootSchemas, schemaIdsToExclude, namespace: undefined, context }); for (const [namespace, schemas] of Object.entries(context.ir.groupedSchemas.namespacedSchemas)) { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts index a7de458b39d..e83ac054859 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts @@ -4,10 +4,12 @@ import { OpenApiIrConverterContext } from "./OpenApiIrConverterContext"; import { convertToSourceSchema } from "./utils/convertToSourceSchema"; import { getEndpointLocation } from "./utils/getEndpointLocation"; -export function buildServices(context: OpenApiIrConverterContext): { +export interface ConvertedServicesResponse { schemaIdsToExclude: string[]; sdkGroups: Set; -} { +} + +export function buildServices(context: OpenApiIrConverterContext): ConvertedServicesResponse { const sdkGroups = new Set(); const { endpoints, tags } = context.ir; let schemaIdsToExclude: string[] = []; @@ -33,6 +35,7 @@ export function buildServices(context: OpenApiIrConverterContext): { } const irTag = tag == null ? undefined : tags.tagsById[tag]; + context.setInEndpoint(); context.setEndpointMethod(endpoint.method); const convertedEndpoint = buildEndpoint({ context, @@ -40,6 +43,7 @@ export function buildServices(context: OpenApiIrConverterContext): { declarationFile: file }); context.unsetEndpointMethod(); + context.unsetInEndpoint(); schemaIdsToExclude = [...schemaIdsToExclude, ...convertedEndpoint.schemaIdsToExclude]; context.builder.addEndpoint(file, { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts index 583555d1706..7c9357026ed 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts @@ -401,11 +401,15 @@ export function buildReferenceTypeReference({ context: OpenApiIrConverterContext; namespace: string | undefined; }): RawSchemas.TypeReferenceSchema { - const resolvedSchema = context.getSchema(schema.schema, namespace); + if (context.onlyIncludeEndpointReferencedSchemas && context.isInEndpoint()) { + context.markSchemaAsReferenced(schema.schema); + } + const resolvedSchema = context.getSchema(schema.schema, namespace); if (resolvedSchema == null) { return "unknown"; } + const schemaName = getSchemaName(resolvedSchema) ?? schema.schema; const groupName = getGroupNameForSchema(resolvedSchema); const displayName = getDisplayName(resolvedSchema); diff --git a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts index d55378c12b1..4a1f08c2706 100644 --- a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts +++ b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts @@ -54,6 +54,7 @@ export interface APIDefinitionSettings { coerceEnumsToLiterals: boolean | undefined; objectQueryParameters: boolean | undefined; respectReadonlySchemas: boolean | undefined; + onlyIncludeEndpointReferencedSchemas: boolean | undefined; } export interface APIDefinitionLocation { diff --git a/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts index 5bf9aca1b19..f6220932cb9 100644 --- a/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts +++ b/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts @@ -95,6 +95,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: undefined, shouldUseUndiscriminatedUnionsWithLiterals: undefined, asyncApiMessageNaming: undefined, + onlyIncludeEndpointReferencedSchemas: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -119,7 +120,8 @@ async function parseAPIConfigurationToApiLocations( shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, - respectReadonlySchemas: undefined + respectReadonlySchemas: undefined, + onlyIncludeEndpointReferencedSchemas: undefined } }); } else if (Array.isArray(apiConfiguration)) { @@ -140,7 +142,8 @@ async function parseAPIConfigurationToApiLocations( shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, - respectReadonlySchemas: undefined + respectReadonlySchemas: undefined, + onlyIncludeEndpointReferencedSchemas: undefined } }); } else if (isRawProtobufAPIDefinitionSchema(definition)) { @@ -161,7 +164,8 @@ async function parseAPIConfigurationToApiLocations( shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, - respectReadonlySchemas: undefined + respectReadonlySchemas: undefined, + onlyIncludeEndpointReferencedSchemas: undefined } }); } else { @@ -177,6 +181,8 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: definition.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: definition.settings?.unions === "v1", asyncApiMessageNaming: definition.settings?.["message-naming"], + onlyIncludeEndpointReferencedSchemas: + definition.settings?.["only-include-endpoint-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -198,6 +204,8 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: apiConfiguration.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: apiConfiguration.settings?.unions === "v1", asyncApiMessageNaming: apiConfiguration.settings?.["message-naming"], + onlyIncludeEndpointReferencedSchemas: + apiConfiguration.settings?.["only-include-endpoint-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -223,6 +231,7 @@ async function parseAPIConfigurationToApiLocations( settings: { shouldUseTitleAsName: settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1", + onlyIncludeEndpointReferencedSchemas: settings?.["only-include-endpoint-referenced-schemas"], asyncApiMessageNaming: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, @@ -242,6 +251,8 @@ async function parseAPIConfigurationToApiLocations( settings: { shouldUseTitleAsName: openapi.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: openapi.settings?.unions === "v1", + onlyIncludeEndpointReferencedSchemas: + openapi.settings?.["only-include-endpoint-referenced-schemas"], asyncApiMessageNaming: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, @@ -264,6 +275,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1", asyncApiMessageNaming: settings?.["message-naming"], + onlyIncludeEndpointReferencedSchemas: settings?.["only-include-endpoint-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -330,6 +342,7 @@ async function parseApiConfigurationV2Schema({ shouldUseTitleAsName: spec.settings?.["title-as-schema-name"], shouldUseUndiscriminatedUnionsWithLiterals: undefined, asyncApiMessageNaming: undefined, + onlyIncludeEndpointReferencedSchemas: spec.settings?.["only-include-endpoint-referenced-schemas"], shouldUseOptionalAdditionalProperties: spec.settings?.["optional-additional-properties"] ?? true, coerceEnumsToLiterals: spec.settings?.["coerce-enums-to-literals"], objectQueryParameters: spec.settings?.["object-query-parameters"], diff --git a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts index 72dc970b8fd..8873a31ed70 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts @@ -11,4 +11,6 @@ export interface ApiDefinitionSettingsSchema { unions?: FernDefinition.UnionSettingsSchema; /** What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. */ "message-naming"?: FernDefinition.MessageNamingSettingsSchema; + /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */ + "only-include-endpoint-referenced-schemas"?: boolean; } diff --git a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts index 7d5af22eda0..5fef96390cd 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts @@ -10,4 +10,6 @@ export interface OpenApiSettingsSchema { "object-query-parameters"?: boolean; /** Enables exploring readonly schemas in OpenAPI specifications */ "respect-readonly-schemas"?: boolean; + /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */ + "only-include-endpoint-referenced-schemas"?: boolean; } diff --git a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts index 4577f0d81ea..2c82afae76b 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts @@ -15,6 +15,7 @@ export const ApiDefinitionSettingsSchema: core.serialization.ObjectSchema< "use-title": core.serialization.boolean().optional(), unions: UnionSettingsSchema.optional(), "message-naming": MessageNamingSettingsSchema.optional(), + "only-include-endpoint-referenced-schemas": core.serialization.boolean().optional(), }); export declare namespace ApiDefinitionSettingsSchema { @@ -22,5 +23,6 @@ export declare namespace ApiDefinitionSettingsSchema { "use-title"?: boolean | null; unions?: UnionSettingsSchema.Raw | null; "message-naming"?: MessageNamingSettingsSchema.Raw | null; + "only-include-endpoint-referenced-schemas"?: boolean | null; } } diff --git a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts index 9c7cb410cec..0b5c4b6d521 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts @@ -15,6 +15,7 @@ export const OpenApiSettingsSchema: core.serialization.ObjectSchema< "coerce-enums-to-literals": core.serialization.boolean().optional(), "object-query-parameters": core.serialization.boolean().optional(), "respect-readonly-schemas": core.serialization.boolean().optional(), + "only-include-endpoint-referenced-schemas": core.serialization.boolean().optional(), }); export declare namespace OpenApiSettingsSchema { @@ -24,5 +25,6 @@ export declare namespace OpenApiSettingsSchema { "coerce-enums-to-literals"?: boolean | null; "object-query-parameters"?: boolean | null; "respect-readonly-schemas"?: boolean | null; + "only-include-endpoint-referenced-schemas"?: boolean | null; } } diff --git a/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts b/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts index 14d7072fd97..56271e1bb07 100644 --- a/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts +++ b/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts @@ -66,6 +66,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; + onlyIncludeEndpointReferencedSchemas: boolean; } export declare namespace OSSWorkspace { @@ -113,12 +114,16 @@ export class OSSWorkspace extends AbstractAPIWorkspace { public sources: IdentifiableSource[]; private respectReadonlySchemas: boolean; + private onlyIncludeEndpointReferencedSchemas: boolean; constructor({ specs, ...superArgs }: OSSWorkspace.Args) { super(superArgs); this.specs = specs; this.sources = this.convertSpecsToIdentifiableSources(specs); this.respectReadonlySchemas = this.specs.every((spec) => spec.settings?.respectReadonlySchemas ?? false); + this.onlyIncludeEndpointReferencedSchemas = this.specs.every( + (spec) => spec.settings?.onlyIncludeEndpointReferencedSchemas ?? false + ); } public async getOpenAPIIr( @@ -139,7 +144,8 @@ export class OSSWorkspace extends AbstractAPIWorkspace { taskContext: context, optionOverrides: { ...optionOverrides, - respectReadonlySchemas: this.respectReadonlySchemas + respectReadonlySchemas: this.respectReadonlySchemas, + onlyIncludeEndpointReferencedSchemas: this.onlyIncludeEndpointReferencedSchemas } }); } @@ -176,7 +182,8 @@ export class OSSWorkspace extends AbstractAPIWorkspace { enableUniqueErrorsPerEndpoint: settings?.enableUniqueErrorsPerEndpoint ?? false, detectGlobalHeaders: settings?.detectGlobalHeaders ?? true, objectQueryParameters, - respectReadonlySchemas: this.respectReadonlySchemas + respectReadonlySchemas: this.respectReadonlySchemas, + onlyIncludeEndpointReferencedSchemas: this.onlyIncludeEndpointReferencedSchemas }); return { diff --git a/packages/cli/workspace-loader/src/loadAPIWorkspace.ts b/packages/cli/workspace-loader/src/loadAPIWorkspace.ts index e2e6358e349..e591d8ecded 100644 --- a/packages/cli/workspace-loader/src/loadAPIWorkspace.ts +++ b/packages/cli/workspace-loader/src/loadAPIWorkspace.ts @@ -72,7 +72,9 @@ export async function loadSingleNamespaceAPIWorkspace({ optionalAdditionalProperties: definition.settings?.shouldUseOptionalAdditionalProperties ?? true, cooerceEnumsToLiterals: definition.settings?.coerceEnumsToLiterals ?? true, objectQueryParameters: definition.settings?.objectQueryParameters ?? false, - respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false + respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false, + onlyIncludeEndpointReferencedSchemas: + definition.settings?.onlyIncludeEndpointReferencedSchemas ?? false } }); continue; @@ -115,7 +117,8 @@ export async function loadSingleNamespaceAPIWorkspace({ optionalAdditionalProperties: definition.settings?.shouldUseOptionalAdditionalProperties ?? true, cooerceEnumsToLiterals: definition.settings?.coerceEnumsToLiterals ?? true, objectQueryParameters: definition.settings?.objectQueryParameters ?? false, - respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false + respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false, + onlyIncludeEndpointReferencedSchemas: definition.settings?.onlyIncludeEndpointReferencedSchemas ?? false }, source: { type: "openapi", diff --git a/packages/cli/workspace-loader/src/types/Workspace.ts b/packages/cli/workspace-loader/src/types/Workspace.ts index 115bb6725f7..c2d6f2cc35f 100644 --- a/packages/cli/workspace-loader/src/types/Workspace.ts +++ b/packages/cli/workspace-loader/src/types/Workspace.ts @@ -68,6 +68,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; + onlyIncludeEndpointReferencedSchemas: boolean; } export interface OpenAPIFile { From e4c4ca28ca3082653669ee791a3fb623b5487715 Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Tue, 12 Nov 2024 18:12:13 -0500 Subject: [PATCH 2/8] Update to 'only-include-referenced-schemas' --- .../generators-yml/definition/generators.yml | 4 ++-- .../openapi/openapi-ir-parser/src/options.ts | 4 ++-- .../openapi/openapi-ir-parser/src/parse.ts | 10 ++++---- .../src/OpenApiIrConverterContext.ts | 10 ++++---- .../src/buildTypeReference.ts | 2 +- .../generators-yml/GeneratorsConfiguration.ts | 2 +- .../convertGeneratorsConfiguration.ts | 23 ++++++++----------- .../types/ApiDefinitionSettingsSchema.ts | 2 +- .../generators/types/OpenApiSettingsSchema.ts | 2 +- .../types/ApiDefinitionSettingsSchema.ts | 4 ++-- .../generators/types/OpenApiSettingsSchema.ts | 4 ++-- .../lazy-fern-workspace/src/OSSWorkspace.ts | 12 +++++----- .../workspace-loader/src/loadAPIWorkspace.ts | 5 ++-- .../workspace-loader/src/types/Workspace.ts | 2 +- 14 files changed, 41 insertions(+), 45 deletions(-) diff --git a/fern/apis/generators-yml/definition/generators.yml b/fern/apis/generators-yml/definition/generators.yml index 0ce8f17badd..72be46b1c56 100644 --- a/fern/apis/generators-yml/definition/generators.yml +++ b/fern/apis/generators-yml/definition/generators.yml @@ -135,7 +135,7 @@ types: message-naming: type: optional docs: What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. - only-include-endpoint-referenced-schemas: + only-include-referenced-schemas: type: optional docs: Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. @@ -225,7 +225,7 @@ types: respect-readonly-schemas: type: optional docs: Enables exploring readonly schemas in OpenAPI specifications - only-include-endpoint-referenced-schemas: + only-include-referenced-schemas: type: optional docs: Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts index 493484fe5c6..6dcbbe99103 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/options.ts @@ -16,7 +16,7 @@ export interface ParseOpenAPIOptions { /* Whether or not to respect readonly properties in schemas */ respectReadonlySchemas: boolean; /* Whether or not to only include endpoint referenced schemas */ - onlyIncludeEndpointReferencedSchemas: boolean; + onlyIncludeReferencedSchemas: boolean; } export const DEFAULT_PARSE_OPENAPI_SETTINGS: ParseOpenAPIOptions = { @@ -27,5 +27,5 @@ export const DEFAULT_PARSE_OPENAPI_SETTINGS: ParseOpenAPIOptions = { optionalAdditionalProperties: true, cooerceEnumsToLiterals: true, respectReadonlySchemas: false, - onlyIncludeEndpointReferencedSchemas: false + onlyIncludeReferencedSchemas: false }; diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts index eab6e6df1f4..a0849279306 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/parse.ts @@ -30,7 +30,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; - onlyIncludeEndpointReferencedSchemas: boolean; + onlyIncludeReferencedSchemas: boolean; } export type Source = AsyncAPISource | OpenAPISource | ProtobufSource; @@ -198,10 +198,10 @@ function getParseOptions({ overrides?.respectReadonlySchemas ?? specSettings?.respectReadonlySchemas ?? DEFAULT_PARSE_OPENAPI_SETTINGS.respectReadonlySchemas, - onlyIncludeEndpointReferencedSchemas: - overrides?.onlyIncludeEndpointReferencedSchemas ?? - specSettings?.onlyIncludeEndpointReferencedSchemas ?? - DEFAULT_PARSE_OPENAPI_SETTINGS.onlyIncludeEndpointReferencedSchemas + onlyIncludeReferencedSchemas: + overrides?.onlyIncludeReferencedSchemas ?? + specSettings?.onlyIncludeReferencedSchemas ?? + DEFAULT_PARSE_OPENAPI_SETTINGS.onlyIncludeReferencedSchemas }; } diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts index e4608d9d77b..d39acbf2545 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts @@ -40,7 +40,7 @@ export interface OpenApiIrConverterContextOpts { /** * If true, the converter will only include schemas referenced by endpoints. */ - onlyIncludeEndpointReferencedSchemas: boolean; + onlyIncludeReferencedSchemas: boolean; } export class OpenApiIrConverterContext { @@ -54,7 +54,7 @@ export class OpenApiIrConverterContext { public detectGlobalHeaders: boolean; public objectQueryParameters: boolean; public respectReadonlySchemas: boolean; - public onlyIncludeEndpointReferencedSchemas: boolean; + public onlyIncludeReferencedSchemas: boolean; private enableUniqueErrorsPerEndpoint: boolean; private defaultServerName: string | undefined = undefined; @@ -98,7 +98,7 @@ export class OpenApiIrConverterContext { authOverrides, objectQueryParameters, respectReadonlySchemas, - onlyIncludeEndpointReferencedSchemas + onlyIncludeReferencedSchemas }: OpenApiIrConverterContextOpts) { this.logger = taskContext.logger; this.taskContext = taskContext; @@ -114,8 +114,8 @@ export class OpenApiIrConverterContext { this.globalHeaderOverrides = globalHeaderOverrides; this.objectQueryParameters = objectQueryParameters; this.respectReadonlySchemas = respectReadonlySchemas; - this.onlyIncludeEndpointReferencedSchemas = onlyIncludeEndpointReferencedSchemas; - this.referencedSchemaIds = onlyIncludeEndpointReferencedSchemas ? new Set() : undefined; + this.onlyIncludeReferencedSchemas = onlyIncludeReferencedSchemas; + this.referencedSchemaIds = onlyIncludeReferencedSchemas ? new Set() : undefined; const schemaByStatusCode: Record = {}; if (!this.enableUniqueErrorsPerEndpoint) { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts index 7c9357026ed..ca5804a2bdb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts @@ -401,7 +401,7 @@ export function buildReferenceTypeReference({ context: OpenApiIrConverterContext; namespace: string | undefined; }): RawSchemas.TypeReferenceSchema { - if (context.onlyIncludeEndpointReferencedSchemas && context.isInEndpoint()) { + if (context.onlyIncludeReferencedSchemas && context.isInEndpoint()) { context.markSchemaAsReferenced(schema.schema); } diff --git a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts index 4a1f08c2706..e13d2db0a6d 100644 --- a/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts +++ b/packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts @@ -54,7 +54,7 @@ export interface APIDefinitionSettings { coerceEnumsToLiterals: boolean | undefined; objectQueryParameters: boolean | undefined; respectReadonlySchemas: boolean | undefined; - onlyIncludeEndpointReferencedSchemas: boolean | undefined; + onlyIncludeReferencedSchemas: boolean | undefined; } export interface APIDefinitionLocation { diff --git a/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts b/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts index f6220932cb9..fc3e59bbc13 100644 --- a/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts +++ b/packages/cli/configuration/src/generators-yml/convertGeneratorsConfiguration.ts @@ -95,7 +95,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: undefined, shouldUseUndiscriminatedUnionsWithLiterals: undefined, asyncApiMessageNaming: undefined, - onlyIncludeEndpointReferencedSchemas: undefined, + onlyIncludeReferencedSchemas: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -121,7 +121,7 @@ async function parseAPIConfigurationToApiLocations( coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, respectReadonlySchemas: undefined, - onlyIncludeEndpointReferencedSchemas: undefined + onlyIncludeReferencedSchemas: undefined } }); } else if (Array.isArray(apiConfiguration)) { @@ -143,7 +143,7 @@ async function parseAPIConfigurationToApiLocations( coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, respectReadonlySchemas: undefined, - onlyIncludeEndpointReferencedSchemas: undefined + onlyIncludeReferencedSchemas: undefined } }); } else if (isRawProtobufAPIDefinitionSchema(definition)) { @@ -165,7 +165,7 @@ async function parseAPIConfigurationToApiLocations( coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, respectReadonlySchemas: undefined, - onlyIncludeEndpointReferencedSchemas: undefined + onlyIncludeReferencedSchemas: undefined } }); } else { @@ -181,8 +181,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: definition.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: definition.settings?.unions === "v1", asyncApiMessageNaming: definition.settings?.["message-naming"], - onlyIncludeEndpointReferencedSchemas: - definition.settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: definition.settings?.["only-include-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -204,8 +203,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: apiConfiguration.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: apiConfiguration.settings?.unions === "v1", asyncApiMessageNaming: apiConfiguration.settings?.["message-naming"], - onlyIncludeEndpointReferencedSchemas: - apiConfiguration.settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: apiConfiguration.settings?.["only-include-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -231,7 +229,7 @@ async function parseAPIConfigurationToApiLocations( settings: { shouldUseTitleAsName: settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1", - onlyIncludeEndpointReferencedSchemas: settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: settings?.["only-include-referenced-schemas"], asyncApiMessageNaming: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, @@ -251,8 +249,7 @@ async function parseAPIConfigurationToApiLocations( settings: { shouldUseTitleAsName: openapi.settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: openapi.settings?.unions === "v1", - onlyIncludeEndpointReferencedSchemas: - openapi.settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: openapi.settings?.["only-include-referenced-schemas"], asyncApiMessageNaming: undefined, shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, @@ -275,7 +272,7 @@ async function parseAPIConfigurationToApiLocations( shouldUseTitleAsName: settings?.["use-title"], shouldUseUndiscriminatedUnionsWithLiterals: settings?.unions === "v1", asyncApiMessageNaming: settings?.["message-naming"], - onlyIncludeEndpointReferencedSchemas: settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: settings?.["only-include-referenced-schemas"], shouldUseOptionalAdditionalProperties: undefined, coerceEnumsToLiterals: undefined, objectQueryParameters: undefined, @@ -342,7 +339,7 @@ async function parseApiConfigurationV2Schema({ shouldUseTitleAsName: spec.settings?.["title-as-schema-name"], shouldUseUndiscriminatedUnionsWithLiterals: undefined, asyncApiMessageNaming: undefined, - onlyIncludeEndpointReferencedSchemas: spec.settings?.["only-include-endpoint-referenced-schemas"], + onlyIncludeReferencedSchemas: spec.settings?.["only-include-referenced-schemas"], shouldUseOptionalAdditionalProperties: spec.settings?.["optional-additional-properties"] ?? true, coerceEnumsToLiterals: spec.settings?.["coerce-enums-to-literals"], objectQueryParameters: spec.settings?.["object-query-parameters"], diff --git a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts index 8873a31ed70..2e7a9e127e1 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/ApiDefinitionSettingsSchema.ts @@ -12,5 +12,5 @@ export interface ApiDefinitionSettingsSchema { /** What version of message naming to use for AsyncAPI messages, this will grow over time. Defaults to v1. */ "message-naming"?: FernDefinition.MessageNamingSettingsSchema; /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */ - "only-include-endpoint-referenced-schemas"?: boolean; + "only-include-referenced-schemas"?: boolean; } diff --git a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts index 5fef96390cd..3d95f1573fb 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/api/resources/generators/types/OpenApiSettingsSchema.ts @@ -11,5 +11,5 @@ export interface OpenApiSettingsSchema { /** Enables exploring readonly schemas in OpenAPI specifications */ "respect-readonly-schemas"?: boolean; /** Whether to only include schemas referenced by endpoints in the generated SDK (i.e. a form of tree-shaking). Defaults to false. */ - "only-include-endpoint-referenced-schemas"?: boolean; + "only-include-referenced-schemas"?: boolean; } diff --git a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts index 2c82afae76b..455aa590a07 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/ApiDefinitionSettingsSchema.ts @@ -15,7 +15,7 @@ export const ApiDefinitionSettingsSchema: core.serialization.ObjectSchema< "use-title": core.serialization.boolean().optional(), unions: UnionSettingsSchema.optional(), "message-naming": MessageNamingSettingsSchema.optional(), - "only-include-endpoint-referenced-schemas": core.serialization.boolean().optional(), + "only-include-referenced-schemas": core.serialization.boolean().optional(), }); export declare namespace ApiDefinitionSettingsSchema { @@ -23,6 +23,6 @@ export declare namespace ApiDefinitionSettingsSchema { "use-title"?: boolean | null; unions?: UnionSettingsSchema.Raw | null; "message-naming"?: MessageNamingSettingsSchema.Raw | null; - "only-include-endpoint-referenced-schemas"?: boolean | null; + "only-include-referenced-schemas"?: boolean | null; } } diff --git a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts index 0b5c4b6d521..6d8e002039f 100644 --- a/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts +++ b/packages/cli/configuration/src/generators-yml/schemas/serialization/resources/generators/types/OpenApiSettingsSchema.ts @@ -15,7 +15,7 @@ export const OpenApiSettingsSchema: core.serialization.ObjectSchema< "coerce-enums-to-literals": core.serialization.boolean().optional(), "object-query-parameters": core.serialization.boolean().optional(), "respect-readonly-schemas": core.serialization.boolean().optional(), - "only-include-endpoint-referenced-schemas": core.serialization.boolean().optional(), + "only-include-referenced-schemas": core.serialization.boolean().optional(), }); export declare namespace OpenApiSettingsSchema { @@ -25,6 +25,6 @@ export declare namespace OpenApiSettingsSchema { "coerce-enums-to-literals"?: boolean | null; "object-query-parameters"?: boolean | null; "respect-readonly-schemas"?: boolean | null; - "only-include-endpoint-referenced-schemas"?: boolean | null; + "only-include-referenced-schemas"?: boolean | null; } } diff --git a/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts b/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts index 56271e1bb07..e1e110ddf26 100644 --- a/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts +++ b/packages/cli/lazy-fern-workspace/src/OSSWorkspace.ts @@ -66,7 +66,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; - onlyIncludeEndpointReferencedSchemas: boolean; + onlyIncludeReferencedSchemas: boolean; } export declare namespace OSSWorkspace { @@ -114,15 +114,15 @@ export class OSSWorkspace extends AbstractAPIWorkspace { public sources: IdentifiableSource[]; private respectReadonlySchemas: boolean; - private onlyIncludeEndpointReferencedSchemas: boolean; + private onlyIncludeReferencedSchemas: boolean; constructor({ specs, ...superArgs }: OSSWorkspace.Args) { super(superArgs); this.specs = specs; this.sources = this.convertSpecsToIdentifiableSources(specs); this.respectReadonlySchemas = this.specs.every((spec) => spec.settings?.respectReadonlySchemas ?? false); - this.onlyIncludeEndpointReferencedSchemas = this.specs.every( - (spec) => spec.settings?.onlyIncludeEndpointReferencedSchemas ?? false + this.onlyIncludeReferencedSchemas = this.specs.every( + (spec) => spec.settings?.onlyIncludeReferencedSchemas ?? false ); } @@ -145,7 +145,7 @@ export class OSSWorkspace extends AbstractAPIWorkspace { optionOverrides: { ...optionOverrides, respectReadonlySchemas: this.respectReadonlySchemas, - onlyIncludeEndpointReferencedSchemas: this.onlyIncludeEndpointReferencedSchemas + onlyIncludeReferencedSchemas: this.onlyIncludeReferencedSchemas } }); } @@ -183,7 +183,7 @@ export class OSSWorkspace extends AbstractAPIWorkspace { detectGlobalHeaders: settings?.detectGlobalHeaders ?? true, objectQueryParameters, respectReadonlySchemas: this.respectReadonlySchemas, - onlyIncludeEndpointReferencedSchemas: this.onlyIncludeEndpointReferencedSchemas + onlyIncludeReferencedSchemas: this.onlyIncludeReferencedSchemas }); return { diff --git a/packages/cli/workspace-loader/src/loadAPIWorkspace.ts b/packages/cli/workspace-loader/src/loadAPIWorkspace.ts index e591d8ecded..410baab85d5 100644 --- a/packages/cli/workspace-loader/src/loadAPIWorkspace.ts +++ b/packages/cli/workspace-loader/src/loadAPIWorkspace.ts @@ -73,8 +73,7 @@ export async function loadSingleNamespaceAPIWorkspace({ cooerceEnumsToLiterals: definition.settings?.coerceEnumsToLiterals ?? true, objectQueryParameters: definition.settings?.objectQueryParameters ?? false, respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false, - onlyIncludeEndpointReferencedSchemas: - definition.settings?.onlyIncludeEndpointReferencedSchemas ?? false + onlyIncludeReferencedSchemas: definition.settings?.onlyIncludeReferencedSchemas ?? false } }); continue; @@ -118,7 +117,7 @@ export async function loadSingleNamespaceAPIWorkspace({ cooerceEnumsToLiterals: definition.settings?.coerceEnumsToLiterals ?? true, objectQueryParameters: definition.settings?.objectQueryParameters ?? false, respectReadonlySchemas: definition.settings?.respectReadonlySchemas ?? false, - onlyIncludeEndpointReferencedSchemas: definition.settings?.onlyIncludeEndpointReferencedSchemas ?? false + onlyIncludeReferencedSchemas: definition.settings?.onlyIncludeReferencedSchemas ?? false }, source: { type: "openapi", diff --git a/packages/cli/workspace-loader/src/types/Workspace.ts b/packages/cli/workspace-loader/src/types/Workspace.ts index c2d6f2cc35f..f373035862f 100644 --- a/packages/cli/workspace-loader/src/types/Workspace.ts +++ b/packages/cli/workspace-loader/src/types/Workspace.ts @@ -68,7 +68,7 @@ export interface SpecImportSettings { cooerceEnumsToLiterals: boolean; objectQueryParameters: boolean; respectReadonlySchemas: boolean; - onlyIncludeEndpointReferencedSchemas: boolean; + onlyIncludeReferencedSchemas: boolean; } export interface OpenAPIFile { From 8707aa1947eea149324ceef477bd6e2ffd62ba7a Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Tue, 12 Nov 2024 18:21:26 -0500 Subject: [PATCH 3/8] Add only-include-referenced-schemas test definition --- .../only-include-referenced-schemas.json | 50538 ++++++ .../only-include-referenced-schemas.json | 134685 +++++++++++++++ .../only-include-referenced-schemas.json | 48486 ++++++ .../fern/fern.config.json | 4 + .../fern/generators.yml | 3 + .../openapi.yml | 17297 ++ 6 files changed, 251013 insertions(+) create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/only-include-referenced-schemas.json create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/fern.config.json create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/openapi.yml diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json new file mode 100644 index 00000000000..1c760a22c7e --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json @@ -0,0 +1,50538 @@ +{ + "absoluteFilePath": "/DUMMY_PATH", + "importedDefinitions": {}, + "namedDefinitionFiles": { + "__package__.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "errors": { + "AttachContactToACompanyRequestBadRequestError": { + "docs": "Bad Request", + "examples": [ + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "company not specified", + }, + ], + "request_id": "9297dcfc-1896-43a3-a3f9-131238422ed2", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "AttachContactToACompanyRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "32d121d8-fcbf-4c59-9c60-204f7d602f36", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachContactToACompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "99739bbd-2dbe-4ce3-ae91-af23379b5cd7", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AttachContactToConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "3d1c3371-6ba4-4d5a-9368-ac983292136d", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "AttachContactToConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "1fd64942-5bf0-4a51-a6cb-db4a778bb1f4", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachContactToConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4f00c4c6-a8f7-436e-bf95-d1adfa315906", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AttachSubscriptionTypeToContactRequestNotFoundError": { + "docs": "Resource not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "cf0f6fd6-7c5e-492b-909d-f60b35eea1c4", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "3f852f45-1a80-4ade-9bc6-72b377d2bbd8", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachSubscriptionTypeToContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "377d162e-82a5-4148-a26f-29c9c760dadc", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AttachTagToContactRequestNotFoundError": { + "docs": "Tag not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "1bbd7e4b-718e-46f4-b682-a429aea78f01", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a1a28017-728a-423b-adc0-2705d375f533", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachTagToContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "63a2828f-107e-4d51-9398-a220b81a7bce", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AttachTagToConversationRequestNotFoundError": { + "docs": "Conversation not found", + "examples": [ + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Conversation not found", + }, + ], + "request_id": "840d35aa-2414-402a-b3c6-763a410e0d16", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachTagToConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "95cacea0-4744-4de8-a2bf-da4419f75732", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AttachTagToTicketRequestNotFoundError": { + "docs": "Ticket not found", + "examples": [ + { + "docs": undefined, + "name": "Ticket not found", + "value": { + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found", + }, + ], + "request_id": "e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AttachTagToTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "a502f48f-c80d-48fd-bea5-cafe7e24d9f9", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "AutoAssignConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "037980c4-84cb-4d3a-ad64-66e4e563a275", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "AutoAssignConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "9d88a5a7-6df9-42ff-b324-2387db7be984", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "AutoAssignConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ConvertConversationToTicketRequestBadRequestError": { + "docs": "Bad request", + "examples": [ + { + "docs": undefined, + "name": "Bad request", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Ticket type is not a customer ticket type", + }, + ], + "request_id": "74656c1a-0a17-4c80-a7b9-66fa45c6d71b", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "ConvertVisitorRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "fe1a587a-e682-4a96-bd30-ea08b726e6fa", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateArticleRequestBadRequestError": { + "docs": "Bad Request", + "examples": [ + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "author_id must be in the main body or default locale translated_content object", + }, + ], + "request_id": "e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateArticleRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f223a1d9-5377-4337-92bb-00fb39157f11", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateCollectionRequestBadRequestError": { + "docs": "Bad Request", + "examples": [ + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "Name is a required parameter.", + }, + ], + "request_id": "1f4fd741-8681-4c21-911a-47d7bb39d080", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateCollectionRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c18ca0d4-ad2c-41e7-9a71-1df806f9c954", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "c7a35217-6720-48bd-a2ae-c2acb5adea30", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "CreateConversationRequestNotFoundError": { + "docs": "Contact Not Found", + "examples": [ + { + "docs": undefined, + "name": "Contact Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "ed0ab0c5-57b8-4413-a7a9-bbc134b40876", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "CreateConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "af9757fc-4e1d-463c-ac9d-788503f04a95", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateDataAttributeRequestBadRequestError": { + "docs": "Too few options for list", + "examples": [ + { + "docs": undefined, + "name": "Same name already exists", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name.", + }, + ], + "request_id": "bcd93885-3f01-4b92-9918-c96a3f4492e8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Invalid name", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens", + }, + ], + "request_id": "7420c5e3-22c3-46be-8a23-72fef8f8ec0e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Attribute already exists", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name.", + }, + ], + "request_id": "c844551a-05d3-4f8c-931a-32e96bf3a508", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Invalid Data Type", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Data Type isn't an option", + }, + ], + "request_id": "b8c58b81-8445-473d-8fe3-7880c04f9547", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Too few options for list", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "The Data Attribute model field must be either contact or company", + }, + ], + "request_id": "119e3822-3a45-48cf-b5ab-037f27a948c8", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateDataAttributeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b74d8980-6e99-44db-a3d8-2a65a63fe590", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateDataEventRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c6b3dcbd-33be-4a80-abb4-c5b3315250d0", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateMessageRequestBadRequestError": { + "docs": "No body supplied for email message", + "examples": [ + { + "docs": undefined, + "name": "No body supplied for message", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required", + }, + ], + "request_id": "4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "No body supplied for email message", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required", + }, + ], + "request_id": "7d54191b-c0fc-4860-a01c-9da6b4e45b7f", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateMessageRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "fab7034a-78bd-4413-a652-8f38783e7bf1", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "CreateMessageRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ee3ea56e-d0ce-47db-871a-57740e165e5c", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateMessageRequestUnprocessableEntityError": { + "docs": "No subject supplied for email message", + "examples": [ + { + "docs": undefined, + "name": "No subject supplied for email message", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "No subject supplied for email message", + }, + ], + "request_id": "f54ba906-3255-4fc6-a660-0dab0043ff2b", + "type": "error.list", + }, + }, + ], + "status-code": 422, + "type": "Error", + }, + "CreateNewsItemRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c36202f1-6bf3-4ea6-9442-192123f506b0", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateNoteRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "d7c69ce6-3195-46be-b2cb-0dce355d2919", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "CreateOrUpdateCompanyRequestBadRequestError": { + "docs": "Bad Request", + "examples": [ + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "bad_request", + "message": "bad 'test' parameter", + }, + ], + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateOrUpdateCompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "9b0d6fb9-d2d7-4904-a13c-97557a802323", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreatePhoneSwitchRequestBadRequestError": { + "docs": "bad request - invalid number", + "examples": [ + { + "docs": undefined, + "name": "bad request - exception sending sms", + "value": { + "error_key": "sms_failed", + "message": "SMS was not sent due to an unknown error", + }, + }, + { + "docs": undefined, + "name": "bad request - invalid number", + "value": { + "error_key": "invalid_phone_number", + "message": "Invalid phone number", + }, + }, + ], + "status-code": 400, + "type": "unknown", + }, + "CreatePhoneSwitchRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "5da7a3e7-dcb0-4378-8575-0a0e9bae3862", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreatePhoneSwitchRequestUnprocessableEntityError": { + "docs": "unprocessable entity", + "examples": [ + { + "docs": undefined, + "name": "unprocessable entity", + "value": { + "error_key": "some_error", + }, + }, + ], + "status-code": 422, + "type": "unknown", + }, + "CreateTagRequestBadRequestError": { + "docs": "Invalid parameters", + "examples": [ + { + "docs": undefined, + "name": "Invalid parameters", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "invalid tag parameters", + }, + ], + "request_id": "a7afe3c5-be52-4b69-9268-50ef1d917a1b", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "CreateTagRequestNotFoundError": { + "docs": "User not found", + "examples": [ + { + "docs": undefined, + "name": "Company not found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "f0f84d9b-3c51-4904-9c21-34faba76ebf5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "User not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "786848c6-5b9f-4e9b-aa78-2bdec45a09f5", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "CreateTagRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3609e8b1-a6aa-4c57-a994-3d95743f20a2", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "745c921a-7c5a-40d4-ab28-6d28a8d2ed47", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateTicketTypeAttributeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3bc672fa-e051-4ede-b6e9-79f518231ba9", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "CreateTicketTypeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7c4784fe-d3e4-4182-b9c4-918bdf253eef", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DataEventSummariesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "110801d1-2f7b-436f-8f03-2245545a1432", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteArticleRequestNotFoundError": { + "docs": "Article Not Found", + "examples": [ + { + "docs": undefined, + "name": "Article Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "60da5f23-613c-4f84-84bd-e9dbd3d67187", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DeleteArticleRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "85d43c53-f28f-4295-b937-9a43ea71d0c3", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteCollectionRequestNotFoundError": { + "docs": "collection Not Found", + "examples": [ + { + "docs": undefined, + "name": "collection Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a35712b4-90b6-47fb-843d-757d9fdd81e6", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DeleteCollectionRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteCompanyRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "35a9b551-331e-499e-a63f-20396bfd29f5", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DeleteCompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0a1a5065-69fe-47a4-9804-4cb2347671ef", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0bce3945-d2ec-4b8e-a790-b16fd52d9f11", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteNewsItemRequestNotFoundError": { + "docs": "News Item Not Found", + "examples": [ + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a191b999-6f71-4676-a8db-1a79ccc4f114", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DeleteNewsItemRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DeleteTagRequestBadRequestError": { + "docs": "Tag has dependent objects", + "examples": [ + { + "docs": undefined, + "name": "Tag has dependent objects", + "value": { + "errors": [ + { + "code": "tag_has_dependent_objects", + "message": "Unable to delete Tag with dependent objects. Segments: Seg 1.", + }, + ], + "request_id": "41086388-9b3b-4e07-9633-502b9b10c926", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "DeleteTagRequestNotFoundError": { + "docs": "Resource not found", + "examples": [ + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "111586bb-ad78-43b9-b0a0-bf864d9a3744", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DeleteTagRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3dcedf54-ed30-4337-8992-94e36900e695", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachContactFromACompanyRequestNotFoundError": { + "docs": "Contact Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "cd4f1648-724c-45f0-b6e1-72a1bc6479ee", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "d316defc-0a2f-49e7-b8ff-4cb6ccf46c90", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachContactFromACompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d8c1ab2d-4044-4c4f-98f0-176860747112", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachContactFromConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "d30f18d4-2e0a-4528-a66b-4590b733713c", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "DetachContactFromConversationRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "579f0f7a-d773-41d6-9d36-8cc0b3fbcc41", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "44531412-2973-4b92-b14d-80abac5c1b4d", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachContactFromConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d35f1b37-765c-4afe-8738-81c0560710a6", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachContactFromConversationRequestUnprocessableEntityError": { + "docs": "Last customer", + "examples": [ + { + "docs": undefined, + "name": "Last customer", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Removing the last customer is not allowed", + }, + ], + "request_id": "35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6", + "type": "error.list", + }, + }, + ], + "status-code": 422, + "type": "Error", + }, + "DetachSubscriptionTypeToContactRequestNotFoundError": { + "docs": "Resource not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "7bc429e4-e887-4f53-b69c-94e6e55d2125", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "66ebc1f5-5e02-4584-8028-f2559a41e8df", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachSubscriptionTypeToContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "99fba0c6-2252-4658-abd2-1d2ff16a508b", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachTagFromContactRequestNotFoundError": { + "docs": "Tag not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "6f735483-c309-4e94-b9ab-143aedc0c691", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "9e780671-29b3-4913-b4be-15234ea0bc6a", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachTagFromContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e97d9f1b-8c9e-4caf-b473-3bce411c697e", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachTagFromConversationRequestNotFoundError": { + "docs": "Tag not found", + "examples": [ + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Conversation not found", + }, + ], + "request_id": "f78f63ba-911d-47b8-a389-b33e3ccbe77e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found", + }, + ], + "request_id": "0d00d069-2cf1-496f-b887-a4db74ee320d", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachTagFromConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f083d6b1-e9d2-43b3-86df-67539007fc3e", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "DetachTagFromTicketRequestNotFoundError": { + "docs": "Tag not found", + "examples": [ + { + "docs": undefined, + "name": "Ticket not found", + "value": { + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found", + }, + ], + "request_id": "ffa08bb4-3994-4132-b9e3-14837e0723e8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found", + }, + ], + "request_id": "d2385995-502c-4c03-bf4b-93ef3d24037b", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "DetachTagFromTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "FindTagRequestNotFoundError": { + "docs": "Tag not found", + "examples": [ + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "20b89fb6-f224-4f81-98ca-4cb4b36df959", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "FindTagRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "76a1d79d-3f0d-49bb-8d15-38d1ae6df738", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "GetTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e7ba89f2-3bc8-4fc3-97bc-56f62f342680", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "GetTicketTypeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b0100f38-119c-4e30-8560-a25561d97c66", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "LisDataAttributesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6e76e914-a34d-4125-8310-62fdfc4e651e", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "LisDataEventsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bfdcc6de-2dcb-4725-acc7-232c10838586", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListActivityLogsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "06d9eefd-2b3a-48f7-938a-5a10383a4ebf", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListAdminsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4ba8121e-4a4a-4668-adb2-363c561f3c52", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListAllCollectionsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ccedcb48-7d08-4cc9-bcff-0622f70daf74", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListAllCompaniesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6f8cb4ca-9a95-43bd-aee1-597b85d1d13f", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListArticlesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "86d69044-5966-428e-9a40-2b39fba3f823", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListAttachedContactsRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "a6381081-a166-4e8e-952d-38bb2cd1c2b4", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListAttachedContactsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "fe20b681-f988-4154-bec9-a5087fe0842e", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListAttachedSegmentsForCompaniesRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "22add598-fd33-4c34-971f-cf215117aab3", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListAttachedSegmentsForCompaniesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "66fcc654-48ed-4f53-824e-831b5c96c9dc", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListCompaniesForAContactRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "b9d7374d-1780-4668-bb62-0e1ff9cdab45", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListCompaniesForAContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d211ec8c-df9b-420c-86df-23c27ad54bc5", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListContactsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d5bac7ff-7961-4fe5-8aed-6f1b031b38af", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListConversationsRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "a91eac55-8d70-454d-a01d-c6bb875aaa35", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "ListConversationsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "18db64a8-7a08-4967-9ec6-0416178306f9", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListHelpCentersRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c96a4779-a06d-45bb-aa39-eb96c587c2c7", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListLiveNewsfeedItemsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListNewsItemsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7b27151d-7bb0-402e-87fe-5780690d9f32", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListNewsfeedsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d00f8d67-1e7c-464b-b0b7-b2409d706076", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListNotesRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "e93f90a6-4c85-4dbf-b063-96b649318371", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListSegmentsForAContactRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListSegmentsForAContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d2927c64-9c5a-4593-997b-381f8c2356ea", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListSegmentsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d70c184d-852a-4f67-8298-3cf9a327adb3", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListSubscriptionTypesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "5fb6b003-d6a6-4641-b71b-c5c468c87448", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListSubscriptionsForAContactRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "3f481052-cf49-4b95-a492-734223865981", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListSubscriptionsForAContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "82a95655-569d-4e5d-b0d9-f8a6c7a379f3", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListTagsForAContactRequestNotFoundError": { + "docs": "Contact not found", + "examples": [ + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "2b513026-b78c-4c67-b073-da0266f62cc7", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ListTagsForAContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "97383559-0fb0-4084-8a9a-8e3407c46108", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListTagsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c83a3efe-433a-4555-a5e2-e393588be29f", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListTeamsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "006b2c8f-9a29-463e-be69-ad213576aee6", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ListTicketTypesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "50823491-2ab1-4b84-9700-2d92c4f367fd", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ManageConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "a7e069bb-f013-45bc-8e0a-f58c3de4e034", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "ManageConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "1bfc14e1-07ef-4999-9448-f029b112cf1b", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ManageConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ae0581d2-199e-437c-bf51-1eb9fe2e12fc", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "MergeContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "57b64228-0e60-4e35-833d-39c4e4067dde", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RedactConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "conversation_part_or_message_not_found", + "message": "Conversation part or message not found", + }, + ], + "request_id": "0c016386-49f4-431f-92dc-7e739cbf98e1", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RedactConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "1b830d07-a249-4ff8-a7bf-41bf83fd53b2", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ReplyConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "9fe5809c-cf0b-4a0f-af80-9913d3beb1eb", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "ReplyConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "8193a639-aba8-4b0e-9fdd-ee48807e3ee7", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ReplyConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7435aa28-13bd-40b1-ba99-66009e92a1ba", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ReplyTicketRequestBadRequestError": { + "docs": "User reply", + "examples": [ + { + "docs": undefined, + "name": "User reply", + "value": { + "errors": [ + { + "code": "parameter_mismatch", + "message": "User replies are not allowed on Backoffice tickets", + }, + ], + "request_id": "b8b42c55-347c-4704-b4c1-92220c01f4ac", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "ReplyTicketRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "c23e8dab-6102-483c-bb1b-c62923be35ab", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "ReplyTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bb012854-cca8-4fa7-972e-6c38204e8294", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveACompanyByIdRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "b49593ed-49a6-4497-8fb7-220ff74527f6", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveACompanyByIdRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveAdminRequestNotFoundError": { + "docs": "Admin not found", + "examples": [ + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "admin_not_found", + "message": "Admin not found", + }, + ], + "request_id": "989bdb0b-1e8c-46cc-8953-9733dad40562", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveAdminRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "83978032-1473-4696-b755-b497d46a23cf", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveArticleRequestNotFoundError": { + "docs": "Article not found", + "examples": [ + { + "docs": undefined, + "name": "Article not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "99c73902-e8ea-4872-b412-1d55ce4582fb", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveArticleRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "62ab4791-7e4d-4400-a56b-b06a0ce3ba1a", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveCollectionRequestNotFoundError": { + "docs": "Collection not found", + "examples": [ + { + "docs": undefined, + "name": "Collection not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "2970f0f3-7020-4382-8892-eac24818ca88", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveCollectionRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bf1acd76-8c6e-45f4-8dbe-54391843270a", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveCompanyRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "c97dd75f-a434-4c83-a8e8-c4d1887d6c48", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveCompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "c7b0a10f-d482-4352-8d7b-1ad26b902473", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "RetrieveConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "978c1e65-1eba-4995-9acb-ff8f33b283e3", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b1f6adfd-f7da-4880-8d11-d842235126ae", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveHelpCenterRequestNotFoundError": { + "docs": "Collection not found", + "examples": [ + { + "docs": undefined, + "name": "Collection not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "c6e7d3f6-8a46-460e-8264-e07c2e7302aa", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveHelpCenterRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "794a475b-0155-40b2-a288-ba0d48fdbd3f", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveNewsItemRequestNotFoundError": { + "docs": "News Item Not Found", + "examples": [ + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "0f4b439e-9b57-4019-886e-15cc08582914", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveNewsItemRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "cc6af01d-81e3-4a74-8a62-807a3239e1ad", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveNewsfeedRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "185ce494-34e2-4cda-85cb-c51ad7281292", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveNoteRequestNotFoundError": { + "docs": "Note not found", + "examples": [ + { + "docs": undefined, + "name": "Note not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "7e37eb4e-9f1e-47fa-a393-8d9b2c20983a", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveNoteRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b29ebc05-ba35-4db8-aac6-d74617769643", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveSegmentRequestNotFoundError": { + "docs": "Segment not found", + "examples": [ + { + "docs": undefined, + "name": "Segment not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "fe79fa5e-c8eb-40a6-be76-d618833c2840", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveSegmentRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "a9c190ff-16eb-43f9-94fc-7c22da2766af", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveTeamRequestNotFoundError": { + "docs": "Team not found", + "examples": [ + { + "docs": undefined, + "name": "Team not found", + "value": { + "errors": [ + { + "code": "team_not_found", + "message": "Team not found", + }, + ], + "request_id": "4745dfce-7275-4864-abfd-44e0d84bf52a", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveTeamRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "110ad8e4-99ed-461a-bd93-92a5cdbaa6b2", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "RetrieveVisitorWithUserIdRequestNotFoundError": { + "docs": "Visitor not found", + "examples": [ + { + "docs": undefined, + "name": "Visitor not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found", + }, + ], + "request_id": "7359afef-98f5-4b22-9de7-902f7a214729", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "RetrieveVisitorWithUserIdRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "25dace4f-4916-492c-823b-f0cca227dff0", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ScrollOverAllCompaniesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "SearchArticlesRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "626c6766-ee1a-489d-b87a-230d9b980c7d", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "SearchContactsRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "SetAwayAdminRequestNotFoundError": { + "docs": "Admin not found", + "examples": [ + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "admin_not_found", + "message": "Admin for admin_id not found", + }, + ], + "request_id": "9818bd03-9cc6-4ab8-8e7c-20a45ac58e97", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "SetAwayAdminRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "18722269-a019-46c4-87d7-50d0f6f8a990", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "ShowContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f70085f1-f655-43ee-9585-d2061b260fcd", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateArticleRequestNotFoundError": { + "docs": "Article Not Found", + "examples": [ + { + "docs": undefined, + "name": "Article Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "891b6ff4-181f-4b98-861b-d34ef16bfc4b", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateArticleRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "15b4f214-c670-43d7-ad8f-648791fddf9b", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateCollectionRequestNotFoundError": { + "docs": "Collection Not Found", + "examples": [ + { + "docs": undefined, + "name": "Collection Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "35e7f185-f547-4ae1-a23d-afc9027fc5a6", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateCollectionRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "67002700-07f8-4a56-a9bc-464254c3a5bd", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateCompanyRequestNotFoundError": { + "docs": "Company Not Found", + "examples": [ + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "b1ce72df-630f-4925-b212-fca6e833eb8d", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateCompanyRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3f26a216-ddff-4782-9529-514f5bad56ea", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateContactRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b1b88e2d-938c-4a26-b65d-26ff65a0af36", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateConversationRequestForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "cf6fb162-88c9-45ec-9f97-c3fcad93b7c1", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "UpdateConversationRequestNotFoundError": { + "docs": "Not found", + "examples": [ + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "e4c692dd-cccd-46bf-834a-cda7a3a9029c", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateConversationRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "58e6b9ee-4a28-4597-9c20-faf34b6894dc", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateDataAttributeRequestBadRequestError": { + "docs": "Too few options in list", + "examples": [ + { + "docs": undefined, + "name": "Too few options in list", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Options isn't an array", + }, + ], + "request_id": "6615f20c-01df-443c-9ea1-c954ba6b09d6", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "Error", + }, + "UpdateDataAttributeRequestNotFoundError": { + "docs": "Attribute Not Found", + "examples": [ + { + "docs": undefined, + "name": "Attribute Not Found", + "value": { + "errors": [ + { + "code": "field_not_found", + "message": "We couldn't find that data attribute to update", + }, + ], + "request_id": "2680a225-4f79-4098-8438-8db993c639fe", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateDataAttributeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0cfc97c0-32be-4e68-aef2-f5744e4e85f7", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateDataAttributeRequestUnprocessableEntityError": { + "docs": "Has Dependant Object", + "examples": [ + { + "docs": undefined, + "name": "Has Dependant Object", + "value": { + "errors": [ + { + "code": "data_invalid", + "message": "The Data Attribute you are trying to archive has a dependant object", + }, + ], + "request_id": "fbc508f1-9cbf-4134-90ea-baa1065760d2", + "type": "error.list", + }, + }, + ], + "status-code": 422, + "type": "Error", + }, + "UpdateNewsItemRequestNotFoundError": { + "docs": "News Item Not Found", + "examples": [ + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "fe6e217d-70bc-4090-b33a-b32ec0e6a391", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateNewsItemRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f780a591-4aa2-4382-80c4-e0f2d655bf2e", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateTicketRequestNotFoundError": { + "docs": "Assignee not found", + "examples": [ + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "assignee_not_found", + "message": "Assignee not found", + }, + ], + "request_id": "809aceaa-c073-4e2a-96c3-a25e15576946", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Assignee not found", + "value": { + "errors": [ + { + "code": "assignee_not_found", + "message": "Assignee not found", + }, + ], + "request_id": "639b5b51-1eb9-4c06-8de4-d9b0e30fff05", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "unknown", + }, + "UpdateTicketRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e5202025-e8f9-400a-9107-192ae8bfd50c", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateTicketTypeAttributeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6e45414c-e627-4769-bdbd-d51f2c19e1e9", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateTicketTypeRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "2b0554fe-ba10-41d4-ab7b-715c2b7b8e47", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UpdateVisitorRequestNotFoundError": { + "docs": "visitor Not Found", + "examples": [ + { + "docs": undefined, + "name": "visitor Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found", + }, + ], + "request_id": "1f35dc86-17d2-4bfe-8cb1-9afa74adc24c", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "Error", + }, + "UpdateVisitorRequestUnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "82df3971-fb7c-410d-a919-e8bc1b3d991a", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + }, + "imports": { + "admins": "admins.yml", + "aiContentSource": "aiContentSource.yml", + "articles": "articles.yml", + "companies": "companies.yml", + "contacts": "contacts.yml", + "conversations": "conversations.yml", + "customObjectInstances": "customObjectInstances.yml", + "dataAttributes": "dataAttributes.yml", + "dataEvents": "dataEvents.yml", + "helpCenter": "helpCenter.yml", + "news": "news.yml", + "notes": "notes.yml", + "segments": "segments.yml", + "subscriptionTypes": "subscriptionTypes.yml", + "tags": "tags.yml", + "teams": "teams.yml", + "tickets": "tickets.yml", + }, + "types": { + "ActivityLog": { + "docs": "Activities performed by Admins.", + "properties": { + "activity_description": { + "docs": "A sentence or two describing the activity.", + "type": "optional", + }, + "activity_type": { + "type": "optional", + }, + "created_at": { + "docs": "The time the activity was created.", + "type": "optional", + }, + "id": { + "docs": "The id representing the activity.", + "type": "optional", + }, + "metadata": { + "type": "optional", + }, + "performed_by": { + "docs": "Details about the Admin involved in the activity.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogActivityType": { + "enum": [ + "admin_assignment_limit_change", + "admin_away_mode_change", + "admin_deletion", + "admin_deprovisioned", + "admin_impersonation_end", + "admin_impersonation_start", + "admin_invite_change", + "admin_invite_creation", + "admin_invite_deletion", + "admin_login_failure", + "admin_login_success", + "admin_logout", + "admin_password_reset_request", + "admin_password_reset_success", + "admin_permission_change", + "admin_provisioned", + "admin_two_factor_auth_change", + "admin_unauthorized_sign_in_method", + "app_admin_join", + "app_authentication_method_change", + "app_data_deletion", + "app_data_export", + "app_google_sso_domain_change", + "app_identity_verification_change", + "app_name_change", + "app_outbound_address_change", + "app_package_installation", + "app_package_token_regeneration", + "app_package_uninstallation", + "app_team_creation", + "app_team_deletion", + "app_team_membership_modification", + "app_timezone_change", + "app_webhook_creation", + "app_webhook_deletion", + "articles_in_messenger_enabled_change", + "bulk_delete", + "bulk_export", + "campaign_deletion", + "campaign_state_change", + "conversation_part_deletion", + "conversation_topic_change", + "conversation_topic_creation", + "conversation_topic_deletion", + "help_center_settings_change", + "inbound_conversations_change", + "inbox_access_change", + "message_deletion", + "message_state_change", + "messenger_look_and_feel_change", + "messenger_search_required_change", + "messenger_spaces_change", + "office_hours_change", + "role_change", + "role_creation", + "role_deletion", + "ruleset_activation_title_preview", + "ruleset_creation", + "ruleset_deletion", + "search_browse_enabled_change", + "search_browse_required_change", + "seat_change", + "seat_revoke", + "security_settings_change", + "temporary_expectation_change", + "upfront_email_collection_change", + "welcome_message_change", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogList": { + "docs": "A paginated list of activity logs.", + "properties": { + "activity_logs": { + "docs": "An array of activity logs", + "type": "optional>>", + }, + "pages": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `activity_log.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogMetadata": { + "docs": "Additional data provided about Admin activity.", + "properties": { + "auto_changed": { + "docs": "Indicates if the status was changed automatically or manually.", + "type": "optional", + }, + "away_mode": { + "docs": "The away mode status which is set to true when away and false when returned.", + "type": "optional", + }, + "away_status_reason": { + "docs": "The reason the Admin is away.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "reassign_conversations": { + "docs": "Indicates if conversations should be reassigned while an Admin is away.", + "type": "optional", + }, + "sign_in_method": { + "docs": "The way the admin signed in.", + "type": "optional", + }, + "source": { + "docs": "The action that initiated the status change.", + "type": "optional", + }, + "update_by": { + "docs": "The ID of the Admin who initiated the activity.", + "type": "optional", + }, + "update_by_name": { + "docs": "The name of the Admin who initiated the activity.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogPerformedBy": { + "docs": "Details about the Admin involved in the activity.", + "properties": { + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "ip": { + "docs": "The IP address of the admin.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AddressableList": { + "docs": "A list used to access other resources from a parent model.", + "properties": { + "id": { + "docs": "The id of the addressable object", + "type": "optional", + }, + "type": { + "docs": "The addressable object type", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Admin": { + "docs": "Admins are the teammate accounts that have access to a workspace", + "properties": { + "app": { + "docs": "App that the admin belongs to.", + "type": "optional", + }, + "avatar": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional", + }, + "away_mode_enabled": { + "docs": "Identifies if this admin is currently set in away mode.", + "type": "optional", + }, + "away_mode_reassign": { + "docs": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "type": "optional", + }, + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "email_verified": { + "docs": "Identifies if this admin's email is verified.", + "type": "optional", + }, + "has_inbox_seat": { + "docs": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "job_title": { + "docs": "The job title of the admin.", + "type": "optional", + }, + "name": { + "docs": "The name of the admin.", + "type": "optional", + }, + "team_ids": { + "docs": "This is a list of ids of the teams that this admin is part of.", + "type": "optional>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminPriorityLevel": { + "docs": "Admin priority levels for the team", + "properties": { + "primary_admin_ids": { + "docs": "The primary admin ids for the team", + "type": "optional>", + }, + "secondary_admin_ids": { + "docs": "The secondary admin ids for the team", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyConversationRequest": { + "docs": "Payload of the request to reply on behalf of an admin", + "properties": { + "admin_id": { + "docs": "The id of the admin who is authoring the comment.", + "type": "string", + }, + "attachment_files": { + "docs": "A list of files that will be added as attachments. You can include up to 10 files", + "type": "optional>", + }, + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "type": "optional", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "AdminReplyConversationRequestMessageType", + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyConversationRequestMessageType": { + "enum": [ + "comment", + "note", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequest": { + "docs": "Payload of the request to reply on behalf of an admin", + "properties": { + "admin_id": { + "docs": "The id of the admin who is authoring the comment.", + "type": "string", + }, + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "type": "optional", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "AdminReplyTicketRequestMessageType", + "reply_options": { + "docs": "The quick reply options to display. Must be present for quick_reply message types.", + "type": "optional>", + }, + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequestMessageType": { + "enum": [ + "comment", + "note", + "quick_reply", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequestReplyOptionsItem": { + "docs": undefined, + "properties": { + "text": { + "docs": "The text to display in this quick reply option.", + "type": "string", + }, + "uuid": { + "docs": "A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option.", + "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminWithAppAvatar": { + "docs": "This object represents the avatar associated with the admin.", + "properties": { + "image_url": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "default": "avatar", + "docs": "This is a string that identifies the type of the object. It will always have the value `avatar`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Admins": { + "docs": "A list of admins associated with a given workspace.", + "properties": { + "admins": { + "docs": "A list of admins associated with a given workspace.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "App": { + "docs": "App is a workspace on Intercom", + "properties": { + "created_at": { + "docs": "When the app was created.", + "type": "optional", + }, + "id_code": { + "docs": "The id of the app.", + "type": "optional", + }, + "identity_verification": { + "docs": "Whether or not the app uses identity verification.", + "type": "optional", + }, + "name": { + "docs": "The name of the app.", + "type": "optional", + }, + "region": { + "docs": "The Intercom region the app is located in.", + "type": "optional", + }, + "timezone": { + "docs": "The timezone of the region where the app is located.", + "type": "optional", + }, + "type": { + "default": "app", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleContent": { + "docs": "The Content of an Article.", + "properties": { + "author_id": { + "docs": "The ID of the author of the article.", + "type": "optional", + }, + "body": { + "docs": "The body of the article.", + "type": "optional", + }, + "created_at": { + "docs": "The time when the article was created (seconds).", + "type": "optional", + }, + "description": { + "docs": "The description of the article.", + "type": "optional", + }, + "state": { + "docs": "Whether the article is `published` or is a `draft` .", + "type": "optional", + }, + "title": { + "docs": "The title of the article.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `article_content` .", + "type": "optional", + }, + "updated_at": { + "docs": "The time when the article was last updated (seconds).", + "type": "optional", + }, + "url": { + "docs": "The URL of the article.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleContentState": { + "docs": "Whether the article is `published` or is a `draft` .", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleStatistics": { + "docs": "The statistics of an article.", + "properties": { + "conversions": { + "docs": "The number of conversations started from the article.", + "type": "optional", + }, + "happy_reaction_percentage": { + "docs": "The percentage of happy reactions the article has received against other types of reaction.", + "type": "optional", + }, + "neutral_reaction_percentage": { + "docs": "The percentage of neutral reactions the article has received against other types of reaction.", + "type": "optional", + }, + "reactions": { + "docs": "The number of total reactions the article has received.", + "type": "optional", + }, + "sad_reaction_percentage": { + "docs": "The percentage of sad reactions the article has received against other types of reaction.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `article_statistics`.", + "type": "optional>", + }, + "views": { + "docs": "The number of total views the article has received.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleTranslatedContent": { + "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "properties": { + "ar": { + "docs": "The content of the article in Arabic", + "type": "optional", + }, + "bg": { + "docs": "The content of the article in Bulgarian", + "type": "optional", + }, + "bs": { + "docs": "The content of the article in Bosnian", + "type": "optional", + }, + "ca": { + "docs": "The content of the article in Catalan", + "type": "optional", + }, + "cs": { + "docs": "The content of the article in Czech", + "type": "optional", + }, + "da": { + "docs": "The content of the article in Danish", + "type": "optional", + }, + "de": { + "docs": "The content of the article in German", + "type": "optional", + }, + "el": { + "docs": "The content of the article in Greek", + "type": "optional", + }, + "en": { + "docs": "The content of the article in English", + "type": "optional", + }, + "es": { + "docs": "The content of the article in Spanish", + "type": "optional", + }, + "et": { + "docs": "The content of the article in Estonian", + "type": "optional", + }, + "fi": { + "docs": "The content of the article in Finnish", + "type": "optional", + }, + "fr": { + "docs": "The content of the article in French", + "type": "optional", + }, + "he": { + "docs": "The content of the article in Hebrew", + "type": "optional", + }, + "hr": { + "docs": "The content of the article in Croatian", + "type": "optional", + }, + "hu": { + "docs": "The content of the article in Hungarian", + "type": "optional", + }, + "id": { + "docs": "The content of the article in Indonesian", + "type": "optional", + }, + "it": { + "docs": "The content of the article in Italian", + "type": "optional", + }, + "ja": { + "docs": "The content of the article in Japanese", + "type": "optional", + }, + "ko": { + "docs": "The content of the article in Korean", + "type": "optional", + }, + "lt": { + "docs": "The content of the article in Lithuanian", + "type": "optional", + }, + "lv": { + "docs": "The content of the article in Latvian", + "type": "optional", + }, + "mn": { + "docs": "The content of the article in Mongolian", + "type": "optional", + }, + "nb": { + "docs": "The content of the article in Norwegian", + "type": "optional", + }, + "nl": { + "docs": "The content of the article in Dutch", + "type": "optional", + }, + "pl": { + "docs": "The content of the article in Polish", + "type": "optional", + }, + "pt": { + "docs": "The content of the article in Portuguese (Portugal)", + "type": "optional", + }, + "pt-BR": { + "docs": "The content of the article in Portuguese (Brazil)", + "type": "optional", + }, + "ro": { + "docs": "The content of the article in Romanian", + "type": "optional", + }, + "ru": { + "docs": "The content of the article in Russian", + "type": "optional", + }, + "sl": { + "docs": "The content of the article in Slovenian", + "type": "optional", + }, + "sr": { + "docs": "The content of the article in Serbian", + "type": "optional", + }, + "sv": { + "docs": "The content of the article in Swedish", + "type": "optional", + }, + "tr": { + "docs": "The content of the article in Turkish", + "type": "optional", + }, + "type": { + "docs": "The type of object - article_translated_content.", + "type": "optional", + }, + "vi": { + "docs": "The content of the article in Vietnamese", + "type": "optional", + }, + "zh-CN": { + "docs": "The content of the article in Chinese (China)", + "type": "optional", + }, + "zh-TW": { + "docs": "The content of the article in Chinese (Taiwan)", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Articles": { + "docs": "This will return a list of articles for the App.", + "properties": { + "data": { + "docs": "An array of Article objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of articles.", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AssignConversationRequest": { + "docs": "Payload of the request to assign a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "assignee_id": { + "docs": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin or team (ie. Unassigned).", + "type": "string", + }, + "body": { + "docs": "Optionally you can send a response in the conversation when it is assigned.", + "type": "optional", + }, + "type": "AssignConversationRequestType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AssignConversationRequestType": { + "enum": [ + "admin", + "team", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CloseConversationRequest": { + "docs": "Payload of the request to close a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "body": { + "docs": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.", + "type": "optional", + }, + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Collections": { + "docs": "This will return a list of Collections for the App.", + "properties": { + "data": { + "docs": "An array of collection objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of collections.", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Companies": { + "docs": "This will return a list of companies for the App.", + "properties": { + "data": { + "docs": "An array containing Company Objects.", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyAttachedContacts": { + "docs": "A list of Contact Objects", + "properties": { + "data": { + "docs": "An array containing Contact Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of contacts", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyAttachedSegments": { + "docs": "A list of Segment Objects", + "properties": { + "data": { + "docs": "An array containing Segment Objects", + "type": "optional>", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyScroll": { + "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "properties": { + "data": { + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "scroll_param": { + "docs": "The scroll parameter to use in the next request to fetch the next page of results.", + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactArchived": { + "docs": "archived contact object", + "properties": { + "archived": { + "docs": "Whether the contact is archived or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactAttachedCompanies": { + "docs": "A list of Company Objects", + "properties": { + "companies": { + "docs": "An array containing Company Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies associated to this contact", + "type": "optional", + }, + "type": { + "docs": "The type of object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactCompanies": { + "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of companyies attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactDeleted": { + "docs": "deleted contact object", + "properties": { + "deleted": { + "docs": "Whether the contact is deleted or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactList": { + "docs": "Contacts are your users in Intercom.", + "properties": { + "data": { + "docs": "The list of contact objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactLocation": { + "docs": "An object containing location meta data about a Intercom contact.", + "properties": { + "city": { + "docs": "The city that the contact is located in", + "type": "optional", + }, + "country": { + "docs": "The country that the contact is located in", + "type": "optional", + }, + "region": { + "docs": "The overal region that the contact is located in", + "type": "optional", + }, + "type": { + "docs": "Always location", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactNotes": { + "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "data": { + "docs": "This object represents the notes attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of companyies attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReference": { + "docs": "reference to contact object", + "properties": { + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyBaseRequest": { + "docs": undefined, + "properties": { + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the comment.", + "type": "string", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "literal<"comment">", + "type": "literal<"user">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyConversationRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyIntercomUserIdRequest", + }, + { + "type": "Email", + }, + { + "type": "ContactReplyUserIdRequest", + }, + ], + }, + "ContactReplyIntercomUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "attachment_files": { + "docs": "A list of files that will be added as attachments.", + "type": "optional>", + }, + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyTicketIntercomUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyTicketRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyTicketIntercomUserIdRequest", + }, + { + "type": "ContactReplyTicketUserIdRequest", + }, + { + "type": "Email", + }, + ], + }, + "ContactReplyTicketUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "user_id": { + "docs": "The external_id you have defined for the contact.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "attachment_files": { + "docs": "A list of files that will be added as attachments. You can include up to 10 files.", + "type": "optional>", + }, + "user_id": { + "docs": "The external_id you have defined for the contact.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactSocialProfiles": { + "docs": "An object containing social profiles that a contact has.", + "properties": { + "data": { + "docs": "A list of social profiles objects associated with the contact.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactSubscriptionTypes": { + "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", + "properties": { + "data": { + "docs": "This object represents the subscriptions attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of subscription types attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more subscription type resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactTags": { + "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "data": { + "docs": "This object represents the tags attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of tags attached to this contact", + "type": "optional", + }, + "url": { + "docs": "url to get more tag resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactUnarchived": { + "docs": "unarchived contact object", + "properties": { + "archived": { + "docs": "Whether the contact is archived or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Contacts": { + "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "properties": { + "contacts": { + "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "type": "optional>", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContentSourcesList": { + "docs": undefined, + "properties": { + "content_sources": { + "docs": "The content sources used by AI Agent in the conversation.", + "type": "optional>", + }, + "total_count": { + "docs": "The total number of content sources used by AI Agent in the conversation.", + "type": "optional", + }, + "type": { + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationAttachmentFiles": { + "docs": "Properties of the attachment files in a conversation part", + "properties": { + "content_type": { + "docs": "The content type of the file", + "type": "optional", + }, + "data": { + "docs": "The base64 encoded file data.", + "type": "optional", + }, + "name": { + "docs": "The name of the file.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationFirstContactReply": { + "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "properties": { + "created_at": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + "url": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationList": { + "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "properties": { + "conversations": { + "docs": "The list of conversation objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always conversation.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPart": { + "docs": "A Conversation Part represents a message in the conversation.", + "properties": { + "assigned_to": { + "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", + "type": "optional", + }, + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation part was created.", + "type": "optional", + }, + "external_id": { + "docs": "The external id of the conversation part", + "type": "optional", + }, + "id": { + "docs": "The id representing the conversation part.", + "type": "optional", + }, + "notified_at": { + "docs": "The time the user was notified with the conversation part.", + "type": "optional", + }, + "part_type": { + "docs": "The type of conversation part.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the conversation part has been redacted.", + "type": "optional", + }, + "type": { + "docs": "Always conversation_part", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the conversation part was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPartAuthor": { + "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "properties": { + "email": { + "docs": "The email of the author", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "id": { + "docs": "The id of the author", + "type": "optional", + }, + "name": { + "docs": "The name of the author", + "type": "optional", + }, + "type": { + "docs": "The type of the author", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationParts": { + "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "properties": { + "conversation_parts": { + "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "type": "optional>", + }, + "total_count": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationRating": { + "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "properties": { + "contact": { + "type": "optional", + }, + "created_at": { + "docs": "The time the rating was requested in the conversation being rated.", + "type": "optional", + }, + "rating": { + "docs": "The rating, between 1 and 5, for the conversation.", + "type": "optional", + }, + "remark": { + "docs": "An optional field to add a remark to correspond to the number rating", + "type": "optional", + }, + "teammate": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationSource": { + "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "properties": { + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "type": "optional", + }, + "delivered_as": { + "docs": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).", + "type": "optional", + }, + "id": { + "docs": "The id representing the message.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the source message has been redacted. Only applicable for contact initiated messages.", + "type": "optional", + }, + "subject": { + "docs": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.", + "type": "optional", + }, + "type": { + "docs": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.", + "type": "optional", + }, + "url": { + "docs": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationStatistics": { + "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "properties": { + "count_assignments": { + "docs": "Number of assignments after first_contact_reply_at.", + "type": "optional", + }, + "count_conversation_parts": { + "docs": "Total number of conversation parts.", + "type": "optional", + }, + "count_reopens": { + "docs": "Number of reopens after first_contact_reply_at.", + "type": "optional", + }, + "first_admin_reply_at": { + "docs": "Time of first admin reply after first_contact_reply_at.", + "type": "optional", + }, + "first_assignment_at": { + "docs": "Time of first assignment after first_contact_reply_at.", + "type": "optional", + }, + "first_close_at": { + "docs": "Time of first close after first_contact_reply_at.", + "type": "optional", + }, + "first_contact_reply_at": { + "docs": "Time of first text conversation part from a contact.", + "type": "optional", + }, + "last_admin_reply_at": { + "docs": "Time of the last conversation part from an admin.", + "type": "optional", + }, + "last_assignment_admin_reply_at": { + "docs": "Time of first admin reply since most recent assignment.", + "type": "optional", + }, + "last_assignment_at": { + "docs": "Time of last assignment after first_contact_reply_at.", + "type": "optional", + }, + "last_close_at": { + "docs": "Time of the last conversation close.", + "type": "optional", + }, + "last_closed_by_id": { + "docs": "The last admin who closed the conversation. Returns a reference to an Admin object.", + "type": "optional", + }, + "last_contact_reply_at": { + "docs": "Time of the last conversation part from a contact.", + "type": "optional", + }, + "median_time_to_reply": { + "docs": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_admin_reply": { + "docs": "Duration until first admin reply. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_assignment": { + "docs": "Duration until last assignment before first admin reply. In seconds.", + "type": "optional", + }, + "time_to_first_close": { + "docs": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_last_close": { + "docs": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationTeammates": { + "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "properties": { + "teammates": { + "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - `admin.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateArticleRequest": { + "docs": "You can create an Article", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "integer", + }, + "body": { + "docs": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "type": "string", + }, + "translated_content": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateArticleRequestState": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateContactRequestTwo": "unknown", + "CreateDataEventRequestTwo": "unknown", + "CreateMessageRequestOne": "unknown", + "CreateOrUpdateCompanyRequest": { + "docs": "You can create or update a Company", + "properties": { + "company_id": { + "docs": "The company id you have defined for the company. Can't be updated", + "type": "optional", + }, + "custom_attributes": { + "docs": "A hash of key/value pairs containing any other data about the company you want Intercom to store.", + "type": "optional>", + }, + "industry": { + "docs": "The industry that this company operates in.", + "type": "optional", + }, + "monthly_spend": { + "docs": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..", + "type": "optional", + }, + "name": { + "docs": "The name of the Company", + "type": "optional", + }, + "plan": { + "docs": "The name of the plan you have associated with the company.", + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the company was created by you.", + "type": "optional", + }, + "size": { + "docs": "The number of employees in this company.", + "type": "optional", + }, + "website": { + "docs": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateOrUpdateTagRequest": { + "docs": "You can create or update an existing tag.", + "properties": { + "id": { + "docs": "The id of tag to updates.", + "type": "optional", + }, + "name": { + "docs": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreatePhoneSwitchRequest": { + "docs": "You can create an phone switch", + "properties": { + "custom_attributes": { + "type": "optional", + }, + "phone": { + "docs": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketReplyWithCommentRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyTicketRequest", + }, + { + "type": "AdminReplyTicketRequest", + }, + ], + }, + "CreateTicketTypeRequest": { + "docs": "The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "properties": { + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type.", + "type": "optional", + }, + "icon": { + "default": "🎟️", + "docs": "The icon of the ticket type.", + "type": "optional", + }, + "is_internal": { + "default": false, + "docs": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketTypeRequestCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CursorPages": { + "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. +A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. +", + "properties": { + "next": { + "type": "optional", + }, + "page": { + "docs": "The current page", + "type": "optional", + }, + "per_page": { + "docs": "Number of results per page", + "type": "optional", + }, + "total_pages": { + "docs": "Total number of pages", + "type": "optional", + }, + "type": { + "docs": "the type of object `pages`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CustomAttributes": { + "docs": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.", + "type": "map", + }, + "CustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "string", + { + "type": "optional", + }, + ], + }, + "CustomerRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "CustomerRequestIntercomUserId", + }, + { + "type": "CustomerRequestUserId", + }, + { + "type": "Email", + }, + ], + }, + "CustomerRequestIntercomUserId": { + "docs": undefined, + "properties": { + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CustomerRequestUserId": { + "docs": undefined, + "properties": { + "user_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeList": { + "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "properties": { + "data": { + "docs": "A list of data attributes", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventList": { + "docs": "This will return a list of data events for the App.", + "properties": { + "events": { + "docs": "A list of data events", + "type": "optional>", + }, + "pages": { + "docs": "Pagination", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventListPages": { + "docs": "Pagination", + "properties": { + "next": "optional", + "since": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventSummary": { + "docs": "This will return a summary of data events for the App.", + "properties": { + "email": { + "docs": "The email address of the user", + "type": "optional", + }, + "events": { + "docs": "A summary of data events", + "type": "optional>>", + }, + "intercom_user_id": { + "docs": "The Intercom user ID of the user", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + "user_id": { + "docs": "The user ID of the user", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventSummaryItem": { + "docs": "This will return a summary of a data event for the App.", + "properties": { + "count": { + "docs": "The number of times the event was sent", + "type": "optional", + }, + "description": { + "docs": "The description of the event", + "type": "optional", + }, + "first": { + "docs": "The first time the event was sent", + "type": "optional", + }, + "last": { + "docs": "The last time the event was sent", + "type": "optional", + }, + "name": { + "docs": "The name of the event", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataExportCsv": { + "docs": "A CSV output file", + "properties": { + "company_id": { + "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", + "type": "optional", + }, + "content_id": { + "docs": "The specific content that was received. In an A/B test each version has its own Content ID.", + "type": "optional", + }, + "content_title": { + "docs": "The title of the content you see in your Intercom workspace.", + "type": "optional", + }, + "content_type": { + "docs": "Email, Chat, Post etc.", + "type": "optional", + }, + "email": { + "docs": "The users email who was sent the message.", + "type": "optional", + }, + "first_click": { + "docs": "The first time the series the user clicked on a link within this message.", + "type": "optional", + }, + "first_completion": { + "docs": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.", + "type": "optional", + }, + "first_dismisall": { + "docs": "The first time the series the user dismissed this message.", + "type": "optional", + }, + "first_goal_success": { + "docs": "The first time the user met this messages associated goal if one exists.", + "type": "optional", + }, + "first_hard_bounce": { + "docs": "The first time this message hard bounced for this user", + "type": "optional", + }, + "first_open": { + "docs": "The first time the user opened this message.", + "type": "optional", + }, + "first_reply": { + "docs": "The first time a user replied to this message if the content was able to receive replies.", + "type": "optional", + }, + "first_series_completion": { + "docs": "The first time the series this message was a part of was completed by the user.", + "type": "optional", + }, + "first_series_disengagement": { + "docs": "The first time the series this message was a part of was disengaged by the user.", + "type": "optional", + }, + "first_series_exit": { + "docs": "The first time the series this message was a part of was exited by the user.", + "type": "optional", + }, + "first_unsubscribe": { + "docs": "The first time the user unsubscribed from this message.", + "type": "optional", + }, + "name": { + "docs": "The full name of the user receiving the message", + "type": "optional", + }, + "node_id": { + "docs": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.", + "type": "optional", + }, + "receipt_id": { + "docs": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.", + "type": "optional", + }, + "received_at": { + "docs": "Timestamp for when the receipt was recorded.", + "type": "optional", + }, + "ruleset_id": { + "docs": "The id of the message.", + "type": "optional", + }, + "ruleset_version_id": { + "docs": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.", + "type": "optional", + }, + "series_id": { + "docs": "The id of the series that this content is part of. Will return -1 if not part of a series.", + "type": "optional", + }, + "series_title": { + "docs": "The title of the series that this content is part of.", + "type": "optional", + }, + "user_external_id": { + "docs": "The external_user_id of the user who was sent the message", + "type": "optional", + }, + "user_id": { + "docs": "The user_id of the user who was sent the message.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedArticleObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the article was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the article which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - article", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedCollectionObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the collection was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the collection which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - `collection`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedCompanyObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the company was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the company which is given by Intercom.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - `company`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the news item was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the news item which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted - news-item.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "email": { + "docs": "The email you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Error": { + "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "properties": { + "errors": { + "docs": "An array of one or more error objects", + "type": "list", + }, + "request_id": { + "docs": "", + "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "docs": "The type is error.list", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ErrorErrorsItem": { + "docs": undefined, + "properties": { + "code": { + "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", + "type": "string", + }, + "field": { + "docs": "Optional. Used to identify a particular field or query parameter that was in error.", + "type": "optional", + }, + "message": { + "docs": "Optional. Human readable description of the error.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "File": { + "docs": "The value describing a file upload set for a custom attribute", + "properties": { + "content_type": { + "docs": "The type of file", + "type": "optional", + }, + "filesize": { + "docs": "The size of the file in bytes", + "type": "optional", + }, + "height": { + "docs": "The height of the file in pixels, if applicable", + "type": "optional", + }, + "name": { + "docs": "The name of the file", + "type": "optional", + }, + "type": { + "type": "optional", + }, + "url": { + "docs": "The url of the file. This is a temporary URL and will expire after 30 minutes.", + "type": "optional", + }, + "width": { + "docs": "The width of the file in pixels, if applicable", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "GroupContent": { + "docs": "The Content of a Group.", + "properties": { + "description": { + "docs": "The description of the collection. Only available for collections.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection or section.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `group_content` .", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "GroupTranslatedContent": { + "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "properties": { + "ar": { + "docs": "The content of the group in Arabic", + "type": "optional", + }, + "bg": { + "docs": "The content of the group in Bulgarian", + "type": "optional", + }, + "bs": { + "docs": "The content of the group in Bosnian", + "type": "optional", + }, + "ca": { + "docs": "The content of the group in Catalan", + "type": "optional", + }, + "cs": { + "docs": "The content of the group in Czech", + "type": "optional", + }, + "da": { + "docs": "The content of the group in Danish", + "type": "optional", + }, + "de": { + "docs": "The content of the group in German", + "type": "optional", + }, + "el": { + "docs": "The content of the group in Greek", + "type": "optional", + }, + "en": { + "docs": "The content of the group in English", + "type": "optional", + }, + "es": { + "docs": "The content of the group in Spanish", + "type": "optional", + }, + "et": { + "docs": "The content of the group in Estonian", + "type": "optional", + }, + "fi": { + "docs": "The content of the group in Finnish", + "type": "optional", + }, + "fr": { + "docs": "The content of the group in French", + "type": "optional", + }, + "he": { + "docs": "The content of the group in Hebrew", + "type": "optional", + }, + "hr": { + "docs": "The content of the group in Croatian", + "type": "optional", + }, + "hu": { + "docs": "The content of the group in Hungarian", + "type": "optional", + }, + "id": { + "docs": "The content of the group in Indonesian", + "type": "optional", + }, + "it": { + "docs": "The content of the group in Italian", + "type": "optional", + }, + "ja": { + "docs": "The content of the group in Japanese", + "type": "optional", + }, + "ko": { + "docs": "The content of the group in Korean", + "type": "optional", + }, + "lt": { + "docs": "The content of the group in Lithuanian", + "type": "optional", + }, + "lv": { + "docs": "The content of the group in Latvian", + "type": "optional", + }, + "mn": { + "docs": "The content of the group in Mongolian", + "type": "optional", + }, + "nb": { + "docs": "The content of the group in Norwegian", + "type": "optional", + }, + "nl": { + "docs": "The content of the group in Dutch", + "type": "optional", + }, + "pl": { + "docs": "The content of the group in Polish", + "type": "optional", + }, + "pt": { + "docs": "The content of the group in Portuguese (Portugal)", + "type": "optional", + }, + "pt-BR": { + "docs": "The content of the group in Portuguese (Brazil)", + "type": "optional", + }, + "ro": { + "docs": "The content of the group in Romanian", + "type": "optional", + }, + "ru": { + "docs": "The content of the group in Russian", + "type": "optional", + }, + "sl": { + "docs": "The content of the group in Slovenian", + "type": "optional", + }, + "sr": { + "docs": "The content of the group in Serbian", + "type": "optional", + }, + "sv": { + "docs": "The content of the group in Swedish", + "type": "optional", + }, + "tr": { + "docs": "The content of the group in Turkish", + "type": "optional", + }, + "type": { + "docs": "The type of object - group_translated_content.", + "type": "optional", + }, + "vi": { + "docs": "The content of the group in Vietnamese", + "type": "optional", + }, + "zh-CN": { + "docs": "The content of the group in Chinese (China)", + "type": "optional", + }, + "zh-TW": { + "docs": "The content of the group in Chinese (Taiwan)", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "IntercomVersion": { + "default": "2.11", + "docs": "Intercom API version.
By default, it's equal to the version set in the app package.", + "enum": [ + { + "name": "One0", + "value": "1.0", + }, + { + "name": "One1", + "value": "1.1", + }, + { + "name": "One2", + "value": "1.2", + }, + { + "name": "One3", + "value": "1.3", + }, + { + "name": "One4", + "value": "1.4", + }, + { + "name": "Two0", + "value": "2.0", + }, + { + "name": "Two1", + "value": "2.1", + }, + { + "name": "Two2", + "value": "2.2", + }, + { + "name": "Two3", + "value": "2.3", + }, + { + "name": "Two4", + "value": "2.4", + }, + { + "name": "Two5", + "value": "2.5", + }, + { + "name": "Two6", + "value": "2.6", + }, + { + "name": "Two7", + "value": "2.7", + }, + { + "name": "Two8", + "value": "2.8", + }, + { + "name": "Two9", + "value": "2.9", + }, + { + "name": "Two10", + "value": "2.10", + }, + { + "name": "Two11", + "value": "2.11", + }, + "Unstable", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObject": { + "docs": "A linked conversation or ticket.", + "properties": { + "category": { + "docs": "Category of the Linked Ticket Object.", + "type": "optional", + }, + "id": { + "docs": "The ID of the linked object", + "type": "optional", + }, + "type": { + "docs": "ticket or conversation", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObjectList": { + "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "properties": { + "data": { + "docs": "An array containing the linked conversations and linked tickets.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether or not there are more linked objects than returned.", + "type": "optional", + }, + "total_count": { + "docs": "The total number of linked objects.", + "type": "optional", + }, + "type": { + "docs": "Always list.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObjectType": { + "docs": "ticket or conversation", + "enum": [ + "ticket", + "conversation", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequest": { + "docs": "Search using Intercoms Search APIs with more than one filter.", + "properties": { + "operator": { + "docs": "An operator to allow boolean inspection between multiple fields.", + "type": "optional", + }, + "value": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequestOperator": { + "docs": "An operator to allow boolean inspection between multiple fields.", + "enum": [ + "AND", + "OR", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequestValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "docs": "Add mutiple filters.", + "type": "list", + }, + { + "docs": "Add a single filter field.", + "type": "list", + }, + ], + }, + "NewsItemRequest": { + "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "properties": { + "body": { + "docs": "The news item body, which may contain HTML.", + "type": "optional", + }, + "deliver_silently": { + "docs": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.", + "type": "optional", + }, + "labels": { + "docs": "Label names displayed to users to categorize the news item.", + "type": "optional>", + }, + "newsfeed_assignments": { + "docs": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "type": "optional>", + }, + "reactions": { + "docs": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "type": "optional>>", + }, + "sender_id": { + "docs": "The id of the sender of the news item. Must be a teammate on the workspace.", + "type": "integer", + }, + "state": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "type": "optional", + }, + "title": { + "docs": "The title of the news item.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsItemRequestState": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "enum": [ + "draft", + "live", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "NoteList": { + "docs": "A paginated list of notes associated with a contact.", + "properties": { + "data": { + "docs": "An array of notes.", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of notes.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "OpenConversationRequest": { + "docs": "Payload of the request to open a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PagesLink": { + "docs": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + +Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. +", + "properties": { + "next": { + "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "page": { + "type": "optional", + }, + "per_page": { + "type": "optional", + }, + "total_pages": { + "type": "optional", + }, + "type": { + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PaginatedResponse": { + "docs": "Paginated Response", + "properties": { + "data": { + "docs": "An array of Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "The type of object", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PaginatedResponseDataItem": { + "availability": undefined, + "base-properties": {}, + "discriminant": "type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "news-item": { + "type": "news.NewsItem", + }, + "newsfeed": { + "type": "news.Newsfeed", + }, + }, + }, + "PaginatedResponseType": { + "docs": "The type of object", + "enum": [ + "list", + { + "name": "ConversationList", + "value": "conversation.list", + }, + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "PartAttachment": { + "docs": "The file attached to a part", + "properties": { + "content_type": { + "docs": "The content type of the attachment", + "type": "optional", + }, + "filesize": { + "docs": "The size of the attachment", + "type": "optional", + }, + "height": { + "docs": "The height of the attachment", + "type": "optional", + }, + "name": { + "docs": "The name of the attachment", + "type": "optional", + }, + "type": { + "docs": "The type of attachment", + "type": "optional", + }, + "url": { + "docs": "The URL of the attachment", + "type": "optional", + }, + "width": { + "docs": "The width of the attachment", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PhoneSwitch": { + "docs": "Phone Switch Response", + "properties": { + "phone": { + "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RedactConversationRequest": { + "availability": undefined, + "base-properties": {}, + "discriminant": "type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "conversation_part": { + "docs": "Payload of the request to redact a conversation part", + "type": "RedactConversationRequestConversationPart", + }, + "source": { + "docs": "Payload of the request to redact a conversation source", + "type": "RedactConversationRequestSource", + }, + }, + }, + "RedactConversationRequestConversationPart": { + "docs": "Payload of the request to redact a conversation part", + "properties": { + "conversation_id": { + "docs": "The id of the conversation.", + "type": "string", + }, + "conversation_part_id": { + "docs": "The id of the conversation_part.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RedactConversationRequestSource": { + "docs": "Payload of the request to redact a conversation source", + "properties": { + "conversation_id": { + "docs": "The id of the conversation.", + "type": "string", + }, + "source_id": { + "docs": "The id of the source.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Reference": { + "docs": "reference to another object", + "properties": { + "id": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ReplyConversationRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyConversationRequest", + }, + { + "type": "AdminReplyConversationRequest", + }, + ], + }, + "SearchRequest": { + "docs": "Search using Intercoms Search APIs.", + "properties": { + "pagination": { + "type": "optional", + }, + "query": "SearchRequestQuery", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SearchRequestQuery": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "SingleFilterSearchRequest", + }, + { + "type": "MultipleFilterSearchRequest", + }, + ], + }, + "SegmentList": { + "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "properties": { + "pages": { + "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", + "type": "optional>", + }, + "segments": { + "docs": "A list of Segment objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Segments": { + "docs": "A list of segments objects attached to a specific contact.", + "properties": { + "data": { + "docs": "Segment objects associated with the contact.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SingleFilterSearchRequest": { + "docs": "Search using Intercoms Search APIs with a single filter.", + "properties": { + "field": { + "docs": "The accepted field that you want to search on.", + "type": "optional", + }, + "operator": { + "docs": "The accepted operators you can use to define how you want to search for the value.", + "type": "optional", + }, + "value": { + "docs": "The value that you want to search on.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SingleFilterSearchRequestOperator": { + "docs": "The accepted operators you can use to define how you want to search for the value.", + "enum": [ + { + "name": "EQUAL_TO", + "value": "=", + }, + { + "name": "NOT_EQUALS", + "value": "!=", + }, + "IN", + "NIN", + { + "name": "LESS_THAN", + "value": "<", + }, + { + "name": "GREATER_THAN", + "value": ">", + }, + { + "name": "", + "value": "~", + }, + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SlaApplied": { + "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. +Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. +", + "properties": { + "sla_name": { + "docs": "The name of the SLA as given by the teammate when it was created.", + "type": "optional", + }, + "sla_status": { + "docs": "SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", + "type": "optional", + }, + "type": { + "docs": "object type", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SlaAppliedSlaStatus": { + "docs": "SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", + "enum": [ + "hit", + "missed", + "cancelled", + "active", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SnoozeConversationRequest": { + "docs": "Payload of the request to snooze a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "snoozed_until": { + "docs": "The time you want the conversation to reopen.", + "type": "integer", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SocialProfile": { + "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "properties": { + "name": { + "docs": "The name of the Social media profile", + "type": "optional", + }, + "type": { + "docs": "value is "social_profile"", + "type": "optional", + }, + "url": { + "docs": "The name of the Social media profile", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "StartingAfterPaging": { + "docs": undefined, + "properties": { + "per_page": { + "docs": "The number of results to fetch per page.", + "type": "optional", + }, + "starting_after": { + "docs": "The cursor to use in the next request to get the next page of results.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeList": { + "docs": "A list of subscription type objects.", + "properties": { + "data": { + "docs": "A list of subscription type objects associated with the workspace .", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagCompanyRequest": { + "docs": "You can tag a single company or a list of companies.", + "properties": { + "companies": { + "docs": "The id or company_id of the company can be passed as input parameters.", + "type": "list", + }, + "name": { + "docs": "The name of the tag, which will be created if not found.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagCompanyRequestCompaniesItem": { + "docs": undefined, + "properties": { + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagMultipleUsersRequest": { + "docs": "You can tag a list of users.", + "properties": { + "name": { + "docs": "The name of the tag, which will be created if not found.", + "type": "string", + }, + "users": "list", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagMultipleUsersRequestUsersItem": { + "docs": undefined, + "properties": { + "id": { + "docs": "The Intercom defined id representing the user.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Tags": { + "docs": "A list of tags objects associated with a conversation", + "properties": { + "tags": { + "docs": "A list of tags objects associated with the conversation.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TeamList": { + "docs": "This will return a list of team objects for the App.", + "properties": { + "teams": { + "docs": "A list of team objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TeamPriorityLevel": { + "docs": "Admin priority levels for teams", + "properties": { + "primary_team_ids": { + "docs": "The primary team ids for the team", + "type": "optional>", + }, + "secondary_team_ids": { + "docs": "The secondary team ids for the team", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketCustomAttributes": { + "docs": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.", + "type": "map", + }, + "TicketCustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "optional", + "double", + "boolean", + "list", + { + "type": "File", + }, + ], + }, + "TicketList": { + "docs": "Tickets are how you track requests from your users.", + "properties": { + "pages": { + "type": "optional", + }, + "tickets": { + "docs": "The list of ticket objects", + "type": "optional>>", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always ticket.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartAuthor": { + "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "properties": { + "email": { + "docs": "The email of the author", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "id": { + "docs": "The id of the author", + "type": "optional", + }, + "name": { + "docs": "The name of the author", + "type": "optional", + }, + "type": { + "docs": "The type of the author", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartAuthorType": { + "docs": "The type of the author", + "enum": [ + "admin", + "bot", + "team", + "user", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketParts": { + "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "properties": { + "ticket_parts": { + "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", + "type": "optional>", + }, + "total_count": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketReply": { + "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "properties": { + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML.", + "type": "optional", + }, + "created_at": { + "docs": "The time the note was created.", + "type": "optional", + }, + "id": { + "docs": "The id representing the part.", + "type": "optional", + }, + "part_type": { + "docs": "Type of the part", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the ticket part has been redacted.", + "type": "optional", + }, + "type": { + "docs": "Always ticket_part", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the note was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketReplyPartType": { + "docs": "Type of the part", + "enum": [ + "note", + "comment", + "quick_reply", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketRequestCustomAttributes": { + "docs": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).", + "type": "map", + }, + "TicketRequestCustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "optional", + "double", + "boolean", + "list", + ], + }, + "TicketTypeAttribute": { + "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "properties": { + "archived": { + "docs": "Whether the ticket type attribute is archived or not.", + "type": "optional", + }, + "created_at": { + "docs": "The date and time the ticket type attribute was created.", + "type": "optional", + }, + "data_type": { + "docs": "The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")", + "type": "optional", + }, + "default": { + "docs": "Whether the attribute is built in or not.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type attribute", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket type attribute.", + "type": "optional", + }, + "input_options": { + "docs": "Input options for the attribute", + "type": "optional>", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "optional", + }, + "order": { + "docs": "The order of the attribute against other attributes", + "type": "optional", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required or not for teammates.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required or not for contacts.", + "type": "optional", + }, + "ticket_type_id": { + "docs": "The id of the ticket type that the attribute belongs to.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type_attribute`.", + "type": "optional", + }, + "updated_at": { + "docs": "The date and time the ticket type attribute was last updated.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible or not to teammates.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible or not to contacts.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace that the ticket type attribute belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeAttributeList": { + "docs": "A list of attributes associated with a given ticket type.", + "properties": { + "ticket_type_attributes": { + "docs": "A list of ticket type attributes associated with a given ticket type.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type_attributes.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeList": { + "docs": "A list of ticket types associated with a given workspace.", + "properties": { + "ticket_types": { + "docs": "A list of ticket_types associated with a given workspace.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Translation": { + "docs": "A translation object contains the localised details of a subscription type.", + "properties": { + "description": { + "docs": "The localised description of the subscription type.", + "type": "optional", + }, + "locale": { + "docs": "The two character identifier for the language of the translation object.", + "type": "optional", + }, + "name": { + "docs": "The localised name of the subscription type.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UntagCompanyRequest": { + "docs": "You can tag a single company or a list of companies.", + "properties": { + "companies": { + "docs": "The id or company_id of the company can be passed as input parameters.", + "type": "list", + }, + "name": { + "docs": "The name of the tag which will be untagged from the company", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UntagCompanyRequestCompaniesItem": { + "docs": undefined, + "properties": { + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + "untag": { + "docs": "Always set to true", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateArticleRequest": { + "docs": "You can Update an Article", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "optional", + }, + "body": { + "docs": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateArticleRequestState": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketTypeRequest": { + "docs": "The request payload for updating a ticket type. +You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "properties": { + "archived": { + "docs": "The archived status of the ticket type.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type.", + "type": "optional", + }, + "icon": { + "default": "🎟️", + "docs": "The icon of the ticket type.", + "type": "optional", + }, + "is_internal": { + "default": false, + "docs": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketTypeRequestCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateVisitorRequestOne": "unknown", + "Visitor": { + "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "properties": { + "anonymous": { + "docs": "Identifies if this visitor is anonymous.", + "type": "optional", + }, + "app_id": { + "docs": "The id of the app the visitor is associated with.", + "type": "optional", + }, + "avatar": { + "type": "optional", + }, + "companies": { + "type": "optional", + }, + "created_at": { + "docs": "The time the Visitor was added to Intercom.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes you have set on the Visitor.", + "type": "optional>", + }, + "do_not_track": { + "docs": "Identifies if this visitor has do not track enabled.", + "type": "optional", + }, + "email": { + "docs": "The email of the visitor.", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "has_hard_bounced": { + "docs": "Identifies if this visitor has had a hard bounce.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the Visitor.", + "type": "optional", + }, + "las_request_at": { + "docs": "The time the Lead last recorded making a request.", + "type": "optional", + }, + "location_data": { + "type": "optional", + }, + "marked_email_as_spam": { + "docs": "Identifies if this visitor has marked an email as spam.", + "type": "optional", + }, + "name": { + "docs": "The name of the visitor.", + "type": "optional", + }, + "owner_id": { + "docs": "The id of the admin that owns the Visitor.", + "type": "optional", + }, + "phone": { + "docs": "The phone number of the visitor.", + "type": "optional", + }, + "pseudonym": { + "docs": "The pseudonym of the visitor.", + "type": "optional", + }, + "referrer": { + "docs": "The referer of the visitor.", + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the Visitor was added to Intercom.", + "type": "optional", + }, + "segments": { + "type": "optional", + }, + "session_count": { + "docs": "The number of sessions the Visitor has had.", + "type": "optional", + }, + "signed_up_at": { + "docs": "The time the Visitor signed up for your product.", + "type": "optional", + }, + "social_profiles": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "type": { + "default": "visitor", + "docs": "Value is 'visitor'", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the Visitor is unsubscribed from emails.", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the Visitor was updated.", + "type": "optional", + }, + "user_id": { + "docs": "Automatically generated identifier for the Visitor.", + "type": "optional", + }, + "utm_campaign": { + "docs": "The utm_campaign of the visitor.", + "type": "optional", + }, + "utm_content": { + "docs": "The utm_content of the visitor.", + "type": "optional", + }, + "utm_medium": { + "docs": "The utm_medium of the visitor.", + "type": "optional", + }, + "utm_source": { + "docs": "The utm_source of the visitor.", + "type": "optional", + }, + "utm_term": { + "docs": "The utm_term of the visitor.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorAvatar": { + "docs": undefined, + "properties": { + "image_url": { + "docs": "This object represents the avatar associated with the visitor.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "default": "avatar", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorCompanies": { + "docs": undefined, + "properties": { + "companies": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorDeletedObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "id": { + "docs": "The unique identifier for the visitor which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "The type of object which was deleted", + "type": "optional>", + }, + "user_id": { + "docs": "Automatically generated identifier for the Visitor.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorLocationData": { + "docs": undefined, + "properties": { + "city_name": { + "docs": "The city name of the visitor.", + "type": "optional", + }, + "continent_code": { + "docs": "The continent code of the visitor.", + "type": "optional", + }, + "country_code": { + "docs": "The country code of the visitor.", + "type": "optional", + }, + "country_name": { + "docs": "The country name of the visitor.", + "type": "optional", + }, + "postal_code": { + "docs": "The postal code of the visitor.", + "type": "optional", + }, + "region_name": { + "docs": "The region name of the visitor.", + "type": "optional", + }, + "timezone": { + "docs": "The timezone of the visitor.", + "type": "optional", + }, + "type": { + "default": "location_data", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorSegments": { + "docs": undefined, + "properties": { + "segments": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorSocialProfiles": { + "docs": undefined, + "properties": { + "social_profiles": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorTags": { + "docs": undefined, + "properties": { + "tags": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorTagsTagsItem": { + "docs": undefined, + "properties": { + "id": { + "docs": "The id of the tag.", + "type": "optional", + }, + "name": { + "docs": "The name of the tag.", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "errors: + SetAwayAdminRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 18722269-a019-46c4-87d7-50d0f6f8a990 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + SetAwayAdminRequestNotFoundError: + status-code: 404 + type: Error + docs: Admin not found + examples: + - value: + type: error.list + request_id: 9818bd03-9cc6-4ab8-8e7c-20a45ac58e97 + errors: + - code: admin_not_found + message: Admin for admin_id not found + name: Admin not found + ListActivityLogsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 06d9eefd-2b3a-48f7-938a-5a10383a4ebf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListAdminsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 4ba8121e-4a4a-4668-adb2-363c561f3c52 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveAdminRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 83978032-1473-4696-b755-b497d46a23cf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveAdminRequestNotFoundError: + status-code: 404 + type: Error + docs: Admin not found + examples: + - value: + type: error.list + request_id: 989bdb0b-1e8c-46cc-8953-9733dad40562 + errors: + - code: admin_not_found + message: Admin not found + name: Admin not found + ListArticlesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 86d69044-5966-428e-9a40-2b39fba3f823 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateArticleRequestBadRequestError: + status-code: 400 + type: Error + docs: Bad Request + examples: + - value: + type: error.list + request_id: e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd + errors: + - code: parameter_not_found + message: >- + author_id must be in the main body or default locale + translated_content object + name: Bad Request + CreateArticleRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: f223a1d9-5377-4337-92bb-00fb39157f11 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveArticleRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 62ab4791-7e4d-4400-a56b-b06a0ce3ba1a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveArticleRequestNotFoundError: + status-code: 404 + type: Error + docs: Article not found + examples: + - value: + type: error.list + request_id: 99c73902-e8ea-4872-b412-1d55ce4582fb + errors: + - code: not_found + message: Resource Not Found + name: Article not found + UpdateArticleRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 15b4f214-c670-43d7-ad8f-648791fddf9b + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateArticleRequestNotFoundError: + status-code: 404 + type: Error + docs: Article Not Found + examples: + - value: + type: error.list + request_id: 891b6ff4-181f-4b98-861b-d34ef16bfc4b + errors: + - code: not_found + message: Resource Not Found + name: Article Not Found + DeleteArticleRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 85d43c53-f28f-4295-b937-9a43ea71d0c3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteArticleRequestNotFoundError: + status-code: 404 + type: Error + docs: Article Not Found + examples: + - value: + type: error.list + request_id: 60da5f23-613c-4f84-84bd-e9dbd3d67187 + errors: + - code: not_found + message: Resource Not Found + name: Article Not Found + SearchArticlesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 626c6766-ee1a-489d-b87a-230d9b980c7d + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListAllCollectionsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: ccedcb48-7d08-4cc9-bcff-0622f70daf74 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateCollectionRequestBadRequestError: + status-code: 400 + type: Error + docs: Bad Request + examples: + - value: + type: error.list + request_id: 1f4fd741-8681-4c21-911a-47d7bb39d080 + errors: + - code: parameter_not_found + message: Name is a required parameter. + name: Bad Request + CreateCollectionRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveCollectionRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: bf1acd76-8c6e-45f4-8dbe-54391843270a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveCollectionRequestNotFoundError: + status-code: 404 + type: Error + docs: Collection not found + examples: + - value: + type: error.list + request_id: 2970f0f3-7020-4382-8892-eac24818ca88 + errors: + - code: not_found + message: Resource Not Found + name: Collection not found + UpdateCollectionRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 67002700-07f8-4a56-a9bc-464254c3a5bd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateCollectionRequestNotFoundError: + status-code: 404 + type: Error + docs: Collection Not Found + examples: + - value: + type: error.list + request_id: 35e7f185-f547-4ae1-a23d-afc9027fc5a6 + errors: + - code: not_found + message: Resource Not Found + name: Collection Not Found + DeleteCollectionRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteCollectionRequestNotFoundError: + status-code: 404 + type: Error + docs: collection Not Found + examples: + - value: + type: error.list + request_id: a35712b4-90b6-47fb-843d-757d9fdd81e6 + errors: + - code: not_found + message: Resource Not Found + name: collection Not Found + RetrieveHelpCenterRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 794a475b-0155-40b2-a288-ba0d48fdbd3f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveHelpCenterRequestNotFoundError: + status-code: 404 + type: Error + docs: Collection not found + examples: + - value: + type: error.list + request_id: c6e7d3f6-8a46-460e-8264-e07c2e7302aa + errors: + - code: not_found + message: Resource Not Found + name: Collection not found + ListHelpCentersRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c96a4779-a06d-45bb-aa39-eb96c587c2c7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveCompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveCompanyRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: c97dd75f-a434-4c83-a8e8-c4d1887d6c48 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + CreateOrUpdateCompanyRequestBadRequestError: + status-code: 400 + type: Error + docs: Bad Request + examples: + - value: + type: error.list + errors: + - code: bad_request + message: bad 'test' parameter + name: Bad Request + CreateOrUpdateCompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 9b0d6fb9-d2d7-4904-a13c-97557a802323 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveACompanyByIdRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveACompanyByIdRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: b49593ed-49a6-4497-8fb7-220ff74527f6 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + UpdateCompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 3f26a216-ddff-4782-9529-514f5bad56ea + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateCompanyRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: b1ce72df-630f-4925-b212-fca6e833eb8d + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + DeleteCompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 0a1a5065-69fe-47a4-9804-4cb2347671ef + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteCompanyRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: 35a9b551-331e-499e-a63f-20396bfd29f5 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + ListAttachedContactsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: fe20b681-f988-4154-bec9-a5087fe0842e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListAttachedContactsRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: a6381081-a166-4e8e-952d-38bb2cd1c2b4 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + ListAttachedSegmentsForCompaniesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 66fcc654-48ed-4f53-824e-831b5c96c9dc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListAttachedSegmentsForCompaniesRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: 22add598-fd33-4c34-971f-cf215117aab3 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + ListAllCompaniesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 6f8cb4ca-9a95-43bd-aee1-597b85d1d13f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ScrollOverAllCompaniesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListCompaniesForAContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d211ec8c-df9b-420c-86df-23c27ad54bc5 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListCompaniesForAContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: b9d7374d-1780-4668-bb62-0e1ff9cdab45 + errors: + - code: not_found + message: User Not Found + name: Contact not found + AttachContactToACompanyRequestBadRequestError: + status-code: 400 + type: Error + docs: Bad Request + examples: + - value: + type: error.list + request_id: 9297dcfc-1896-43a3-a3f9-131238422ed2 + errors: + - code: parameter_not_found + message: company not specified + name: Bad Request + AttachContactToACompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 99739bbd-2dbe-4ce3-ae91-af23379b5cd7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachContactToACompanyRequestNotFoundError: + status-code: 404 + type: Error + docs: Company Not Found + examples: + - value: + type: error.list + request_id: 32d121d8-fcbf-4c59-9c60-204f7d602f36 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + DetachContactFromACompanyRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d8c1ab2d-4044-4c4f-98f0-176860747112 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachContactFromACompanyRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact Not Found + examples: + - value: + type: error.list + request_id: cd4f1648-724c-45f0-b6e1-72a1bc6479ee + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: d316defc-0a2f-49e7-b8ff-4cb6ccf46c90 + errors: + - code: not_found + message: User Not Found + name: Contact Not Found + ListNotesRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: e93f90a6-4c85-4dbf-b063-96b649318371 + errors: + - code: not_found + message: User Not Found + name: Contact not found + CreateNoteRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: d7c69ce6-3195-46be-b2cb-0dce355d2919 + errors: + - code: not_found + message: Resource Not Found + name: Admin not found + - value: + type: error.list + request_id: 2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d + errors: + - code: not_found + message: User Not Found + name: Contact not found + ListSegmentsForAContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d2927c64-9c5a-4593-997b-381f8c2356ea + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListSegmentsForAContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: 7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7 + errors: + - code: not_found + message: User Not Found + name: Contact not found + ListSubscriptionsForAContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 82a95655-569d-4e5d-b0d9-f8a6c7a379f3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListSubscriptionsForAContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: 3f481052-cf49-4b95-a492-734223865981 + errors: + - code: not_found + message: User Not Found + name: Contact not found + AttachSubscriptionTypeToContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 377d162e-82a5-4148-a26f-29c9c760dadc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachSubscriptionTypeToContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Resource not found + examples: + - value: + type: error.list + request_id: cf0f6fd6-7c5e-492b-909d-f60b35eea1c4 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 3f852f45-1a80-4ade-9bc6-72b377d2bbd8 + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + DetachSubscriptionTypeToContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 99fba0c6-2252-4658-abd2-1d2ff16a508b + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachSubscriptionTypeToContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Resource not found + examples: + - value: + type: error.list + request_id: 7bc429e4-e887-4f53-b69c-94e6e55d2125 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 66ebc1f5-5e02-4584-8028-f2559a41e8df + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + ListTagsForAContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 97383559-0fb0-4084-8a9a-8e3407c46108 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListTagsForAContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: 2b513026-b78c-4c67-b073-da0266f62cc7 + errors: + - code: not_found + message: User Not Found + name: Contact not found + AttachTagToContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 63a2828f-107e-4d51-9398-a220b81a7bce + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachTagToContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Tag not found + examples: + - value: + type: error.list + request_id: 1bbd7e4b-718e-46f4-b682-a429aea78f01 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: a1a28017-728a-423b-adc0-2705d375f533 + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + DetachTagFromContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: e97d9f1b-8c9e-4caf-b473-3bce411c697e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachTagFromContactRequestNotFoundError: + status-code: 404 + type: Error + docs: Tag not found + examples: + - value: + type: error.list + request_id: 6f735483-c309-4e94-b9ab-143aedc0c691 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 9e780671-29b3-4913-b4be-15234ea0bc6a + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + ShowContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: f70085f1-f655-43ee-9585-d2061b260fcd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: b1b88e2d-938c-4a26-b65d-26ff65a0af36 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 0bce3945-d2ec-4b8e-a790-b16fd52d9f11 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + MergeContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 57b64228-0e60-4e35-833d-39c4e4067dde + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + SearchContactsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListContactsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d5bac7ff-7961-4fe5-8aed-6f1b031b38af + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateContactRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c18ca0d4-ad2c-41e7-9a71-1df806f9c954 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachTagToConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 95cacea0-4744-4de8-a2bf-da4419f75732 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachTagToConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Conversation not found + examples: + - value: + type: error.list + request_id: 840d35aa-2414-402a-b3c6-763a410e0d16 + errors: + - code: not_found + message: Conversation not found + name: Conversation not found + DetachTagFromConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: f083d6b1-e9d2-43b3-86df-67539007fc3e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachTagFromConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Tag not found + examples: + - value: + type: error.list + request_id: f78f63ba-911d-47b8-a389-b33e3ccbe77e + errors: + - code: not_found + message: Conversation not found + name: Conversation not found + - value: + type: error.list + request_id: 0d00d069-2cf1-496f-b887-a4db74ee320d + errors: + - code: tag_not_found + message: Tag not found + name: Tag not found + ListConversationsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 18db64a8-7a08-4967-9ec6-0416178306f9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListConversationsRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: a91eac55-8d70-454d-a01d-c6bb875aaa35 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + CreateConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: af9757fc-4e1d-463c-ac9d-788503f04a95 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: c7a35217-6720-48bd-a2ae-c2acb5adea30 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + CreateConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact Not Found + examples: + - value: + type: error.list + request_id: ed0ab0c5-57b8-4413-a7a9-bbc134b40876 + errors: + - code: not_found + message: User Not Found + name: Contact Not Found + RetrieveConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: b1f6adfd-f7da-4880-8d11-d842235126ae + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: c7b0a10f-d482-4352-8d7b-1ad26b902473 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + RetrieveConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 978c1e65-1eba-4995-9acb-ff8f33b283e3 + errors: + - code: not_found + message: Resource Not Found + name: Not found + UpdateConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 58e6b9ee-4a28-4597-9c20-faf34b6894dc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: cf6fb162-88c9-45ec-9f97-c3fcad93b7c1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + UpdateConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: e4c692dd-cccd-46bf-834a-cda7a3a9029c + errors: + - code: not_found + message: Resource Not Found + name: Not found + ReplyConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 7435aa28-13bd-40b1-ba99-66009e92a1ba + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ReplyConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: 9fe5809c-cf0b-4a0f-af80-9913d3beb1eb + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + ReplyConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 8193a639-aba8-4b0e-9fdd-ee48807e3ee7 + errors: + - code: not_found + message: Resource Not Found + name: Not found + ManageConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: ae0581d2-199e-437c-bf51-1eb9fe2e12fc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ManageConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: a7e069bb-f013-45bc-8e0a-f58c3de4e034 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + ManageConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 1bfc14e1-07ef-4999-9448-f029b112cf1b + errors: + - code: not_found + message: Resource Not Found + name: Not found + AutoAssignConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AutoAssignConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: 037980c4-84cb-4d3a-ad64-66e4e563a275 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + AutoAssignConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984 + errors: + - code: not_found + message: Resource Not Found + name: Not found + AttachContactToConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 4f00c4c6-a8f7-436e-bf95-d1adfa315906 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachContactToConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: 3d1c3371-6ba4-4d5a-9368-ac983292136d + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + AttachContactToConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 1fd64942-5bf0-4a51-a6cb-db4a778bb1f4 + errors: + - code: not_found + message: Resource Not Found + name: Not found + DetachContactFromConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d35f1b37-765c-4afe-8738-81c0560710a6 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachContactFromConversationRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: d30f18d4-2e0a-4528-a66b-4590b733713c + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + DetachContactFromConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Contact not found + examples: + - value: + type: error.list + request_id: 579f0f7a-d773-41d6-9d36-8cc0b3fbcc41 + errors: + - code: not_found + message: Resource Not Found + name: Conversation not found + - value: + type: error.list + request_id: 44531412-2973-4b92-b14d-80abac5c1b4d + errors: + - code: not_found + message: User Not Found + name: Contact not found + DetachContactFromConversationRequestUnprocessableEntityError: + status-code: 422 + type: Error + docs: Last customer + examples: + - value: + type: error.list + request_id: 35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + name: Last customer + RedactConversationRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 1b830d07-a249-4ff8-a7bf-41bf83fd53b2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RedactConversationRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: 0c016386-49f4-431f-92dc-7e739cbf98e1 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + name: Not found + ConvertConversationToTicketRequestBadRequestError: + status-code: 400 + type: Error + docs: Bad request + examples: + - value: + type: error.list + request_id: 74656c1a-0a17-4c80-a7b9-66fa45c6d71b + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + name: Bad request + LisDataAttributesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 6e76e914-a34d-4125-8310-62fdfc4e651e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateDataAttributeRequestBadRequestError: + status-code: 400 + type: Error + docs: Too few options for list + examples: + - value: + type: error.list + request_id: bcd93885-3f01-4b92-9918-c96a3f4492e8 + errors: + - code: parameter_invalid + message: >- + You already have 'The One Ring' in your company data. To save + this as new people data, use a different name. + name: Same name already exists + - value: + type: error.list + request_id: 7420c5e3-22c3-46be-8a23-72fef8f8ec0e + errors: + - code: parameter_invalid + message: >- + Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + name: Invalid name + - value: + type: error.list + request_id: c844551a-05d3-4f8c-931a-32e96bf3a508 + errors: + - code: parameter_invalid + message: >- + You already have 'The One Ring' in your company data. To save + this as new company data, use a different name. + name: Attribute already exists + - value: + type: error.list + request_id: b8c58b81-8445-473d-8fe3-7880c04f9547 + errors: + - code: parameter_invalid + message: Data Type isn't an option + name: Invalid Data Type + - value: + type: error.list + request_id: 119e3822-3a45-48cf-b5ab-037f27a948c8 + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact or company + name: Too few options for list + CreateDataAttributeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: b74d8980-6e99-44db-a3d8-2a65a63fe590 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateDataAttributeRequestBadRequestError: + status-code: 400 + type: Error + docs: Too few options in list + examples: + - value: + type: error.list + request_id: 6615f20c-01df-443c-9ea1-c954ba6b09d6 + errors: + - code: parameter_invalid + message: Options isn't an array + name: Too few options in list + UpdateDataAttributeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 0cfc97c0-32be-4e68-aef2-f5744e4e85f7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateDataAttributeRequestNotFoundError: + status-code: 404 + type: Error + docs: Attribute Not Found + examples: + - value: + type: error.list + request_id: 2680a225-4f79-4098-8438-8db993c639fe + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + name: Attribute Not Found + UpdateDataAttributeRequestUnprocessableEntityError: + status-code: 422 + type: Error + docs: Has Dependant Object + examples: + - value: + type: error.list + request_id: fbc508f1-9cbf-4134-90ea-baa1065760d2 + errors: + - code: data_invalid + message: >- + The Data Attribute you are trying to archive has a dependant + object + name: Has Dependant Object + LisDataEventsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: bfdcc6de-2dcb-4725-acc7-232c10838586 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateDataEventRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c6b3dcbd-33be-4a80-abb4-c5b3315250d0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DataEventSummariesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 110801d1-2f7b-436f-8f03-2245545a1432 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateMessageRequestBadRequestError: + status-code: 400 + type: Error + docs: No body supplied for email message + examples: + - value: + type: error.list + request_id: 4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1 + errors: + - code: parameter_invalid + message: Body is required + name: No body supplied for message + - value: + type: error.list + request_id: 7d54191b-c0fc-4860-a01c-9da6b4e45b7f + errors: + - code: parameter_invalid + message: Body is required + name: No body supplied for email message + CreateMessageRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: ee3ea56e-d0ce-47db-871a-57740e165e5c + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateMessageRequestForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: fab7034a-78bd-4413-a652-8f38783e7bf1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + CreateMessageRequestUnprocessableEntityError: + status-code: 422 + type: Error + docs: No subject supplied for email message + examples: + - value: + type: error.list + request_id: f54ba906-3255-4fc6-a660-0dab0043ff2b + errors: + - code: parameter_not_found + message: No subject supplied for email message + name: No subject supplied for email message + ListNewsItemsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 7b27151d-7bb0-402e-87fe-5780690d9f32 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateNewsItemRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c36202f1-6bf3-4ea6-9442-192123f506b0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveNewsItemRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: cc6af01d-81e3-4a74-8a62-807a3239e1ad + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveNewsItemRequestNotFoundError: + status-code: 404 + type: Error + docs: News Item Not Found + examples: + - value: + type: error.list + request_id: 0f4b439e-9b57-4019-886e-15cc08582914 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + UpdateNewsItemRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: f780a591-4aa2-4382-80c4-e0f2d655bf2e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateNewsItemRequestNotFoundError: + status-code: 404 + type: Error + docs: News Item Not Found + examples: + - value: + type: error.list + request_id: fe6e217d-70bc-4090-b33a-b32ec0e6a391 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + DeleteNewsItemRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteNewsItemRequestNotFoundError: + status-code: 404 + type: Error + docs: News Item Not Found + examples: + - value: + type: error.list + request_id: a191b999-6f71-4676-a8db-1a79ccc4f114 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + ListLiveNewsfeedItemsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListNewsfeedsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d00f8d67-1e7c-464b-b0b7-b2409d706076 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveNewsfeedRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 185ce494-34e2-4cda-85cb-c51ad7281292 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveNoteRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: b29ebc05-ba35-4db8-aac6-d74617769643 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveNoteRequestNotFoundError: + status-code: 404 + type: Error + docs: Note not found + examples: + - value: + type: error.list + request_id: 7e37eb4e-9f1e-47fa-a393-8d9b2c20983a + errors: + - code: not_found + message: Resource Not Found + name: Note not found + ListSegmentsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: d70c184d-852a-4f67-8298-3cf9a327adb3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveSegmentRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: a9c190ff-16eb-43f9-94fc-7c22da2766af + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveSegmentRequestNotFoundError: + status-code: 404 + type: Error + docs: Segment not found + examples: + - value: + type: error.list + request_id: fe79fa5e-c8eb-40a6-be76-d618833c2840 + errors: + - code: not_found + message: Resource Not Found + name: Segment not found + ListSubscriptionTypesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 5fb6b003-d6a6-4641-b71b-c5c468c87448 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreatePhoneSwitchRequestBadRequestError: + status-code: 400 + type: unknown + docs: bad request - invalid number + examples: + - value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + name: bad request - exception sending sms + - value: + error_key: invalid_phone_number + message: Invalid phone number + name: bad request - invalid number + CreatePhoneSwitchRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 5da7a3e7-dcb0-4378-8575-0a0e9bae3862 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreatePhoneSwitchRequestUnprocessableEntityError: + status-code: 422 + type: unknown + docs: unprocessable entity + examples: + - value: + error_key: some_error + name: unprocessable entity + ListTagsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: c83a3efe-433a-4555-a5e2-e393588be29f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateTagRequestBadRequestError: + status-code: 400 + type: Error + docs: Invalid parameters + examples: + - value: + type: error.list + request_id: a7afe3c5-be52-4b69-9268-50ef1d917a1b + errors: + - code: parameter_invalid + message: invalid tag parameters + name: Invalid parameters + CreateTagRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 3609e8b1-a6aa-4c57-a994-3d95743f20a2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateTagRequestNotFoundError: + status-code: 404 + type: Error + docs: User not found + examples: + - value: + type: error.list + request_id: f0f84d9b-3c51-4904-9c21-34faba76ebf5 + errors: + - code: company_not_found + message: Company Not Found + name: Company not found + - value: + type: error.list + request_id: 786848c6-5b9f-4e9b-aa78-2bdec45a09f5 + errors: + - code: not_found + message: User Not Found + name: User not found + FindTagRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 76a1d79d-3f0d-49bb-8d15-38d1ae6df738 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + FindTagRequestNotFoundError: + status-code: 404 + type: Error + docs: Tag not found + examples: + - value: + type: error.list + request_id: 20b89fb6-f224-4f81-98ca-4cb4b36df959 + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + DeleteTagRequestBadRequestError: + status-code: 400 + type: Error + docs: Tag has dependent objects + examples: + - value: + type: error.list + request_id: 41086388-9b3b-4e07-9633-502b9b10c926 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: Seg 1.' + name: Tag has dependent objects + DeleteTagRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 3dcedf54-ed30-4337-8992-94e36900e695 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DeleteTagRequestNotFoundError: + status-code: 404 + type: Error + docs: Resource not found + examples: + - value: + type: error.list + request_id: 111586bb-ad78-43b9-b0a0-bf864d9a3744 + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + ListTeamsRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 006b2c8f-9a29-463e-be69-ad213576aee6 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveTeamRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 110ad8e4-99ed-461a-bd93-92a5cdbaa6b2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveTeamRequestNotFoundError: + status-code: 404 + type: Error + docs: Team not found + examples: + - value: + type: error.list + request_id: 4745dfce-7275-4864-abfd-44e0d84bf52a + errors: + - code: team_not_found + message: Team not found + name: Team not found + CreateTicketTypeAttributeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 3bc672fa-e051-4ede-b6e9-79f518231ba9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateTicketTypeAttributeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 6e45414c-e627-4769-bdbd-d51f2c19e1e9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ListTicketTypesRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 50823491-2ab1-4b84-9700-2d92c4f367fd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + CreateTicketTypeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 7c4784fe-d3e4-4182-b9c4-918bdf253eef + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + GetTicketTypeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: b0100f38-119c-4e30-8560-a25561d97c66 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateTicketTypeRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 2b0554fe-ba10-41d4-ab7b-715c2b7b8e47 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ReplyTicketRequestBadRequestError: + status-code: 400 + type: Error + docs: User reply + examples: + - value: + type: error.list + request_id: b8b42c55-347c-4704-b4c1-92220c01f4ac + errors: + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets + name: User reply + ReplyTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: bb012854-cca8-4fa7-972e-6c38204e8294 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + ReplyTicketRequestNotFoundError: + status-code: 404 + type: Error + docs: Not found + examples: + - value: + type: error.list + request_id: c23e8dab-6102-483c-bb1b-c62923be35ab + errors: + - code: not_found + message: Resource Not Found + name: Not found + AttachTagToTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: a502f48f-c80d-48fd-bea5-cafe7e24d9f9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + AttachTagToTicketRequestNotFoundError: + status-code: 404 + type: Error + docs: Ticket not found + examples: + - value: + type: error.list + request_id: e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9 + errors: + - code: ticket_not_found + message: Ticket not found + name: Ticket not found + DetachTagFromTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + DetachTagFromTicketRequestNotFoundError: + status-code: 404 + type: Error + docs: Tag not found + examples: + - value: + type: error.list + request_id: ffa08bb4-3994-4132-b9e3-14837e0723e8 + errors: + - code: ticket_not_found + message: Ticket not found + name: Ticket not found + - value: + type: error.list + request_id: d2385995-502c-4c03-bf4b-93ef3d24037b + errors: + - code: tag_not_found + message: Tag not found + name: Tag not found + CreateTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 745c921a-7c5a-40d4-ab28-6d28a8d2ed47 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + GetTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: e7ba89f2-3bc8-4fc3-97bc-56f62f342680 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateTicketRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: e5202025-e8f9-400a-9107-192ae8bfd50c + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateTicketRequestNotFoundError: + status-code: 404 + type: unknown + docs: Assignee not found + examples: + - value: + type: error.list + request_id: 809aceaa-c073-4e2a-96c3-a25e15576946 + errors: + - code: assignee_not_found + message: Assignee not found + name: Admin not found + - value: + type: error.list + request_id: 639b5b51-1eb9-4c06-8de4-d9b0e30fff05 + errors: + - code: assignee_not_found + message: Assignee not found + name: Assignee not found + RetrieveVisitorWithUserIdRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 25dace4f-4916-492c-823b-f0cca227dff0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + RetrieveVisitorWithUserIdRequestNotFoundError: + status-code: 404 + type: Error + docs: Visitor not found + examples: + - value: + type: error.list + request_id: 7359afef-98f5-4b22-9de7-902f7a214729 + errors: + - code: not_found + message: Visitor Not Found + name: Visitor not found + UpdateVisitorRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 82df3971-fb7c-410d-a919-e8bc1b3d991a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + UpdateVisitorRequestNotFoundError: + status-code: 404 + type: Error + docs: visitor Not Found + examples: + - value: + type: error.list + request_id: 1f35dc86-17d2-4bfe-8cb1-9afa74adc24c + errors: + - code: not_found + message: Visitor Not Found + name: visitor Not Found + ConvertVisitorRequestUnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: fe1a587a-e682-4a96-bd30-ea08b726e6fa + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized +types: + ActivityLogPerformedBy: + docs: Details about the Admin involved in the activity. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + email: + type: optional + docs: The email of the admin. + ip: + type: optional + docs: The IP address of the admin. + source: + openapi: ../openapi.yml + ActivityLogActivityType: + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + source: + openapi: ../openapi.yml + ActivityLog: + docs: Activities performed by Admins. + properties: + id: + type: optional + docs: The id representing the activity. + performed_by: + type: optional + docs: Details about the Admin involved in the activity. + metadata: + type: optional + created_at: + type: optional + docs: The time the activity was created. + activity_type: + type: optional + activity_description: + type: optional + docs: A sentence or two describing the activity. + source: + openapi: ../openapi.yml + ActivityLogList: + docs: A paginated list of activity logs. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `activity_log.list`. + pages: + type: optional + activity_logs: + type: optional>> + docs: An array of activity logs + source: + openapi: ../openapi.yml + ActivityLogMetadata: + docs: Additional data provided about Admin activity. + properties: + sign_in_method: + type: optional + docs: The way the admin signed in. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + away_mode: + type: optional + docs: >- + The away mode status which is set to true when away and false when + returned. + away_status_reason: + type: optional + docs: The reason the Admin is away. + reassign_conversations: + type: optional + docs: >- + Indicates if conversations should be reassigned while an Admin is + away. + source: + type: optional + docs: The action that initiated the status change. + auto_changed: + type: optional + docs: Indicates if the status was changed automatically or manually. + update_by: + type: optional + docs: The ID of the Admin who initiated the activity. + update_by_name: + type: optional + docs: The name of the Admin who initiated the activity. + source: + openapi: ../openapi.yml + AddressableList: + docs: A list used to access other resources from a parent model. + properties: + type: + type: optional + docs: The addressable object type + validation: + format: uri + id: + type: optional + docs: The id of the addressable object + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + source: + openapi: ../openapi.yml + Admins: + docs: A list of admins associated with a given workspace. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `admin.list`. + admins: + type: optional>> + docs: A list of admins associated with a given workspace. + source: + openapi: ../openapi.yml + AdminPriorityLevel: + docs: Admin priority levels for the team + properties: + primary_admin_ids: + type: optional> + docs: The primary admin ids for the team + secondary_admin_ids: + type: optional> + docs: The secondary admin ids for the team + source: + openapi: ../openapi.yml + AdminReplyConversationRequestMessageType: + enum: + - comment + - note + source: + openapi: ../openapi.yml + AdminReplyConversationRequest: + docs: Payload of the request to reply on behalf of an admin + properties: + message_type: AdminReplyConversationRequestMessageType + type: literal<"admin"> + body: + type: optional + docs: >- + The text body of the reply. Notes accept some HTML formatting. Must be + present for comment and note message types. + admin_id: + type: string + docs: The id of the admin who is authoring the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + attachment_files: + type: optional> + docs: >- + A list of files that will be added as attachments. You can include up + to 10 files + source: + openapi: ../openapi.yml + AdminReplyTicketRequestMessageType: + enum: + - comment + - note + - quick_reply + source: + openapi: ../openapi.yml + AdminReplyTicketRequestReplyOptionsItem: + properties: + text: + type: string + docs: The text to display in this quick reply option. + uuid: + type: string + docs: >- + A unique identifier for this quick reply option. This value will be + available within the metadata of the comment ticket part that is + created when a user clicks on this reply option. + validation: + format: uuid + source: + openapi: ../openapi.yml + AdminReplyTicketRequest: + docs: Payload of the request to reply on behalf of an admin + properties: + message_type: AdminReplyTicketRequestMessageType + type: literal<"admin"> + body: + type: optional + docs: >- + The text body of the reply. Notes accept some HTML formatting. Must be + present for comment and note message types. + admin_id: + type: string + docs: The id of the admin who is authoring the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + reply_options: + type: optional> + docs: >- + The quick reply options to display. Must be present for quick_reply + message types. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + source: + openapi: ../openapi.yml + AdminWithAppAvatar: + docs: This object represents the avatar associated with the admin. + properties: + type: + type: optional + docs: >- + This is a string that identifies the type of the object. It will + always have the value `avatar`. + default: avatar + image_url: + type: optional + docs: This object represents the avatar associated with the admin. + validation: + format: uri + source: + openapi: ../openapi.yml + Admin: + docs: Admins are the teammate accounts that have access to a workspace + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + name: + type: optional + docs: The name of the admin. + email: + type: optional + docs: The email of the admin. + job_title: + type: optional + docs: The job title of the admin. + away_mode_enabled: + type: optional + docs: Identifies if this admin is currently set in away mode. + away_mode_reassign: + type: optional + docs: >- + Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + has_inbox_seat: + type: optional + docs: >- + Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + team_ids: + type: optional> + docs: This is a list of ids of the teams that this admin is part of. + avatar: + type: optional + docs: This object represents the avatar associated with the admin. + email_verified: + type: optional + docs: Identifies if this admin's email is verified. + app: + type: optional + docs: App that the admin belongs to. + source: + openapi: ../openapi.yml + App: + docs: App is a workspace on Intercom + properties: + type: + type: optional + docs: '' + default: app + id_code: + type: optional + docs: The id of the app. + name: + type: optional + docs: The name of the app. + region: + type: optional + docs: The Intercom region the app is located in. + timezone: + type: optional + docs: The timezone of the region where the app is located. + created_at: + type: optional + docs: When the app was created. + identity_verification: + type: optional + docs: Whether or not the app uses identity verification. + source: + openapi: ../openapi.yml + ArticleContentState: + enum: + - published + - draft + docs: Whether the article is `published` or is a `draft` . + source: + openapi: ../openapi.yml + ArticleContent: + docs: The Content of an Article. + properties: + type: + type: optional + docs: The type of object - `article_content` . + title: + type: optional + docs: The title of the article. + description: + type: optional + docs: The description of the article. + body: + type: optional + docs: The body of the article. + author_id: + type: optional + docs: The ID of the author of the article. + state: + type: optional + docs: Whether the article is `published` or is a `draft` . + created_at: + type: optional + docs: The time when the article was created (seconds). + updated_at: + type: optional + docs: The time when the article was last updated (seconds). + url: + type: optional + docs: The URL of the article. + source: + openapi: ../openapi.yml + Articles: + docs: This will return a list of articles for the App. + properties: + type: + type: optional> + docs: The type of the object - `list`. + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of articles. + data: + type: optional> + docs: An array of Article objects + source: + openapi: ../openapi.yml + ArticleStatistics: + docs: The statistics of an article. + properties: + type: + type: optional> + docs: The type of object - `article_statistics`. + views: + type: optional + docs: The number of total views the article has received. + conversions: + type: optional + docs: The number of conversations started from the article. + reactions: + type: optional + docs: The number of total reactions the article has received. + happy_reaction_percentage: + type: optional + docs: >- + The percentage of happy reactions the article has received against + other types of reaction. + neutral_reaction_percentage: + type: optional + docs: >- + The percentage of neutral reactions the article has received against + other types of reaction. + sad_reaction_percentage: + type: optional + docs: >- + The percentage of sad reactions the article has received against other + types of reaction. + source: + openapi: ../openapi.yml + ArticleTranslatedContent: + docs: >- + The Translated Content of an Article. The keys are the locale codes and + the values are the translated content of the article. + properties: + type: + type: optional + docs: The type of object - article_translated_content. + ar: + type: optional + docs: The content of the article in Arabic + bg: + type: optional + docs: The content of the article in Bulgarian + bs: + type: optional + docs: The content of the article in Bosnian + ca: + type: optional + docs: The content of the article in Catalan + cs: + type: optional + docs: The content of the article in Czech + da: + type: optional + docs: The content of the article in Danish + de: + type: optional + docs: The content of the article in German + el: + type: optional + docs: The content of the article in Greek + en: + type: optional + docs: The content of the article in English + es: + type: optional + docs: The content of the article in Spanish + et: + type: optional + docs: The content of the article in Estonian + fi: + type: optional + docs: The content of the article in Finnish + fr: + type: optional + docs: The content of the article in French + he: + type: optional + docs: The content of the article in Hebrew + hr: + type: optional + docs: The content of the article in Croatian + hu: + type: optional + docs: The content of the article in Hungarian + id: + type: optional + docs: The content of the article in Indonesian + it: + type: optional + docs: The content of the article in Italian + ja: + type: optional + docs: The content of the article in Japanese + ko: + type: optional + docs: The content of the article in Korean + lt: + type: optional + docs: The content of the article in Lithuanian + lv: + type: optional + docs: The content of the article in Latvian + mn: + type: optional + docs: The content of the article in Mongolian + nb: + type: optional + docs: The content of the article in Norwegian + nl: + type: optional + docs: The content of the article in Dutch + pl: + type: optional + docs: The content of the article in Polish + pt: + type: optional + docs: The content of the article in Portuguese (Portugal) + ro: + type: optional + docs: The content of the article in Romanian + ru: + type: optional + docs: The content of the article in Russian + sl: + type: optional + docs: The content of the article in Slovenian + sr: + type: optional + docs: The content of the article in Serbian + sv: + type: optional + docs: The content of the article in Swedish + tr: + type: optional + docs: The content of the article in Turkish + vi: + type: optional + docs: The content of the article in Vietnamese + pt-BR: + type: optional + docs: The content of the article in Portuguese (Brazil) + zh-CN: + type: optional + docs: The content of the article in Chinese (China) + zh-TW: + type: optional + docs: The content of the article in Chinese (Taiwan) + source: + openapi: ../openapi.yml + AssignConversationRequestType: + enum: + - admin + - team + source: + openapi: ../openapi.yml + AssignConversationRequest: + docs: Payload of the request to assign a conversation + properties: + type: AssignConversationRequestType + admin_id: + type: string + docs: The id of the admin who is performing the action. + assignee_id: + type: string + docs: >- + The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a + team.\nSet `0` if you want this assign to no admin or team (ie. + Unassigned). + body: + type: optional + docs: >- + Optionally you can send a response in the conversation when it is + assigned. + source: + openapi: ../openapi.yml + CloseConversationRequest: + docs: Payload of the request to close a conversation + properties: + type: literal<"admin"> + admin_id: + type: string + docs: The id of the admin who is performing the action. + body: + type: optional + docs: >- + Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + source: + openapi: ../openapi.yml + Collections: + docs: This will return a list of Collections for the App. + properties: + type: + type: optional> + docs: The type of the object - `list`. + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of collections. + data: + type: optional> + docs: An array of collection objects + source: + openapi: ../openapi.yml + CompanyAttachedContacts: + docs: A list of Contact Objects + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + docs: An array containing Contact Objects + total_count: + type: optional + docs: The total number of contacts + pages: + type: optional + source: + openapi: ../openapi.yml + CompanyAttachedSegments: + docs: A list of Segment Objects + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + docs: An array containing Segment Objects + source: + openapi: ../openapi.yml + Companies: + docs: This will return a list of companies for the App. + properties: + type: + type: optional> + docs: The type of object - `list`. + pages: + type: optional + total_count: + type: optional + docs: The total number of companies. + data: + type: optional> + docs: An array containing Company Objects. + source: + openapi: ../openapi.yml + CompanyScroll: + docs: >- + Companies allow you to represent organizations using your product. Each + company will have its own description and be associated with contacts. You + can fetch, create, update and list companies. + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + pages: + type: optional + total_count: + type: optional + docs: The total number of companies + scroll_param: + type: optional + docs: >- + The scroll parameter to use in the next request to fetch the next page + of results. + source: + openapi: ../openapi.yml + ContactArchived: + docs: archived contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + archived: + type: optional + docs: Whether the contact is archived or not. + source: + openapi: ../openapi.yml + ContactAttachedCompanies: + docs: A list of Company Objects + properties: + type: + type: optional> + docs: The type of object + companies: + type: optional> + docs: An array containing Company Objects + total_count: + type: optional + docs: The total number of companies associated to this contact + pages: + type: optional + source: + openapi: ../openapi.yml + ContactCompanies: + docs: >- + An object containing companies meta data about the companies that a + contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of companyies attached to this + contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactDeleted: + docs: deleted contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + deleted: + type: optional + docs: Whether the contact is deleted or not. + source: + openapi: ../openapi.yml + ContactList: + docs: Contacts are your users in Intercom. + properties: + type: + type: optional> + docs: Always list + data: + type: optional> + docs: The list of contact objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + ContactLocation: + docs: An object containing location meta data about a Intercom contact. + properties: + type: + type: optional + docs: Always location + country: + type: optional + docs: The country that the contact is located in + region: + type: optional + docs: The overal region that the contact is located in + city: + type: optional + docs: The city that the contact is located in + source: + openapi: ../openapi.yml + ContactNotes: + docs: >- + An object containing notes meta data about the notes that a contact has. + Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: optional> + docs: This object represents the notes attached to a contact. + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of companyies attached to this + contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactReference: + docs: reference to contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + source: + openapi: ../openapi.yml + ContactReplyBaseRequest: + properties: + message_type: literal<"comment"> + type: literal<"user"> + body: + type: string + docs: The text body of the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + source: + openapi: ../openapi.yml + ContactReplyConversationRequest: + discriminated: false + union: + - type: ContactReplyIntercomUserIdRequest + - type: Email + - type: ContactReplyUserIdRequest + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. + source: + openapi: ../openapi.yml + ContactReplyIntercomUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + attachment_files: + type: optional> + docs: A list of files that will be added as attachments. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyTicketIntercomUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyTicketRequest: + discriminated: false + union: + - type: ContactReplyTicketIntercomUserIdRequest + - type: ContactReplyTicketUserIdRequest + - type: Email + source: + openapi: ../openapi.yml + ContactReplyTicketUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `user_id` + properties: + user_id: + type: string + docs: The external_id you have defined for the contact. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `user_id` + properties: + user_id: + type: string + docs: The external_id you have defined for the contact. + attachment_files: + type: optional> + docs: >- + A list of files that will be added as attachments. You can include up + to 10 files. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + Segments: + docs: A list of segments objects attached to a specific contact. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: Segment objects associated with the contact. + source: + openapi: ../openapi.yml + ContactSocialProfiles: + docs: An object containing social profiles that a contact has. + properties: + data: + type: optional> + docs: A list of social profiles objects associated with the contact. + source: + openapi: ../openapi.yml + ContactSubscriptionTypes: + docs: >- + An object containing Subscription Types meta data about the + SubscriptionTypes that a contact has. + properties: + data: + type: optional> + docs: This object represents the subscriptions attached to a contact. + url: + type: optional + docs: Url to get more subscription type resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of subscription types attached to + this contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactTags: + docs: >- + An object containing tags meta data about the tags that a contact has. Up + to 10 will be displayed here. Use the url to get more. + properties: + data: + type: optional> + docs: This object represents the tags attached to a contact. + url: + type: optional + docs: url to get more tag resources for this contact + validation: + format: uri + total_count: + type: optional + docs: Int representing the total number of tags attached to this contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactUnarchived: + docs: unarchived contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + archived: + type: optional + docs: Whether the contact is archived or not. + source: + openapi: ../openapi.yml + ContentSourcesList: + properties: + type: + type: optional> + total_count: + type: optional + docs: >- + The total number of content sources used by AI Agent in the + conversation. + content_sources: + type: optional> + docs: The content sources used by AI Agent in the conversation. + source: + openapi: ../openapi.yml + ConversationAttachmentFiles: + docs: Properties of the attachment files in a conversation part + properties: + content_type: + type: optional + docs: The content type of the file + data: + type: optional + docs: The base64 encoded file data. + name: + type: optional + docs: The name of the file. + source: + openapi: ../openapi.yml + Contacts: + docs: >- + The list of contacts (users or leads) involved in this conversation. This + will only contain one customer unless more were added via the group + conversation feature. + properties: + type: + type: optional> + docs: '' + contacts: + type: optional> + docs: >- + The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the + group conversation feature. + source: + openapi: ../openapi.yml + ConversationFirstContactReply: + docs: >- + An object containing information on the first users message. For a contact + initiated message this will represent the users original message. + properties: + created_at: + type: optional + docs: '' + type: + type: optional + docs: '' + url: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ConversationList: + docs: >- + Conversations are how you can communicate with users in Intercom. They are + created when a contact replies to an outbound message, or when one admin + directly sends a message to a single contact. + properties: + type: + type: optional> + docs: Always conversation.list + conversations: + type: optional> + docs: The list of conversation objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + ConversationPart: + docs: A Conversation Part represents a message in the conversation. + properties: + type: + type: optional + docs: Always conversation_part + id: + type: optional + docs: The id representing the conversation part. + part_type: + type: optional + docs: The type of conversation part. + body: + type: optional + docs: >- + The message body, which may contain HTML. For Twitter, this will show + a generic message regarding why the body is obscured. + created_at: + type: optional + docs: The time the conversation part was created. + updated_at: + type: optional + docs: The last time the conversation part was updated. + notified_at: + type: optional + docs: The time the user was notified with the conversation part. + assigned_to: + type: optional + docs: >- + The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + external_id: + type: optional + docs: The external id of the conversation part + redacted: + type: optional + docs: Whether or not the conversation part has been redacted. + source: + openapi: ../openapi.yml + ConversationPartAuthor: + docs: >- + The object who initiated the conversation, which can be a Contact, Admin + or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: optional + docs: The type of the author + id: + type: optional + docs: The id of the author + name: + type: optional + docs: The name of the author + email: + type: optional + docs: The email of the author + validation: + format: email + source: + openapi: ../openapi.yml + ConversationParts: + docs: >- + A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and + ignored when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: optional> + docs: '' + conversation_parts: + type: optional> + docs: >- + A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 + parts. + total_count: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ConversationRating: + docs: >- + The Conversation Rating object which contains information on the rating + and/or remark added by a Contact and the Admin assigned to the + conversation. + properties: + rating: + type: optional + docs: The rating, between 1 and 5, for the conversation. + remark: + type: optional + docs: An optional field to add a remark to correspond to the number rating + created_at: + type: optional + docs: The time the rating was requested in the conversation being rated. + contact: + type: optional + teammate: + type: optional + source: + openapi: ../openapi.yml + ConversationSource: + docs: >- + The Conversation Part that originated this conversation, which can be + Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: optional + docs: >- + This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + id: + type: optional + docs: The id representing the message. + delivered_as: + type: optional + docs: >- + The conversation's initiation type. Possible values are + customer_initiated, campaigns_initiated (legacy campaigns), + operator_initiated (Custom bot), automated (Series and other outbounds + with dynamic audience message) and admin_initiated (fixed audience + message, ticket initiated by an admin, group email). + subject: + type: optional + docs: >- + Optional. The message subject. For Twitter, this will show a generic + message regarding why the subject is obscured. + body: + type: optional + docs: >- + The message body, which may contain HTML. For Twitter, this will show + a generic message regarding why the body is obscured. + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + url: + type: optional + docs: >- + The URL where the conversation was started. For Twitter, Email, and + Bots, this will be blank. + redacted: + type: optional + docs: >- + Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + source: + openapi: ../openapi.yml + ConversationStatistics: + docs: >- + A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: optional + docs: '' + time_to_assignment: + type: optional + docs: Duration until last assignment before first admin reply. In seconds. + time_to_admin_reply: + type: optional + docs: >- + Duration until first admin reply. Subtracts out of business hours. In + seconds. + time_to_first_close: + type: optional + docs: >- + Duration until conversation was closed first time. Subtracts out of + business hours. In seconds. + time_to_last_close: + type: optional + docs: >- + Duration until conversation was closed last time. Subtracts out of + business hours. In seconds. + median_time_to_reply: + type: optional + docs: >- + Median based on all admin replies after a contact reply. Subtracts out + of business hours. In seconds. + first_contact_reply_at: + type: optional + docs: Time of first text conversation part from a contact. + first_assignment_at: + type: optional + docs: Time of first assignment after first_contact_reply_at. + first_admin_reply_at: + type: optional + docs: Time of first admin reply after first_contact_reply_at. + first_close_at: + type: optional + docs: Time of first close after first_contact_reply_at. + last_assignment_at: + type: optional + docs: Time of last assignment after first_contact_reply_at. + last_assignment_admin_reply_at: + type: optional + docs: Time of first admin reply since most recent assignment. + last_contact_reply_at: + type: optional + docs: Time of the last conversation part from a contact. + last_admin_reply_at: + type: optional + docs: Time of the last conversation part from an admin. + last_close_at: + type: optional + docs: Time of the last conversation close. + last_closed_by_id: + type: optional + docs: >- + The last admin who closed the conversation. Returns a reference to an + Admin object. + count_reopens: + type: optional + docs: Number of reopens after first_contact_reply_at. + count_assignments: + type: optional + docs: Number of assignments after first_contact_reply_at. + count_conversation_parts: + type: optional + docs: Total number of conversation parts. + source: + openapi: ../openapi.yml + ConversationTeammates: + docs: >- + The list of teammates who participated in the conversation (wrote at least + one conversation part). + properties: + type: + type: optional + docs: The type of the object - `admin.list`. + teammates: + type: optional> + docs: >- + The list of teammates who participated in the conversation (wrote at + least one conversation part). + source: + openapi: ../openapi.yml + CreateArticleRequestState: + enum: + - published + - draft + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults to + draft. For multilingual articles, this will be the state of the default + language's content. + source: + openapi: ../openapi.yml + CreateArticleRequest: + docs: You can create an Article + properties: + title: + type: string + docs: >- + The title of the article.For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The content of the article. For multilingual articles, this will be + the body of the default language's content. + author_id: + type: integer + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults + to draft. For multilingual articles, this will be the state of the + default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + translated_content: + type: optional + source: + openapi: ../openapi.yml + CreateContactRequestTwo: unknown + CreateDataEventRequestTwo: unknown + CreateMessageRequestOne: unknown + CreateOrUpdateCompanyRequest: + docs: You can create or update a Company + properties: + name: + type: optional + docs: The name of the Company + company_id: + type: optional + docs: The company id you have defined for the company. Can't be updated + plan: + type: optional + docs: The name of the plan you have associated with the company. + size: + type: optional + docs: The number of employees in this company. + website: + type: optional + docs: >- + The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + industry: + type: optional + docs: The industry that this company operates in. + custom_attributes: + type: optional> + docs: >- + A hash of key/value pairs containing any other data about the company + you want Intercom to store. + remote_created_at: + type: optional + docs: The time the company was created by you. + monthly_spend: + type: optional + docs: >- + How much revenue the company generates for your business. Note that + this will truncate floats. i.e. it only allow for whole integers, + 155.98 will be truncated to 155. Note that this has an upper limit of + 2**31-1 or 2147483647.. + source: + openapi: ../openapi.yml + CreateOrUpdateTagRequest: + docs: You can create or update an existing tag. + properties: + name: + type: string + docs: >- + The name of the tag, which will be created if not found, or the new + name for the tag if this is an update request. Names are case + insensitive. + id: + type: optional + docs: The id of tag to updates. + source: + openapi: ../openapi.yml + CreatePhoneSwitchRequest: + docs: You can create an phone switch + properties: + phone: + type: string + docs: >- + Phone number in E.164 format, that will receive the SMS to continue + the conversation in the Messenger. + custom_attributes: + type: optional + source: + openapi: ../openapi.yml + CreateTicketReplyWithCommentRequest: + discriminated: false + union: + - type: ContactReplyTicketRequest + - type: AdminReplyTicketRequest + source: + openapi: ../openapi.yml + CreateTicketTypeRequestCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + CreateTicketTypeRequest: + docs: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + properties: + name: + type: string + docs: The name of the ticket type. + description: + type: optional + docs: The description of the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + icon: + type: optional + docs: The icon of the ticket type. + default: 🎟️ + is_internal: + type: optional + docs: >- + Whether the tickets associated with this ticket type are intended for + internal use only or will be shared with customers. This is currently + a limited attribute. + default: false + source: + openapi: ../openapi.yml + CursorPages: + docs: > + Cursor-based pagination is a technique used in the Intercom API to + navigate through large amounts of data. + + A "cursor" or pointer is used to keep track of the current position in the + result set, allowing the API to return the data in small chunks or "pages" + as needed. + properties: + type: + type: optional> + docs: the type of object `pages`. + page: + type: optional + docs: The current page + next: + type: optional + per_page: + type: optional + docs: Number of results per page + total_pages: + type: optional + docs: Total number of pages + source: + openapi: ../openapi.yml + CustomAttributesValue: + discriminated: false + union: + - string + - type: optional + source: + openapi: ../openapi.yml + CustomAttributes: + type: map + docs: >- + An object containing the different custom attributes associated to the + conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + CustomerRequestIntercomUserId: + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + source: + openapi: ../openapi.yml + CustomerRequestUserId: + properties: + user_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + source: + openapi: ../openapi.yml + CustomerRequest: + discriminated: false + union: + - type: CustomerRequestIntercomUserId + - type: CustomerRequestUserId + - type: Email + source: + openapi: ../openapi.yml + DataAttributeList: + docs: >- + A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: A list of data attributes + source: + openapi: ../openapi.yml + DataEventListPages: + docs: Pagination + properties: + next: optional + since: optional + source: + openapi: ../openapi.yml + DataEventList: + docs: This will return a list of data events for the App. + properties: + type: + type: optional> + docs: The type of the object + events: + type: optional> + docs: A list of data events + pages: + type: optional + docs: Pagination + source: + openapi: ../openapi.yml + DataEventSummary: + docs: This will return a summary of data events for the App. + properties: + type: + type: optional> + docs: The type of the object + email: + type: optional + docs: The email address of the user + intercom_user_id: + type: optional + docs: The Intercom user ID of the user + user_id: + type: optional + docs: The user ID of the user + events: + type: optional>> + docs: A summary of data events + source: + openapi: ../openapi.yml + DataEventSummaryItem: + docs: This will return a summary of a data event for the App. + properties: + name: + type: optional + docs: The name of the event + first: + type: optional + docs: The first time the event was sent + last: + type: optional + docs: The last time the event was sent + count: + type: optional + docs: The number of times the event was sent + description: + type: optional + docs: The description of the event + source: + openapi: ../openapi.yml + DataExportCsv: + docs: A CSV output file + properties: + user_id: + type: optional + docs: The user_id of the user who was sent the message. + user_external_id: + type: optional + docs: The external_user_id of the user who was sent the message + company_id: + type: optional + docs: >- + The company ID of the user in relation to the message that was sent. + Will return -1 if no company is present. + email: + type: optional + docs: The users email who was sent the message. + name: + type: optional + docs: The full name of the user receiving the message + ruleset_id: + type: optional + docs: The id of the message. + content_id: + type: optional + docs: >- + The specific content that was received. In an A/B test each version + has its own Content ID. + content_type: + type: optional + docs: Email, Chat, Post etc. + content_title: + type: optional + docs: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: optional + docs: >- + As you edit content we record new versions. This ID can help you + determine which version of a piece of content that was received. + receipt_id: + type: optional + docs: >- + ID for this receipt. Will be included with any related stats in other + files to identify this specific delivery of a message. + received_at: + type: optional + docs: Timestamp for when the receipt was recorded. + series_id: + type: optional + docs: >- + The id of the series that this content is part of. Will return -1 if + not part of a series. + series_title: + type: optional + docs: The title of the series that this content is part of. + node_id: + type: optional + docs: >- + The id of the series node that this ruleset is associated with. Each + block in a series has a corresponding node_id. + first_reply: + type: optional + docs: >- + The first time a user replied to this message if the content was able + to receive replies. + first_completion: + type: optional + docs: >- + The first time a user completed this message if the content was able + to be completed e.g. Tours, Surveys. + first_series_completion: + type: optional + docs: >- + The first time the series this message was a part of was completed by + the user. + first_series_disengagement: + type: optional + docs: >- + The first time the series this message was a part of was disengaged by + the user. + first_series_exit: + type: optional + docs: >- + The first time the series this message was a part of was exited by the + user. + first_goal_success: + type: optional + docs: >- + The first time the user met this messages associated goal if one + exists. + first_open: + type: optional + docs: The first time the user opened this message. + first_click: + type: optional + docs: >- + The first time the series the user clicked on a link within this + message. + first_dismisall: + type: optional + docs: The first time the series the user dismissed this message. + first_unsubscribe: + type: optional + docs: The first time the user unsubscribed from this message. + first_hard_bounce: + type: optional + docs: The first time this message hard bounced for this user + source: + openapi: ../openapi.yml + DeletedArticleObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the article which you provided in the URL. + object: + type: optional> + docs: The type of object which was deleted. - article + deleted: + type: optional + docs: Whether the article was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedCollectionObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: >- + The unique identifier for the collection which you provided in the + URL. + object: + type: optional> + docs: The type of object which was deleted. - `collection` + deleted: + type: optional + docs: Whether the collection was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedCompanyObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the company which is given by Intercom. + object: + type: optional> + docs: The type of object which was deleted. - `company` + deleted: + type: optional + docs: Whether the company was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the news item which you provided in the URL. + object: + type: optional> + docs: The type of object which was deleted - news-item. + deleted: + type: optional + docs: Whether the news item was deleted successfully or not. + source: + openapi: ../openapi.yml + ErrorErrorsItem: + properties: + code: + type: string + docs: >- + A string indicating the kind of error, used to further qualify the + HTTP response code + message: + type: optional + docs: Optional. Human readable description of the error. + field: + type: optional + docs: >- + Optional. Used to identify a particular field or query parameter that + was in error. + source: + openapi: ../openapi.yml + Error: + docs: >- + The API will return an Error List for a failed request, which will contain + one or more Error objects. + properties: + type: + type: string + docs: The type is error.list + request_id: + type: optional + docs: '' + validation: + format: uuid + errors: + docs: An array of one or more error objects + type: list + source: + openapi: ../openapi.yml + File: + docs: The value describing a file upload set for a custom attribute + properties: + type: + type: optional + name: + type: optional + docs: The name of the file + url: + type: optional + docs: >- + The url of the file. This is a temporary URL and will expire after 30 + minutes. + content_type: + type: optional + docs: The type of file + filesize: + type: optional + docs: The size of the file in bytes + width: + type: optional + docs: The width of the file in pixels, if applicable + height: + type: optional + docs: The height of the file in pixels, if applicable + source: + openapi: ../openapi.yml + GroupContent: + docs: The Content of a Group. + properties: + type: + type: optional + docs: The type of object - `group_content` . + name: + type: optional + docs: The name of the collection or section. + description: + type: optional + docs: The description of the collection. Only available for collections. + source: + openapi: ../openapi.yml + GroupTranslatedContent: + docs: >- + The Translated Content of an Group. The keys are the locale codes and the + values are the translated content of the Group. + properties: + type: + type: optional + docs: The type of object - group_translated_content. + ar: + type: optional + docs: The content of the group in Arabic + bg: + type: optional + docs: The content of the group in Bulgarian + bs: + type: optional + docs: The content of the group in Bosnian + ca: + type: optional + docs: The content of the group in Catalan + cs: + type: optional + docs: The content of the group in Czech + da: + type: optional + docs: The content of the group in Danish + de: + type: optional + docs: The content of the group in German + el: + type: optional + docs: The content of the group in Greek + en: + type: optional + docs: The content of the group in English + es: + type: optional + docs: The content of the group in Spanish + et: + type: optional + docs: The content of the group in Estonian + fi: + type: optional + docs: The content of the group in Finnish + fr: + type: optional + docs: The content of the group in French + he: + type: optional + docs: The content of the group in Hebrew + hr: + type: optional + docs: The content of the group in Croatian + hu: + type: optional + docs: The content of the group in Hungarian + id: + type: optional + docs: The content of the group in Indonesian + it: + type: optional + docs: The content of the group in Italian + ja: + type: optional + docs: The content of the group in Japanese + ko: + type: optional + docs: The content of the group in Korean + lt: + type: optional + docs: The content of the group in Lithuanian + lv: + type: optional + docs: The content of the group in Latvian + mn: + type: optional + docs: The content of the group in Mongolian + nb: + type: optional + docs: The content of the group in Norwegian + nl: + type: optional + docs: The content of the group in Dutch + pl: + type: optional + docs: The content of the group in Polish + pt: + type: optional + docs: The content of the group in Portuguese (Portugal) + ro: + type: optional + docs: The content of the group in Romanian + ru: + type: optional + docs: The content of the group in Russian + sl: + type: optional + docs: The content of the group in Slovenian + sr: + type: optional + docs: The content of the group in Serbian + sv: + type: optional + docs: The content of the group in Swedish + tr: + type: optional + docs: The content of the group in Turkish + vi: + type: optional + docs: The content of the group in Vietnamese + pt-BR: + type: optional + docs: The content of the group in Portuguese (Brazil) + zh-CN: + type: optional + docs: The content of the group in Chinese (China) + zh-TW: + type: optional + docs: The content of the group in Chinese (Taiwan) + source: + openapi: ../openapi.yml + IntercomVersion: + enum: + - value: '1.0' + name: One0 + - value: '1.1' + name: One1 + - value: '1.2' + name: One2 + - value: '1.3' + name: One3 + - value: '1.4' + name: One4 + - value: '2.0' + name: Two0 + - value: '2.1' + name: Two1 + - value: '2.2' + name: Two2 + - value: '2.3' + name: Two3 + - value: '2.4' + name: Two4 + - value: '2.5' + name: Two5 + - value: '2.6' + name: Two6 + - value: '2.7' + name: Two7 + - value: '2.8' + name: Two8 + - value: '2.9' + name: Two9 + - value: '2.10' + name: Two10 + - value: '2.11' + name: Two11 + - Unstable + docs: >- + Intercom API version.
By default, it's equal to the version set in the + app package. + default: '2.11' + source: + openapi: ../openapi.yml + LinkedObjectType: + enum: + - ticket + - conversation + docs: ticket or conversation + source: + openapi: ../openapi.yml + LinkedObject: + docs: A linked conversation or ticket. + properties: + type: + type: optional + docs: ticket or conversation + id: + type: optional + docs: The ID of the linked object + category: + type: optional + docs: Category of the Linked Ticket Object. + source: + openapi: ../openapi.yml + LinkedObjectList: + docs: >- + An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: optional> + docs: Always list. + total_count: + type: optional + docs: The total number of linked objects. + has_more: + type: optional + docs: Whether or not there are more linked objects than returned. + data: + type: optional> + docs: An array containing the linked conversations and linked tickets. + source: + openapi: ../openapi.yml + MultipleFilterSearchRequestOperator: + enum: + - AND + - OR + docs: An operator to allow boolean inspection between multiple fields. + source: + openapi: ../openapi.yml + MultipleFilterSearchRequestValue: + discriminated: false + union: + - docs: Add mutiple filters. + type: list + - docs: Add a single filter field. + type: list + source: + openapi: ../openapi.yml + MultipleFilterSearchRequest: + docs: Search using Intercoms Search APIs with more than one filter. + properties: + operator: + type: optional + docs: An operator to allow boolean inspection between multiple fields. + value: + type: optional + source: + openapi: ../openapi.yml + NewsItemRequestState: + enum: + - draft + - live + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + source: + openapi: ../openapi.yml + NewsItemRequest: + docs: >- + A News Item is a content type in Intercom enabling you to announce product + updates, company news, promotions, events and more with your customers. + properties: + title: + type: string + docs: The title of the news item. + body: + type: optional + docs: The news item body, which may contain HTML. + sender_id: + type: integer + docs: >- + The id of the sender of the news item. Must be a teammate on the + workspace. + state: + type: optional + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + deliver_silently: + type: optional + docs: >- + When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + labels: + type: optional> + docs: Label names displayed to users to categorize the news item. + reactions: + type: optional>> + docs: >- + Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + newsfeed_assignments: + type: optional> + docs: A list of newsfeed_assignments to assign to the specified newsfeed. + source: + openapi: ../openapi.yml + NoteList: + docs: A paginated list of notes associated with a contact. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `list`. + data: + type: optional> + docs: An array of notes. + total_count: + type: optional + docs: A count of the total number of notes. + pages: + type: optional + source: + openapi: ../openapi.yml + OpenConversationRequest: + docs: Payload of the request to open a conversation + properties: + admin_id: + type: string + docs: The id of the admin who is performing the action. + source: + openapi: ../openapi.yml + PagesLink: + docs: > + The majority of list resources in the API are paginated to allow clients + to traverse data over multiple requests. + + + Their responses are likely to contain a pages object that hosts pagination + links which a client can use to paginate through the data without having + to construct a query. The link relations for the pages field are as + follows. + properties: + type: + type: optional> + page: + type: optional + next: + type: optional + docs: >- + A link to the next page of results. A response that does not contain a + next link does not have further data to fetch. + validation: + format: uri + per_page: + type: optional + total_pages: + type: optional + source: + openapi: ../openapi.yml + PaginatedResponseType: + enum: + - list + - value: conversation.list + name: ConversationList + docs: The type of object + source: + openapi: ../openapi.yml + PaginatedResponseDataItem: + discriminant: type + base-properties: {} + union: + news-item: + type: news.NewsItem + newsfeed: + type: news.Newsfeed + source: + openapi: ../openapi.yml + PaginatedResponse: + docs: Paginated Response + properties: + type: + type: optional + docs: The type of object + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of objects. + data: + type: optional> + docs: An array of Objects + source: + openapi: ../openapi.yml + PartAttachment: + docs: The file attached to a part + properties: + type: + type: optional + docs: The type of attachment + name: + type: optional + docs: The name of the attachment + url: + type: optional + docs: The URL of the attachment + content_type: + type: optional + docs: The content type of the attachment + filesize: + type: optional + docs: The size of the attachment + width: + type: optional + docs: The width of the attachment + height: + type: optional + docs: The height of the attachment + source: + openapi: ../openapi.yml + PhoneSwitch: + docs: Phone Switch Response + properties: + type: + type: optional> + docs: '' + phone: + type: optional + docs: >- + Phone number in E.164 format, that has received the SMS to continue + the conversation in the Messenger. + source: + openapi: ../openapi.yml + RedactConversationRequestConversationPart: + docs: Payload of the request to redact a conversation part + properties: + conversation_id: + type: string + docs: The id of the conversation. + conversation_part_id: + type: string + docs: The id of the conversation_part. + source: + openapi: ../openapi.yml + RedactConversationRequestSource: + docs: Payload of the request to redact a conversation source + properties: + conversation_id: + type: string + docs: The id of the conversation. + source_id: + type: string + docs: The id of the source. + source: + openapi: ../openapi.yml + RedactConversationRequest: + discriminant: type + base-properties: {} + union: + conversation_part: + type: RedactConversationRequestConversationPart + docs: Payload of the request to redact a conversation part + source: + type: RedactConversationRequestSource + docs: Payload of the request to redact a conversation source + source: + openapi: ../openapi.yml + Reference: + docs: reference to another object + properties: + type: + type: optional + docs: '' + id: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ReplyConversationRequest: + discriminated: false + union: + - type: ContactReplyConversationRequest + - type: AdminReplyConversationRequest + source: + openapi: ../openapi.yml + SearchRequestQuery: + discriminated: false + union: + - type: SingleFilterSearchRequest + - type: MultipleFilterSearchRequest + source: + openapi: ../openapi.yml + SearchRequest: + docs: Search using Intercoms Search APIs. + properties: + query: SearchRequestQuery + pagination: + type: optional + source: + openapi: ../openapi.yml + SegmentList: + docs: >- + This will return a list of Segment Objects. The result may also have a + pages object if the response is paginated. + properties: + type: + type: optional> + docs: The type of the object + segments: + type: optional> + docs: A list of Segment objects + pages: + type: optional> + docs: >- + A pagination object, which may be empty, indicating no further pages + to fetch. + source: + openapi: ../openapi.yml + SingleFilterSearchRequestOperator: + enum: + - value: '=' + name: EQUAL_TO + - value: '!=' + name: NOT_EQUALS + - IN + - NIN + - value: < + name: LESS_THAN + - value: '>' + name: GREATER_THAN + - value: '~' + name: '' + docs: >- + The accepted operators you can use to define how you want to search for + the value. + source: + openapi: ../openapi.yml + SingleFilterSearchRequest: + docs: Search using Intercoms Search APIs with a single filter. + properties: + field: + type: optional + docs: The accepted field that you want to search on. + operator: + type: optional + docs: >- + The accepted operators you can use to define how you want to search + for the value. + value: + type: optional + docs: The value that you want to search on. + source: + openapi: ../openapi.yml + SlaAppliedSlaStatus: + enum: + - hit + - missed + - cancelled + - active + docs: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + source: + openapi: ../openapi.yml + SlaApplied: + docs: > + The SLA Applied object contains the details for which SLA has been applied + to this conversation. + + Important: if there are any canceled sla_events for the conversation - + meaning an SLA has been manually removed from a conversation, the + sla_status will always be returned as null. + properties: + type: + type: optional + docs: object type + sla_name: + type: optional + docs: The name of the SLA as given by the teammate when it was created. + sla_status: + type: optional + docs: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + source: + openapi: ../openapi.yml + SnoozeConversationRequest: + docs: Payload of the request to snooze a conversation + properties: + admin_id: + type: string + docs: The id of the admin who is performing the action. + snoozed_until: + type: integer + docs: The time you want the conversation to reopen. + source: + openapi: ../openapi.yml + SocialProfile: + docs: >- + A Social Profile allows you to label your contacts, companies, and + conversations and list them using that Social Profile. + properties: + type: + type: optional + docs: value is "social_profile" + name: + type: optional + docs: The name of the Social media profile + url: + type: optional + docs: The name of the Social media profile + validation: + format: uri + source: + openapi: ../openapi.yml + StartingAfterPaging: + properties: + per_page: + type: optional + docs: The number of results to fetch per page. + starting_after: + type: optional + docs: The cursor to use in the next request to get the next page of results. + source: + openapi: ../openapi.yml + SubscriptionTypeList: + docs: A list of subscription type objects. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: A list of subscription type objects associated with the workspace . + source: + openapi: ../openapi.yml + TagCompanyRequestCompaniesItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the company. + company_id: + type: optional + docs: The company id you have defined for the company. + source: + openapi: ../openapi.yml + TagCompanyRequest: + docs: You can tag a single company or a list of companies. + properties: + name: + type: string + docs: The name of the tag, which will be created if not found. + companies: + docs: The id or company_id of the company can be passed as input parameters. + type: list + source: + openapi: ../openapi.yml + Tags: + docs: A list of tags objects associated with a conversation + properties: + type: + type: optional> + docs: The type of the object + tags: + type: optional> + docs: A list of tags objects associated with the conversation. + source: + openapi: ../openapi.yml + TagMultipleUsersRequestUsersItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the user. + source: + openapi: ../openapi.yml + TagMultipleUsersRequest: + docs: You can tag a list of users. + properties: + name: + type: string + docs: The name of the tag, which will be created if not found. + users: list + source: + openapi: ../openapi.yml + TeamList: + docs: This will return a list of team objects for the App. + properties: + type: + type: optional> + docs: The type of the object + teams: + type: optional> + docs: A list of team objects + source: + openapi: ../openapi.yml + TeamPriorityLevel: + docs: Admin priority levels for teams + properties: + primary_team_ids: + type: optional> + docs: The primary team ids for the team + secondary_team_ids: + type: optional> + docs: The secondary team ids for the team + source: + openapi: ../openapi.yml + TicketCustomAttributesValue: + discriminated: false + union: + - optional + - double + - boolean + - list + - type: File + source: + openapi: ../openapi.yml + TicketCustomAttributes: + type: map + docs: >- + An object containing the different attributes associated to the ticket as + key-value pairs. For the default title and description attributes, the + keys are `_default_title_` and `_default_description_`. + TicketList: + docs: Tickets are how you track requests from your users. + properties: + type: + type: optional> + docs: Always ticket.list + tickets: + type: optional>> + docs: The list of ticket objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + TicketPartAuthorType: + enum: + - admin + - bot + - team + - user + docs: The type of the author + source: + openapi: ../openapi.yml + TicketPartAuthor: + docs: >- + The author that wrote or triggered the part. Can be a bot, admin, team or + user. + properties: + type: + type: optional + docs: The type of the author + id: + type: optional + docs: The id of the author + name: + type: optional + docs: The name of the author + email: + type: optional + docs: The email of the author + validation: + format: email + source: + openapi: ../openapi.yml + TicketParts: + docs: >- + A list of Ticket Part objects for each note and event in the ticket. There + is a limit of 500 parts. + properties: + type: + type: optional> + docs: '' + ticket_parts: + type: optional> + docs: >- + A list of Ticket Part objects for each ticket. There is a limit of 500 + parts. + total_count: + type: optional + docs: '' + source: + openapi: ../openapi.yml + TicketReplyPartType: + enum: + - note + - comment + - quick_reply + docs: Type of the part + source: + openapi: ../openapi.yml + TicketReply: + docs: A Ticket Part representing a note, comment, or quick_reply on a ticket + properties: + type: + type: optional> + docs: Always ticket_part + id: + type: optional + docs: The id representing the part. + part_type: + type: optional + docs: Type of the part + body: + type: optional + docs: The message body, which may contain HTML. + created_at: + type: optional + docs: The time the note was created. + updated_at: + type: optional + docs: The last time the note was updated. + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + redacted: + type: optional + docs: Whether or not the ticket part has been redacted. + source: + openapi: ../openapi.yml + TicketRequestCustomAttributesValue: + discriminated: false + union: + - optional + - double + - boolean + - list + source: + openapi: ../openapi.yml + TicketRequestCustomAttributes: + type: map + docs: >- + The attributes set on the ticket. When setting the default title and + description attributes, the attribute keys that should be used are + `_default_title_` and `_default_description_`. When setting ticket type + attributes of the list attribute type, the key should be the attribute + name and the value of the attribute should be the list item id, obtainable + by [listing the ticket type](ref:get_ticket-types). For example, if the + ticket type has an attribute called `priority` of type `list`, the key + should be `priority` and the value of the attribute should be the guid of + the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + TicketTypeAttribute: + docs: >- + Ticket type attribute, used to define each data field to be captured in a + ticket. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type_attribute`. + id: + type: optional + docs: The id representing the ticket type attribute. + workspace_id: + type: optional + docs: The id of the workspace that the ticket type attribute belongs to. + name: + type: optional + docs: The name of the ticket type attribute + description: + type: optional + docs: The description of the ticket type attribute + data_type: + type: optional + docs: >- + The type of the data attribute (allowed values: "string list integer + decimal boolean datetime files") + input_options: + type: optional> + docs: Input options for the attribute + order: + type: optional + docs: The order of the attribute against other attributes + required_to_create: + type: optional + docs: Whether the attribute is required or not for teammates. + default: false + required_to_create_for_contacts: + type: optional + docs: Whether the attribute is required or not for contacts. + default: false + visible_on_create: + type: optional + docs: Whether the attribute is visible or not to teammates. + default: true + visible_to_contacts: + type: optional + docs: Whether the attribute is visible or not to contacts. + default: true + default: + type: optional + docs: Whether the attribute is built in or not. + ticket_type_id: + type: optional + docs: The id of the ticket type that the attribute belongs to. + archived: + type: optional + docs: Whether the ticket type attribute is archived or not. + created_at: + type: optional + docs: The date and time the ticket type attribute was created. + updated_at: + type: optional + docs: The date and time the ticket type attribute was last updated. + source: + openapi: ../openapi.yml + TicketTypeAttributeList: + docs: A list of attributes associated with a given ticket type. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: optional>> + docs: A list of ticket type attributes associated with a given ticket type. + source: + openapi: ../openapi.yml + TicketTypeList: + docs: A list of ticket types associated with a given workspace. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: optional>> + docs: A list of ticket_types associated with a given workspace. + source: + openapi: ../openapi.yml + Translation: + docs: >- + A translation object contains the localised details of a subscription + type. + properties: + name: + type: optional + docs: The localised name of the subscription type. + description: + type: optional + docs: The localised description of the subscription type. + locale: + type: optional + docs: >- + The two character identifier for the language of the translation + object. + source: + openapi: ../openapi.yml + UntagCompanyRequestCompaniesItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the company. + company_id: + type: optional + docs: The company id you have defined for the company. + untag: + type: optional + docs: Always set to true + source: + openapi: ../openapi.yml + UntagCompanyRequest: + docs: You can tag a single company or a list of companies. + properties: + name: + type: string + docs: The name of the tag which will be untagged from the company + companies: + docs: The id or company_id of the company can be passed as input parameters. + type: list + source: + openapi: ../openapi.yml + UpdateArticleRequestState: + enum: + - published + - draft + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults to + draft. For multilingual articles, this will be the state of the default + language's content. + source: + openapi: ../openapi.yml + UpdateArticleRequest: + docs: You can Update an Article + properties: + title: + type: optional + docs: >- + The title of the article.For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The content of the article. For multilingual articles, this will be + the body of the default language's content. + author_id: + type: optional + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults + to draft. For multilingual articles, this will be the state of the + default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + translated_content: + type: optional + source: + openapi: ../openapi.yml + UpdateTicketTypeRequestCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + UpdateTicketTypeRequest: + docs: > + The request payload for updating a ticket type. + + You can copy the `icon` property for your ticket type from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + properties: + name: + type: optional + docs: The name of the ticket type. + description: + type: optional + docs: The description of the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + icon: + type: optional + docs: The icon of the ticket type. + default: 🎟️ + archived: + type: optional + docs: The archived status of the ticket type. + is_internal: + type: optional + docs: >- + Whether the tickets associated with this ticket type are intended for + internal use only or will be shared with customers. This is currently + a limited attribute. + default: false + source: + openapi: ../openapi.yml + UpdateVisitorRequestOne: unknown + VisitorAvatar: + properties: + type: + type: optional + docs: '' + default: avatar + image_url: + type: optional + docs: This object represents the avatar associated with the visitor. + validation: + format: uri + source: + openapi: ../openapi.yml + VisitorCompanies: + properties: + type: + type: optional> + docs: The type of the object + companies: optional> + source: + openapi: ../openapi.yml + VisitorLocationData: + properties: + type: + type: optional + docs: '' + default: location_data + city_name: + type: optional + docs: The city name of the visitor. + continent_code: + type: optional + docs: The continent code of the visitor. + country_code: + type: optional + docs: The country code of the visitor. + country_name: + type: optional + docs: The country name of the visitor. + postal_code: + type: optional + docs: The postal code of the visitor. + region_name: + type: optional + docs: The region name of the visitor. + timezone: + type: optional + docs: The timezone of the visitor. + source: + openapi: ../openapi.yml + VisitorSocialProfiles: + properties: + type: + type: optional> + docs: The type of the object + social_profiles: optional> + source: + openapi: ../openapi.yml + VisitorTagsTagsItem: + properties: + type: + type: optional> + docs: The type of the object + id: + type: optional + docs: The id of the tag. + name: + type: optional + docs: The name of the tag. + source: + openapi: ../openapi.yml + VisitorTags: + properties: + type: + type: optional> + docs: The type of the object + tags: optional> + source: + openapi: ../openapi.yml + VisitorSegments: + properties: + type: + type: optional> + docs: The type of the object + segments: optional> + source: + openapi: ../openapi.yml + Visitor: + docs: >- + Visitors are useful for representing anonymous people that have not yet + been identified. They usually represent website visitors. Visitors are not + visible in Intercom platform. The Visitors resource provides methods to + fetch, update, convert and delete. + properties: + type: + type: optional + docs: Value is 'visitor' + default: visitor + id: + type: optional + docs: The Intercom defined id representing the Visitor. + user_id: + type: optional + docs: Automatically generated identifier for the Visitor. + anonymous: + type: optional + docs: Identifies if this visitor is anonymous. + email: + type: optional + docs: The email of the visitor. + validation: + format: email + phone: + type: optional + docs: The phone number of the visitor. + name: + type: optional + docs: The name of the visitor. + pseudonym: + type: optional + docs: The pseudonym of the visitor. + avatar: + type: optional + app_id: + type: optional + docs: The id of the app the visitor is associated with. + companies: + type: optional + location_data: + type: optional + las_request_at: + type: optional + docs: The time the Lead last recorded making a request. + created_at: + type: optional + docs: The time the Visitor was added to Intercom. + remote_created_at: + type: optional + docs: The time the Visitor was added to Intercom. + signed_up_at: + type: optional + docs: The time the Visitor signed up for your product. + updated_at: + type: optional + docs: The last time the Visitor was updated. + session_count: + type: optional + docs: The number of sessions the Visitor has had. + social_profiles: + type: optional + owner_id: + type: optional + docs: The id of the admin that owns the Visitor. + unsubscribed_from_emails: + type: optional + docs: Whether the Visitor is unsubscribed from emails. + marked_email_as_spam: + type: optional + docs: Identifies if this visitor has marked an email as spam. + has_hard_bounced: + type: optional + docs: Identifies if this visitor has had a hard bounce. + tags: + type: optional + segments: + type: optional + custom_attributes: + type: optional> + docs: The custom attributes you have set on the Visitor. + referrer: + type: optional + docs: The referer of the visitor. + utm_campaign: + type: optional + docs: The utm_campaign of the visitor. + utm_content: + type: optional + docs: The utm_content of the visitor. + utm_medium: + type: optional + docs: The utm_medium of the visitor. + utm_source: + type: optional + docs: The utm_source of the visitor. + utm_term: + type: optional + docs: The utm_term of the visitor. + do_not_track: + type: optional + docs: Identifies if this visitor has do not track enabled. + source: + openapi: ../openapi.yml + VisitorDeletedObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the visitor which is given by Intercom. + type: + type: optional> + docs: The type of object which was deleted + user_id: + type: optional + docs: Automatically generated identifier for the Visitor. + source: + openapi: ../openapi.yml +imports: + admins: admins.yml + articles: articles.yml + helpCenter: helpCenter.yml + contacts: contacts.yml + segments: segments.yml + companies: companies.yml + aiContentSource: aiContentSource.yml + conversations: conversations.yml + customObjectInstances: customObjectInstances.yml + dataAttributes: dataAttributes.yml + dataEvents: dataEvents.yml + news: news.yml + notes: notes.yml + subscriptionTypes: subscriptionTypes.yml + tags: tags.yml + teams: teams.yml + tickets: tickets.yml +", + }, + "admins.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Admins", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Admins", + "endpoints": { + "identifyAdmin": { + "auth": true, + "display-name": "Identify an admin", + "docs": " +You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + +> 🚧 Single Sign On +> +> If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk. +", + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "app": { + "created_at": 1719492696, + "id_code": "this_is_an_id1_that_should_be_at_least_40", + "identity_verification": false, + "name": "MyApp 1", + "region": "US", + "timezone": "America/Los_Angeles", + "type": "app", + }, + "avatar": { + "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png", + "type": "avatar", + }, + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin1@email.com", + "email_verified": true, + "has_inbox_seat": true, + "id": "991267390", + "job_title": "Philosopher", + "name": "Ciaran1 Lee", + "team_ids": [ + 814865, + ], + "type": "admin", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/me", + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listActivityLogs": { + "auth": true, + "display-name": "List all activity logs", + "docs": "You can get a log of activities by all admins in an app.", + "errors": [ + "root.ListActivityLogsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "query-parameters": { + "created_at_after": "1677253093", + "created_at_before": "1677861493", + }, + "response": { + "body": { + "activity_logs": [ + { + "activity_description": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title.", + "activity_type": "message_state_change", + "created_at": 1719492702, + "id": "ddee3a18-0032-4061-b9b9-26230c3dd5f7", + "performed_by": { + "email": "admin5@email.com", + "id": "991267395", + "ip": "127.0.0.1", + "type": "admin", + }, + }, + { + "activity_description": "Ciaran5 Lee changed your app name from before to after.", + "activity_type": "app_name_change", + "created_at": 1719492702, + "id": "5eec951b-db7a-4b5b-add5-95ffc90969b6", + "performed_by": { + "email": "admin5@email.com", + "id": "991267395", + "ip": "127.0.0.1", + "type": "admin", + }, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "type": "activity_log.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins/activity_logs", + "request": { + "name": "ListActivityLogsRequest", + "query-parameters": { + "created_at_after": { + "docs": "The start date that you request data for. It must be formatted as a UNIX timestamp.", + "type": "string", + }, + "created_at_before": { + "docs": "The end date that you request data for. It must be formatted as a UNIX timestamp.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.ActivityLogList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAdmins": { + "auth": true, + "display-name": "List all admins", + "docs": "You can fetch a list of admins for a given workspace.", + "errors": [ + "root.ListAdminsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "admins": [ + { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin7@email.com", + "has_inbox_seat": true, + "id": "991267397", + "job_title": "Philosopher", + "name": "Ciaran7 Lee", + "team_ids": [ + 814865, + ], + "type": "admin", + }, + ], + "type": "admin.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins", + "response": { + "docs": "Successful response", + "type": "root.Admins", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveAdmin": { + "auth": true, + "display-name": "Retrieve an admin", + "docs": "You can retrieve the details of a single admin.", + "errors": [ + "root.RetrieveAdminRequestUnauthorizedError", + "root.RetrieveAdminRequestNotFoundError", + ], + "examples": [ + { + "name": "Admin found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin9@email.com", + "has_inbox_seat": true, + "id": "991267399", + "job_title": "Philosopher", + "name": "Ciaran9 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given admin", + "type": "integer", + }, + }, + "response": { + "docs": "Admin found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "setAwayAdmin": { + "auth": true, + "display-name": "Set an admin to away", + "docs": "You can set an Admin as away for the Inbox.", + "errors": [ + "root.SetAwayAdminRequestUnauthorizedError", + "root.SetAwayAdminRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + { + "name": "Unauthorized", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/admins/{id}/away", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given admin", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "away_mode_enabled": { + "default": true, + "docs": "Set to "true" to change the status of the admin to away.", + "type": "boolean", + }, + "away_mode_reassign": { + "default": false, + "docs": "Set to "true" to assign any new conversation replies to your default inbox.", + "type": "boolean", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "SetAwayAdminRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Admin": { + "docs": "Admins are teammate accounts that have access to a workspace.", + "properties": { + "avatar": { + "docs": "Image for the associated team or teammate", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "away_mode_enabled": { + "docs": "Identifies if this admin is currently set in away mode.", + "type": "optional", + }, + "away_mode_reassign": { + "docs": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "type": "optional", + }, + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "has_inbox_seat": { + "docs": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "job_title": { + "docs": "The job title of the admin.", + "type": "optional", + }, + "name": { + "docs": "The name of the admin.", + "type": "optional", + }, + "team_ids": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional>", + }, + "team_priority_level": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + identifyAdmin: + path: /me + method: GET + auth: true + docs: > + + You can view the currently authorised admin along with the embedded app + object (a "workspace" in legacy terminology). + + + > 🚧 Single Sign On + + > + + > If you are building a custom "Log in with Intercom" flow for your + site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email + addresses as it poses a potential impersonation security risk. + source: + openapi: ../openapi.yml + display-name: Identify an admin + response: + docs: Successful response + type: optional + examples: + - name: Successful response + response: + body: + type: admin + id: '991267390' + name: Ciaran1 Lee + email: admin1@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/assets/default-avatars/admins/128.png + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + region: US + timezone: America/Los_Angeles + created_at: 1719492696 + identity_verification: false + setAwayAdmin: + path: /admins/{id}/away + method: PUT + auth: true + docs: You can set an Admin as away for the Inbox. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given admin + display-name: Set an admin to away + request: + name: SetAwayAdminRequest + body: + properties: + away_mode_enabled: + type: boolean + docs: Set to "true" to change the status of the admin to away. + default: true + away_mode_reassign: + type: boolean + docs: >- + Set to "true" to assign any new conversation replies to your + default inbox. + default: false + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.SetAwayAdminRequestUnauthorizedError + - root.SetAwayAdminRequestNotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + - name: Admin not found + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + - name: Unauthorized + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + listActivityLogs: + path: /admins/activity_logs + method: GET + auth: true + docs: You can get a log of activities by all admins in an app. + source: + openapi: ../openapi.yml + display-name: List all activity logs + request: + name: ListActivityLogsRequest + query-parameters: + created_at_after: + type: string + docs: >- + The start date that you request data for. It must be formatted as + a UNIX timestamp. + created_at_before: + type: optional + docs: >- + The end date that you request data for. It must be formatted as a + UNIX timestamp. + response: + docs: Successful response + type: root.ActivityLogList + errors: + - root.ListActivityLogsRequestUnauthorizedError + examples: + - name: Successful response + query-parameters: + created_at_after: '1677253093' + created_at_before: '1677861493' + response: + body: + type: activity_log.list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + activity_logs: + - id: ddee3a18-0032-4061-b9b9-26230c3dd5f7 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + created_at: 1719492702 + activity_type: message_state_change + activity_description: >- + Ciaran5 Lee changed your Initial message title message from + Initial message title to Eventual message title. + - id: 5eec951b-db7a-4b5b-add5-95ffc90969b6 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + created_at: 1719492702 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from before to after. + listAdmins: + path: /admins + method: GET + auth: true + docs: You can fetch a list of admins for a given workspace. + source: + openapi: ../openapi.yml + display-name: List all admins + response: + docs: Successful response + type: root.Admins + errors: + - root.ListAdminsRequestUnauthorizedError + examples: + - name: Successful response + response: + body: + type: admin.list + admins: + - type: admin + id: '991267397' + name: Ciaran7 Lee + email: admin7@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + retrieveAdmin: + path: /admins/{id} + method: GET + auth: true + docs: You can retrieve the details of a single admin. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given admin + display-name: Retrieve an admin + response: + docs: Admin found + type: optional + errors: + - root.RetrieveAdminRequestUnauthorizedError + - root.RetrieveAdminRequestNotFoundError + examples: + - name: Admin found + path-parameters: + id: 1 + response: + body: + type: admin + id: '991267399' + name: Ciaran9 Lee + email: admin9@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + source: + openapi: ../openapi.yml + display-name: Admins +docs: Everything about your Admins +types: + Admin: + docs: Admins are teammate accounts that have access to a workspace. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + name: + type: optional + docs: The name of the admin. + email: + type: optional + docs: The email of the admin. + job_title: + type: optional + docs: The job title of the admin. + away_mode_enabled: + type: optional + docs: Identifies if this admin is currently set in away mode. + away_mode_reassign: + type: optional + docs: >- + Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + has_inbox_seat: + type: optional + docs: >- + Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + team_ids: + type: optional> + docs: This object represents the avatar associated with the admin. + avatar: + type: optional + docs: Image for the associated team or teammate + validation: + format: uri + team_priority_level: + type: optional + source: + openapi: ../openapi.yml +", + }, + "aiAgent.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "imports": { + "root": "__package__.yml", + }, + "types": { + "AiAgent": { + "docs": "Data related to AI Agent involvement in the conversation.", + "properties": { + "content_sources": { + "type": "optional", + }, + "last_answer_type": { + "docs": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`", + "type": "optional", + }, + "rating": { + "docs": "The customer satisfaction rating given to AI Agent, from 1-5.", + "type": "optional", + }, + "rating_remark": { + "docs": "The customer satisfaction rating remark given to AI Agent.", + "type": "optional", + }, + "resolution_state": { + "docs": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.", + "type": "optional", + }, + "source_title": { + "docs": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.", + "type": "optional", + }, + "source_type": { + "docs": "The type of the source that triggered AI Agent involvement in the conversation.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AiAgentSourceType": { + "docs": "The type of the source that triggered AI Agent involvement in the conversation.", + "enum": [ + "essentials_plan_setup", + "profile", + "workflow", + "workflow_preview", + "fin_preview", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + AiAgentSourceType: + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + docs: >- + The type of the source that triggered AI Agent involvement in the + conversation. + source: + openapi: ../openapi.yml + AiAgent: + docs: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: optional + docs: >- + The type of the source that triggered AI Agent involvement in the + conversation. + source_title: + type: optional + docs: >- + The title of the source that triggered AI Agent involvement in the + conversation. If this is `essentials_plan_setup` then it will return + `null`. + last_answer_type: + type: optional + docs: >- + The type of the last answer delivered by AI Agent. If no answer was + delivered then this will return `null` + resolution_state: + type: optional + docs: >- + The resolution state of AI Agent. If no AI or custom answer has been + delivered then this will return `null`. + rating: + type: optional + docs: The customer satisfaction rating given to AI Agent, from 1-5. + rating_remark: + type: optional + docs: The customer satisfaction rating remark given to AI Agent. + content_sources: + type: optional + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +", + }, + "aiContentSource.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "types": { + "ContentSource": { + "docs": "The content source used by AI Agent in the conversation.", + "properties": { + "content_type": { + "docs": "The type of the content source.", + "type": "optional", + }, + "locale": { + "docs": "The ISO 639 language code of the content source.", + "type": "optional", + }, + "title": { + "docs": "The title of the content source.", + "type": "optional", + }, + "url": { + "docs": "The internal URL linking to the content source for teammates.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContentSourceContentType": { + "docs": "The type of the content source.", + "enum": [ + "file", + "article", + "external_content", + "content_snippet", + "workflow_connector_action", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + ContentSourceContentType: + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + docs: The type of the content source. + source: + openapi: ../openapi.yml + ContentSource: + docs: The content source used by AI Agent in the conversation. + properties: + content_type: + type: optional + docs: The type of the content source. + url: + type: optional + docs: The internal URL linking to the content source for teammates. + title: + type: optional + docs: The title of the content source. + locale: + type: optional + docs: The ISO 639 language code of the content source. + source: + openapi: ../openapi.yml +", + }, + "articles.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Articles", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Articles", + "endpoints": { + "createArticle": { + "auth": true, + "display-name": "Create an article", + "docs": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "errors": [ + "root.CreateArticleRequestBadRequestError", + "root.CreateArticleRequestUnauthorizedError", + ], + "examples": [ + { + "name": "article created", + "request": { + "author_id": 991267407, + "body": "Body of the Article", + "description": "Description of the Article", + "parent_id": 145, + "parent_type": "collection", + "state": "published", + "title": "Thanks for everything", + "translated_content": { + "fr": { + "author_id": 991267407, + "body": "Corps de l'article", + "description": "Description de l'article", + "state": "published", + "title": "Merci pour tout", + }, + }, + }, + "response": { + "body": { + "author_id": 991267407, + "body": "

Body of the Article

", + "created_at": 1719492710, + "default_locale": "en", + "description": "Description of the Article", + "id": "42", + "parent_id": 145, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Thanks for everything", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Bad Request", + "request": { + "author_id": 1295, + "body": "Body of the Article", + "description": "Description of the Article", + "state": "published", + "title": "Thanks for everything", + }, + "response": { + "body": { + "author_id": 991267407, + "body": "

Body of the Article

", + "created_at": 1719492710, + "default_locale": "en", + "description": "Description of the Article", + "id": "42", + "parent_id": 145, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Thanks for everything", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/articles", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "article created", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteArticle": { + "auth": true, + "display-name": "Delete an article", + "docs": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.DeleteArticleRequestUnauthorizedError", + "root.DeleteArticleRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "51", + "object": "article", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedArticleObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listArticles": { + "auth": true, + "display-name": "List all articles", + "docs": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. + +> 📘 How are the articles sorted and ordered? +> +> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first. +", + "errors": [ + "root.ListArticlesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "author_id": 991267402, + "body": "", + "created_at": 1719492707, + "default_locale": "en", + "description": "", + "id": "39", + "parent_id": 143, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "title": "This is the article title", + "type": "article", + "updated_at": 1719492707, + "url": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title", + "workspace_id": "this_is_an_id33_that_should_be_at_least_4", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 25, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles", + "response": { + "docs": "successful", + "type": "root.Articles", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveArticle": { + "auth": true, + "display-name": "Retrieve an article", + "docs": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.RetrieveArticleRequestUnauthorizedError", + "root.RetrieveArticleRequestNotFoundError", + ], + "examples": [ + { + "name": "Article found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "author_id": 991267412, + "body": "", + "created_at": 1719492712, + "default_locale": "en", + "description": "", + "id": "45", + "parent_id": 148, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "This is the article title", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492712, + "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title", + "workspace_id": "this_is_an_id43_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Article found", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchArticles": { + "auth": true, + "display-name": "Search for articles", + "docs": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "errors": [ + "root.SearchArticlesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Search successful", + "query-parameters": { + "phrase": "Getting started", + "state": "published", + }, + "response": { + "body": { + "data": { + "articles": [ + { + "author_id": 991267431, + "body": "", + "created_at": 1719492719, + "default_locale": "en", + "description": "", + "id": "55", + "parent_ids": [ + 18, + 19, + ], + "state": "draft", + "title": "Title 1", + "type": "article", + "updated_at": 1719492719, + "workspace_id": "this_is_an_id61_that_should_be_at_least_4", + }, + ], + "highlights": [ + { + "article_id": "123", + }, + ], + }, + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles/search", + "request": { + "name": "SearchArticlesRequest", + "query-parameters": { + "help_center_id": { + "docs": "The ID of the Help Center to search in.", + "type": "optional", + }, + "highlight": { + "docs": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.", + "type": "optional", + }, + "phrase": { + "docs": "The phrase within your articles to search for.", + "type": "optional", + }, + "state": { + "docs": "The state of the Articles returned. One of `published`, `draft` or `all`.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Search successful", + "type": "ArticleSearchResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateArticle": { + "auth": true, + "display-name": "Update an article", + "docs": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.UpdateArticleRequestUnauthorizedError", + "root.UpdateArticleRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "title": "Christmas is here!", + }, + "response": { + "body": { + "author_id": 991267418, + "body": "

New gifts in store for the jolly season

", + "created_at": 1719492714, + "default_locale": "en", + "description": "", + "id": "48", + "parent_id": 151, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Christmas is here!", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Article Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "title": "Christmas is here!", + }, + "response": { + "body": { + "author_id": 991267418, + "body": "

New gifts in store for the jolly season

", + "created_at": 1719492714, + "default_locale": "en", + "description": "", + "id": "48", + "parent_id": 151, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Christmas is here!", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Article": { + "docs": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.", + "extends": [ + "Articles", + ], + "properties": { + "statistics": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleListItemState": { + "default": "draft", + "docs": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlights": { + "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "properties": { + "article_id": { + "docs": "The ID of the corresponding article.", + "type": "optional", + }, + "highlighted_summary": { + "docs": "An Article description and body text highlighted.", + "type": "optional>>", + }, + "highlighted_title": { + "docs": "An Article title highlighted.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedSummaryItemItem": { + "docs": "An instance of highlighted summary text.", + "properties": { + "text": { + "docs": "The text of the title.", + "type": "optional", + }, + "type": { + "docs": "The type of text - `highlight` or `plain`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedSummaryItemItemType": { + "docs": "The type of text - `highlight` or `plain`.", + "enum": [ + "highlight", + "plain", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedTitleItem": { + "docs": "A highlighted article title.", + "properties": { + "text": { + "docs": "The text of the title.", + "type": "optional", + }, + "type": { + "docs": "The type of text - `highlight` or `plain`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedTitleItemType": { + "docs": "The type of text - `highlight` or `plain`.", + "enum": [ + "highlight", + "plain", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchResponse": { + "docs": "The results of an Article search", + "properties": { + "data": { + "docs": "An object containing the results of the search.", + "type": "optional", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of Articles matching the search query", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchResponseData": { + "docs": "An object containing the results of the search.", + "properties": { + "articles": { + "docs": "An array of Article objects", + "type": "optional>", + }, + "highlights": { + "docs": "A corresponding array of highlighted Article content", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Articles": { + "docs": "The data returned about your articles when you list them.", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "optional", + }, + "body": { + "docs": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "created_at": { + "docs": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.", + "type": "optional", + }, + "default_locale": { + "docs": "The default locale of the help center. This field is only returned for multilingual help centers.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_ids": { + "docs": "The ids of the article's parent collections or sections. An article without this field stands alone.", + "type": "optional>", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "default": "draft", + "docs": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article. For multilingual articles, this will be the title of the default language's content.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + "type": { + "docs": "The type of object - `article`.", + "type": "optional>", + }, + "updated_at": { + "docs": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.", + "type": "optional", + }, + "url": { + "docs": "The URL of the article. For multilingual articles, this will be the URL of the default language's content.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the article belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listArticles: + path: /articles + method: GET + auth: true + docs: > + You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`. + + + > 📘 How are the articles sorted and ordered? + + > + + > Articles will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll + show the most recently updated articles first. + source: + openapi: ../openapi.yml + display-name: List all articles + response: + docs: successful + type: root.Articles + errors: + - root.ListArticlesRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - type: article + id: '39' + workspace_id: this_is_an_id33_that_should_be_at_least_4 + title: This is the article title + description: '' + body: '' + author_id: 991267402 + state: published + created_at: 1719492707 + updated_at: 1719492707 + url: >- + http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title + parent_id: 143 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + createArticle: + path: /articles + method: POST + auth: true + docs: >- + You can create a new article by making a POST request to + `https://api.intercom.io/articles`. + source: + openapi: ../openapi.yml + display-name: Create an article + request: + body: + type: optional + content-type: application/json + response: + docs: article created + type: Article + errors: + - root.CreateArticleRequestBadRequestError + - root.CreateArticleRequestUnauthorizedError + examples: + - name: article created + request: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991267407 + state: published + parent_id: 145 + parent_type: collection + translated_content: + fr: + title: Merci pour tout + description: Description de l'article + body: Corps de l'article + author_id: 991267407 + state: published + response: + body: + type: article + id: '42' + workspace_id: this_is_an_id37_that_should_be_at_least_4 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: >- + http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + parent_id: 145 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + - name: Bad Request + request: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 1295 + state: published + response: + body: + type: article + id: '42' + workspace_id: this_is_an_id37_that_should_be_at_least_4 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: >- + http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + parent_id: 145 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + retrieveArticle: + path: /articles/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single article by making a GET request to + `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Retrieve an article + response: + docs: Article found + type: Article + errors: + - root.RetrieveArticleRequestUnauthorizedError + - root.RetrieveArticleRequestNotFoundError + examples: + - name: Article found + path-parameters: + id: 1 + response: + body: + type: article + id: '45' + workspace_id: this_is_an_id43_that_should_be_at_least_4 + title: This is the article title + description: '' + body: '' + author_id: 991267412 + state: published + created_at: 1719492712 + updated_at: 1719492712 + url: >- + http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title + parent_id: 148 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + updateArticle: + path: /articles/{id} + method: PUT + auth: true + docs: >- + You can update the details of a single article by making a PUT request + to `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Update an article + request: + body: + type: optional + content-type: application/json + response: + docs: successful + type: Article + errors: + - root.UpdateArticleRequestUnauthorizedError + - root.UpdateArticleRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ response: + body: + type: article + id: '48' + workspace_id: this_is_an_id49_that_should_be_at_least_4 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: >- + http://help-center.test/myapp-49/en/articles/48-christmas-is-here + parent_id: 151 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + - name: Article Not Found + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ response: + body: + type: article + id: '48' + workspace_id: this_is_an_id49_that_should_be_at_least_4 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: >- + http://help-center.test/myapp-49/en/articles/48-christmas-is-here + parent_id: 151 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + deleteArticle: + path: /articles/{id} + method: DELETE + auth: true + docs: >- + You can delete a single article by making a DELETE request to + `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Delete an article + response: + docs: successful + type: root.DeletedArticleObject + errors: + - root.DeleteArticleRequestUnauthorizedError + - root.DeleteArticleRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '51' + object: article + deleted: true + searchArticles: + path: /articles/search + method: GET + auth: true + docs: >- + You can search for articles by making a GET request to + `https://api.intercom.io/articles/search`. + source: + openapi: ../openapi.yml + display-name: Search for articles + request: + name: SearchArticlesRequest + query-parameters: + phrase: + type: optional + docs: The phrase within your articles to search for. + state: + type: optional + docs: >- + The state of the Articles returned. One of `published`, `draft` or + `all`. + help_center_id: + type: optional + docs: The ID of the Help Center to search in. + highlight: + type: optional + docs: >- + Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + response: + docs: Search successful + type: ArticleSearchResponse + errors: + - root.SearchArticlesRequestUnauthorizedError + examples: + - name: Search successful + query-parameters: + phrase: Getting started + state: published + response: + body: + type: list + total_count: 1 + data: + articles: + - type: article + id: '55' + workspace_id: this_is_an_id61_that_should_be_at_least_4 + title: Title 1 + description: '' + body: '' + author_id: 991267431 + state: draft + created_at: 1719492719 + updated_at: 1719492719 + parent_ids: + - 18 + - 19 + default_locale: en + highlights: + - article_id: '123' + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + source: + openapi: ../openapi.yml + display-name: Articles +docs: Everything about your Articles +types: + Article: + docs: >- + The Articles API is a central place to gather all information and take + actions on your articles. Articles can live within collections and + sections, or alternatively they can stand alone. + properties: + statistics: + type: optional + extends: + - Articles + source: + openapi: ../openapi.yml + ArticleListItemState: + enum: + - published + - draft + docs: >- + Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + default: draft + source: + openapi: ../openapi.yml + Articles: + docs: The data returned about your articles when you list them. + properties: + type: + type: optional> + docs: The type of object - `article`. + id: + type: optional + docs: The unique identifier for the article which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the article belongs to. + title: + type: optional + docs: >- + The title of the article. For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The body of the article in HTML. For multilingual articles, this will + be the body of the default language's content. + author_id: + type: optional + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + default: draft + created_at: + type: optional + docs: >- + The time when the article was created. For multilingual articles, this + will be the timestamp of creation of the default language's content in + seconds. + updated_at: + type: optional + docs: >- + The time when the article was last updated. For multilingual articles, + this will be the timestamp of last update of the default language's + content in seconds. + url: + type: optional + docs: >- + The URL of the article. For multilingual articles, this will be the + URL of the default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_ids: + type: optional> + docs: >- + The ids of the article's parent collections or sections. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + default_locale: + type: optional + docs: >- + The default locale of the help center. This field is only returned for + multilingual help centers. + translated_content: + type: optional + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedTitleItemType: + enum: + - highlight + - plain + docs: The type of text - `highlight` or `plain`. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedTitleItem: + docs: A highlighted article title. + properties: + type: + type: optional + docs: The type of text - `highlight` or `plain`. + text: + type: optional + docs: The text of the title. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedSummaryItemItemType: + enum: + - highlight + - plain + docs: The type of text - `highlight` or `plain`. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedSummaryItemItem: + docs: An instance of highlighted summary text. + properties: + type: + type: optional + docs: The type of text - `highlight` or `plain`. + text: + type: optional + docs: The text of the title. + source: + openapi: ../openapi.yml + ArticleSearchHighlights: + docs: >- + The highlighted results of an Article search. In the examples provided my + search query is always "my query". + properties: + article_id: + type: optional + docs: The ID of the corresponding article. + highlighted_title: + type: optional> + docs: An Article title highlighted. + highlighted_summary: + type: >- + optional>> + docs: An Article description and body text highlighted. + source: + openapi: ../openapi.yml + ArticleSearchResponseData: + docs: An object containing the results of the search. + properties: + articles: + type: optional> + docs: An array of Article objects + highlights: + type: optional> + docs: A corresponding array of highlighted Article content + source: + openapi: ../openapi.yml + ArticleSearchResponse: + docs: The results of an Article search + properties: + type: + type: optional> + docs: The type of the object - `list`. + total_count: + type: optional + docs: The total number of Articles matching the search query + data: + type: optional + docs: An object containing the results of the search. + pages: + type: optional + source: + openapi: ../openapi.yml +", + }, + "companies.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Companies", + "imports": { + "root": "__package__.yml", + "segments": "segments.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Companies", + "endpoints": { + "ListAttachedContacts": { + "auth": true, + "display-name": "List attached contacts", + "docs": "You can fetch a list of all contacts that belong to a company.", + "errors": [ + "root.ListAttachedContactsRequestUnauthorizedError", + "root.ListAttachedContactsRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 50, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}/contacts", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.CompanyAttachedContacts", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ListAttachedSegmentsForCompanies": { + "auth": true, + "display-name": "List attached segments for companies", + "docs": "You can fetch a list of all segments that belong to a company.", + "errors": [ + "root.ListAttachedSegmentsForCompaniesRequestUnauthorizedError", + "root.ListAttachedSegmentsForCompaniesRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "data": [ + { + "count": 3, + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "person_type": "contact", + "type": "segment", + "updated_at": 1394622004, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}/segments", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.CompanyAttachedSegments", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RetrieveACompanyById": { + "auth": true, + "display-name": "Retrieve a company by ID", + "docs": "You can fetch a single company.", + "errors": [ + "root.RetrieveACompanyByIdRequestUnauthorizedError", + "root.RetrieveACompanyByIdRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "app_id": "this_is_an_id128_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492736, + "custom_attributes": { + "key": "value", + }, + "id": "667d60808a68186f43bafd31", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492736, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492736, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateCompany": { + "auth": true, + "display-name": "Update a company", + "docs": "You can update a single company using the Intercom provisioned `id`. + +{% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. +{% /admonition %} +", + "errors": [ + "root.UpdateCompanyRequestUnauthorizedError", + "root.UpdateCompanyRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "app_id": "this_is_an_id134_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492738, + "custom_attributes": { + "key": "value", + }, + "id": "667d60828a68186f43bafd3b", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company2", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492738, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492738, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachContactToACompany": { + "auth": true, + "display-name": "Attach a Contact to a Company", + "docs": "You can attach a company to a single contact.", + "errors": [ + "root.AttachContactToACompanyRequestBadRequestError", + "root.AttachContactToACompanyRequestUnauthorizedError", + "root.AttachContactToACompanyRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "667d608d8a68186f43bafd70", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + { + "name": "Bad Request", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "58a430d35458202d41b1e65b", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + { + "name": "Company Not Found", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "123", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/companies", + "path-parameters": { + "id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "id": { + "availability": undefined, + "docs": "The unique identifier for the company which is given by Intercom", + "name": "companyId", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachContactToACompanyRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createOrUpdateCompany": { + "auth": true, + "display-name": "Create or Update a company", + "docs": "You can create or update a company. + +Companies will be only visible in Intercom when there is at least one associated user. + +Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + +{% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. +{% /admonition %} +", + "errors": [ + "root.CreateOrUpdateCompanyRequestBadRequestError", + "root.CreateOrUpdateCompanyRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "request": { + "company_id": "company_remote_id", + "name": "my company", + "remote_created_at": 1374138000, + }, + "response": { + "body": { + "app_id": "this_is_an_id116_that_should_be_at_least_", + "company_id": "company_remote_id", + "created_at": 1719492732, + "custom_attributes": { + "creation_source": "api", + }, + "id": "667d607c8a68186f43bafd1e", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "my company", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1374138000, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492732, + "user_count": 0, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/companies", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteCompany": { + "auth": true, + "display-name": "Delete a company", + "docs": "You can delete a single company.", + "errors": [ + "root.DeleteCompanyRequestUnauthorizedError", + "root.DeleteCompanyRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "deleted": true, + "id": "667d60848a68186f43bafd45", + "object": "company", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.DeletedCompanyObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachContactFromACompany": { + "auth": true, + "display-name": "Detach a contact from a company", + "docs": "You can detach a company from a single contact.", + "errors": [ + "root.DetachContactFromACompanyRequestUnauthorizedError", + "root.DetachContactFromACompanyRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "58a430d35458202d41b1e65b", + "id": "58a430d35458202d41b1e65b", + }, + "response": { + "body": { + "app_id": "this_is_an_id174_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492753, + "custom_attributes": { + "key": "value", + }, + "id": "667d60918a68186f43bafd80", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company8", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492753, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492753, + "user_count": 0, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/companies/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAllCompanies": { + "auth": true, + "display-name": "List all companies", + "docs": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + +Note that the API does not include companies who have no associated users in list responses. + +When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.ListAllCompaniesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "query-parameters": { + "order": "desc", + }, + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id158_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492746, + "custom_attributes": { + "key": "value", + }, + "id": "667d608a8a68186f43bafd61", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492746, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492746, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 15, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/companies/list", + "request": { + "name": "ListAllCompaniesRequest", + "query-parameters": { + "order": { + "docs": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc", + "type": "optional", + }, + "page": { + "docs": "The page of results to fetch. Defaults to first page", + "type": "optional", + }, + "per_page": { + "docs": "How many results to return per page. Defaults to 15", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "root.Companies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveCompany": { + "auth": true, + "display-name": "Retrieve companies", + "docs": "You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + +You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` +", + "errors": [ + "root.RetrieveCompanyRequestUnauthorizedError", + "root.RetrieveCompanyRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "query-parameters": { + "company_id": "12345", + "name": "my company", + "segment_id": "98765", + "tag_id": "678910", + }, + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id122_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492734, + "custom_attributes": { + "key": "value", + }, + "id": "667d607e8a68186f43bafd26", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492734, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492734, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 15, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies", + "request": { + "name": "RetrieveCompanyRequest", + "query-parameters": { + "company_id": { + "docs": "The `company_id` of the company to filter by.", + "type": "optional", + }, + "name": { + "docs": "The `name` of the company to filter by.", + "type": "optional", + }, + "page": { + "docs": "The page of results to fetch. Defaults to first page", + "type": "optional", + }, + "per_page": { + "docs": "How many results to display per page. Defaults to 15", + "type": "optional", + }, + "segment_id": { + "docs": "The `segment_id` of the company to filter by.", + "type": "optional", + }, + "tag_id": { + "docs": "The `tag_id` of the company to filter by.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "root.Companies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "scrollOverAllCompanies": { + "auth": true, + "display-name": "Scroll over all companies", + "docs": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + +- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. +- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail +- If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + +{% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. +{% /admonition %} +{% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. +{% /admonition %} +", + "errors": [ + "root.ScrollOverAllCompaniesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id162_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492747, + "custom_attributes": { + "key": "value", + }, + "id": "667d608b8a68186f43bafd67", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492747, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492747, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 2, + "total_pages": 13, + "type": "pages", + }, + "scroll_param": "12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc", + "total_count": 100, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/scroll", + "request": { + "name": "ScrollOverAllCompaniesRequest", + "query-parameters": { + "scroll_param": { + "docs": "", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Company": { + "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "properties": { + "app_id": { + "docs": "The Intercom defined code of the workspace the company is associated to.", + "type": "optional", + }, + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "created_at": { + "docs": "The time the company was added in Intercom.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes you have set on the company.", + "type": "optional>", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + "industry": { + "docs": "The industry that the company operates in.", + "type": "optional", + }, + "last_request_at": { + "docs": "The time the company last recorded making a request.", + "type": "optional", + }, + "monthly_spend": { + "docs": "How much revenue the company generates for your business.", + "type": "optional", + }, + "name": { + "docs": "The name of the company.", + "type": "optional", + }, + "plan": { + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the company was created by you.", + "type": "optional", + }, + "segments": { + "docs": "The list of segments associated with the company", + "type": "optional", + }, + "session_count": { + "docs": "How many sessions the company has recorded.", + "type": "optional", + }, + "size": { + "docs": "The number of employees in the company.", + "type": "optional", + }, + "tags": { + "docs": "The list of tags associated with the company", + "type": "optional", + }, + "type": { + "docs": "Value is `company`", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the company was updated.", + "type": "optional", + }, + "user_count": { + "docs": "The number of users in the company.", + "type": "optional", + }, + "website": { + "docs": "The URL for the company website.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyPlan": { + "docs": undefined, + "properties": { + "id": { + "docs": "The id of the plan", + "type": "optional", + }, + "name": { + "docs": "The name of the plan", + "type": "optional", + }, + "type": { + "docs": "Value is always "plan"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanySegments": { + "docs": "The list of segments associated with the company", + "properties": { + "segments": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyTags": { + "docs": "The list of tags associated with the company", + "properties": { + "tags": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + segments: segments.yml +service: + auth: false + base-path: '' + endpoints: + retrieveCompany: + path: /companies + method: GET + auth: true + docs: > + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a + query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` + source: + openapi: ../openapi.yml + display-name: Retrieve companies + request: + name: RetrieveCompanyRequest + query-parameters: + name: + type: optional + docs: The `name` of the company to filter by. + company_id: + type: optional + docs: The `company_id` of the company to filter by. + tag_id: + type: optional + docs: The `tag_id` of the company to filter by. + segment_id: + type: optional + docs: The `segment_id` of the company to filter by. + page: + type: optional + docs: The page of results to fetch. Defaults to first page + per_page: + type: optional + docs: How many results to display per page. Defaults to 15 + response: + docs: Successful + type: root.Companies + errors: + - root.RetrieveCompanyRequestUnauthorizedError + - root.RetrieveCompanyRequestNotFoundError + examples: + - name: Successful + query-parameters: + name: my company + company_id: '12345' + tag_id: '678910' + segment_id: '98765' + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 15 + total_pages: 1 + total_count: 1 + data: + - type: company + id: 667d607e8a68186f43bafd26 + name: IntercomQATest1 + app_id: this_is_an_id122_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492734 + created_at: 1719492734 + updated_at: 1719492734 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + createOrUpdateCompany: + path: /companies + method: POST + auth: true + docs: > + You can create or update a company. + + + Companies will be only visible in Intercom when there is at least one + associated user. + + + Companies are looked up via `company_id` in a `POST` request, if not + found via `company_id`, the new company will be created, if found, that + company will be updated. + + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: Create or Update a company + request: + body: + type: optional + content-type: application/json + response: + docs: Successful + type: Company + errors: + - root.CreateOrUpdateCompanyRequestBadRequestError + - root.CreateOrUpdateCompanyRequestUnauthorizedError + examples: + - name: Successful + request: + name: my company + company_id: company_remote_id + remote_created_at: 1374138000 + response: + body: + type: company + id: 667d607c8a68186f43bafd1e + name: my company + app_id: this_is_an_id116_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: company_remote_id + remote_created_at: 1374138000 + created_at: 1719492732 + updated_at: 1719492732 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 0 + custom_attributes: + creation_source: api + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + RetrieveACompanyById: + path: /companies/{id} + method: GET + auth: true + docs: You can fetch a single company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Retrieve a company by ID + response: + docs: Successful + type: Company + errors: + - root.RetrieveACompanyByIdRequestUnauthorizedError + - root.RetrieveACompanyByIdRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: company + id: 667d60808a68186f43bafd31 + name: company1 + app_id: this_is_an_id128_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492736 + created_at: 1719492736 + updated_at: 1719492736 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + UpdateCompany: + path: /companies/{id} + method: PUT + auth: true + docs: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Update a company + response: + docs: Successful + type: Company + errors: + - root.UpdateCompanyRequestUnauthorizedError + - root.UpdateCompanyRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: company + id: 667d60828a68186f43bafd3b + name: company2 + app_id: this_is_an_id134_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492738 + created_at: 1719492738 + updated_at: 1719492738 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + deleteCompany: + path: /companies/{id} + method: DELETE + auth: true + docs: You can delete a single company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Delete a company + response: + docs: Successful + type: root.DeletedCompanyObject + errors: + - root.DeleteCompanyRequestUnauthorizedError + - root.DeleteCompanyRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + id: 667d60848a68186f43bafd45 + object: company + deleted: true + ListAttachedContacts: + path: /companies/{id}/contacts + method: GET + auth: true + docs: You can fetch a list of all contacts that belong to a company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: List attached contacts + response: + docs: Successful + type: root.CompanyAttachedContacts + errors: + - root.ListAttachedContactsRequestUnauthorizedError + - root.ListAttachedContactsRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 50 + total_pages: 0 + ListAttachedSegmentsForCompanies: + path: /companies/{id}/segments + method: GET + auth: true + docs: You can fetch a list of all segments that belong to a company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: List attached segments for companies + response: + docs: Successful + type: root.CompanyAttachedSegments + errors: + - root.ListAttachedSegmentsForCompaniesRequestUnauthorizedError + - root.ListAttachedSegmentsForCompaniesRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: list + data: + - type: segment + id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + person_type: contact + count: 3 + listAllCompanies: + path: /companies/list + method: POST + auth: true + docs: > + You can list companies. The company list is sorted by the + `last_request_at` field and by default is ordered descending, most + recently requested first. + + + Note that the API does not include companies who have no associated + users in list responses. + + + When using the Companies endpoint and the pages object to iterate + through the returned companies, there is a limit of 10,000 Companies + that can be returned. If you need to list or iterate on more than 10,000 + Companies, please use the [Scroll + API](https://developers.intercom.com/reference#iterating-over-all-companies). + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all companies + request: + name: ListAllCompaniesRequest + query-parameters: + page: + type: optional + docs: The page of results to fetch. Defaults to first page + per_page: + type: optional + docs: How many results to return per page. Defaults to 15 + order: + type: optional + docs: >- + `asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc + response: + docs: Successful + type: root.Companies + errors: + - root.ListAllCompaniesRequestUnauthorizedError + examples: + - name: Successful + query-parameters: + order: desc + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 15 + total_pages: 1 + total_count: 1 + data: + - type: company + id: 667d608a8a68186f43bafd61 + name: IntercomQATest1 + app_id: this_is_an_id158_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492746 + created_at: 1719492746 + updated_at: 1719492746 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + scrollOverAllCompanies: + path: /companies/scroll + method: GET + auth: true + docs: >2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error + message if you try to have more than one open per app. + + - If the scroll isn't used for 1 minute, it expires and calls with that + scroll param will fail + + - If the end of the scroll is reached, "companies" will be empty and the + scroll parameter will expire + + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: Scroll over all companies + request: + name: ScrollOverAllCompaniesRequest + query-parameters: + scroll_param: + type: optional + docs: '' + response: + docs: Successful + type: optional + errors: + - root.ScrollOverAllCompaniesRequestUnauthorizedError + examples: + - name: Successful + response: + body: + type: list + data: + - type: company + id: 667d608b8a68186f43bafd67 + name: IntercomQATest1 + app_id: this_is_an_id162_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492747 + created_at: 1719492747 + updated_at: 1719492747 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 2 + total_pages: 13 + total_count: 100 + scroll_param: 12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc + attachContactToACompany: + path: /contacts/{id}/companies + method: POST + auth: true + docs: You can attach a company to a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Attach a Contact to a Company + request: + name: AttachContactToACompanyRequest + body: + properties: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + name: companyId + content-type: application/json + response: + docs: Successful + type: Company + errors: + - root.AttachContactToACompanyRequestBadRequestError + - root.AttachContactToACompanyRequestUnauthorizedError + - root.AttachContactToACompanyRequestNotFoundError + examples: + - name: Successful + path-parameters: + id: id + request: + id: 667d608d8a68186f43bafd70 + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + - name: Bad Request + path-parameters: + id: id + request: + id: 58a430d35458202d41b1e65b + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + - name: Company Not Found + path-parameters: + id: id + request: + id: '123' + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + detachContactFromACompany: + path: /contacts/{contact_id}/companies/{id} + method: DELETE + auth: true + docs: You can detach a company from a single contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Detach a contact from a company + response: + docs: Successful + type: Company + errors: + - root.DetachContactFromACompanyRequestUnauthorizedError + - root.DetachContactFromACompanyRequestNotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 58a430d35458202d41b1e65b + id: 58a430d35458202d41b1e65b + response: + body: + type: company + id: 667d60918a68186f43bafd80 + name: company8 + app_id: this_is_an_id174_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492753 + created_at: 1719492753 + updated_at: 1719492753 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 0 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + source: + openapi: ../openapi.yml + display-name: Companies +docs: Everything about your Companies +types: + CompanyPlan: + properties: + type: + type: optional + docs: Value is always "plan" + id: + type: optional + docs: The id of the plan + name: + type: optional + docs: The name of the plan + source: + openapi: ../openapi.yml + CompanyTags: + docs: The list of tags associated with the company + properties: + type: + type: optional> + docs: The type of the object + tags: optional> + source: + openapi: ../openapi.yml + CompanySegments: + docs: The list of segments associated with the company + properties: + type: + type: optional> + docs: The type of the object + segments: optional> + source: + openapi: ../openapi.yml + Company: + docs: >- + Companies allow you to represent organizations using your product. Each + company will have its own description and be associated with contacts. You + can fetch, create, update and list companies. + properties: + type: + type: optional> + docs: Value is `company` + id: + type: optional + docs: The Intercom defined id representing the company. + name: + type: optional + docs: The name of the company. + app_id: + type: optional + docs: >- + The Intercom defined code of the workspace the company is associated + to. + plan: + type: optional + company_id: + type: optional + docs: The company id you have defined for the company. + remote_created_at: + type: optional + docs: The time the company was created by you. + created_at: + type: optional + docs: The time the company was added in Intercom. + updated_at: + type: optional + docs: The last time the company was updated. + last_request_at: + type: optional + docs: The time the company last recorded making a request. + size: + type: optional + docs: The number of employees in the company. + website: + type: optional + docs: The URL for the company website. + industry: + type: optional + docs: The industry that the company operates in. + monthly_spend: + type: optional + docs: How much revenue the company generates for your business. + session_count: + type: optional + docs: How many sessions the company has recorded. + user_count: + type: optional + docs: The number of users in the company. + custom_attributes: + type: optional> + docs: The custom attributes you have set on the company. + tags: + type: optional + docs: The list of tags associated with the company + segments: + type: optional + docs: The list of segments associated with the company + source: + openapi: ../openapi.yml +", + }, + "contacts.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your contacts", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Contacts", + "endpoints": { + "ArchiveContact": { + "auth": true, + "display-name": "Archive contact", + "docs": "You can archive a single contact.", + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "archived": true, + "external_id": "70", + "id": "667d60b18a68186f43bafdc0", + "type": "contact", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/archive", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactArchived", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateContact": { + "auth": true, + "display-name": "Create contact", + "docs": "You can create a new contact (ie. user or lead).", + "errors": [ + "root.CreateContactRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "email": "joebloggs@intercom.io", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + }, + "created_at": 1719492784, + "custom_attributes": { + "key": "value", + }, + "email": "joebloggs@intercom.io", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60b08a68186f43bafdbf", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "John Doe", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492784, + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts", + "request": { + "body": "root.CreateContactRequestTwo", + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeleteContact": { + "auth": true, + "display-name": "Delete a contact", + "docs": "You can delete a single contact.", + "errors": [ + "root.DeleteContactRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "deleted": true, + "external_id": "70", + "id": "667d60aa8a68186f43bafdba", + "type": "contact", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactDeleted", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ListContacts": { + "auth": true, + "display-name": "List all contacts", + "docs": "You can fetch a list of all contacts (ie. users or leads) in your workspace. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.ListContactsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts", + "response": { + "docs": "successful", + "type": "root.ContactList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MergeContact": { + "auth": true, + "display-name": "Merge a lead and a user", + "docs": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "errors": [ + "root.MergeContactRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "from": "667d60ac8a68186f43bafdbb", + "into": "667d60ac8a68186f43bafdbc", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + }, + "created_at": 1719492780, + "custom_attributes": { + "key": "value", + }, + "email": "joe@bloggs.com", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60ac8a68186f43bafdbc", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "Joe Bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492780, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492780, + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/merge", + "request": { + "body": { + "properties": { + "from": { + "docs": "The unique identifier for the contact to merge away from. Must be a lead.", + "type": "optional", + }, + "into": { + "docs": "The unique identifier for the contact to merge into. Must be a user.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "MergeContactsRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SearchContacts": { + "auth": true, + "display-name": "Search contacts", + "docs": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + +To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + +This will accept a query object in the body which will define your filters in order to search for contacts. + +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} +### Contact Creation Delay + +If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +* There's a limit of max 2 nested filters +* There's a limit of max 15 filters for each AND or OR group + +### Searching for Timestamp Fields + +All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. +For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. +If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). +This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + +### Accepted Fields + +Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| ---------------------------------- | ------------------------------ | +| id | String | +| role | String
Accepts user or lead | +| name | String | +| avatar | String | +| owner_id | Integer | +| email | String | +| email_domain | String | +| phone | String | +| formatted_phone | String | +| external_id | String | +| created_at | Date (UNIX Timestamp) | +| signed_up_at | Date (UNIX Timestamp) | +| updated_at | Date (UNIX Timestamp) | +| last_seen_at | Date (UNIX Timestamp) | +| last_contacted_at | Date (UNIX Timestamp) | +| last_replied_at | Date (UNIX Timestamp) | +| last_email_opened_at | Date (UNIX Timestamp) | +| last_email_clicked_at | Date (UNIX Timestamp) | +| language_override | String | +| browser | String | +| browser_language | String | +| os | String | +| location.country | String | +| location.region | String | +| location.city | String | +| unsubscribed_from_emails | Boolean | +| marked_email_as_spam | Boolean | +| has_hard_bounced | Boolean | +| ios_last_seen_at | Date (UNIX Timestamp) | +| ios_app_version | String | +| ios_device | String | +| ios_app_device | String | +| ios_os_version | String | +| ios_app_name | String | +| ios_sdk_version | String | +| android_last_seen_at | Date (UNIX Timestamp) | +| android_app_version | String | +| android_device | String | +| android_app_name | String | +| andoid_sdk_version | String | +| segment_id | String | +| tag_id | String | +| custom_attributes.{attribute_name} | String | + +### Accepted Operators + +{% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :------------------------------- | :--------------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In
Shortcut for `OR` queries
Values must be in Array | +| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | +| > | Integer
Date (UNIX Timestamp) | Greater than | +| < | Integer
Date (UNIX Timestamp) | Lower than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "errors": [ + "root.SearchContactsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.ContactList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ShowContact": { + "auth": true, + "display-name": "Get a contact", + "docs": "You can fetch the details of a single contact.", + "errors": [ + "root.ShowContactRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/companies", + }, + "created_at": 1719492777, + "custom_attributes": { + "key": "value", + }, + "email": "joe@bloggs.com", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60a98a68186f43bafdb9", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "Joe Bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492777, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492777, + "workspace_id": "this_is_an_id252_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UnarchiveContact": { + "auth": true, + "display-name": "Unarchive contact", + "docs": "You can unarchive a single contact.", + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "archived": false, + "external_id": "70", + "id": "667d60b28a68186f43bafdc1", + "type": "contact", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/unarchive", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactUnarchived", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateContact": { + "auth": true, + "display-name": "Update a contact", + "docs": "You can update an existing contact (ie. user or lead).", + "errors": [ + "root.UpdateContactRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "request": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + }, + "created_at": 1719492776, + "custom_attributes": { + "key": "value", + }, + "email": "joebloggs@intercom.io", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60a88a68186f43bafdb8", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "joe bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492776, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492776, + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "avatar": { + "docs": "An image URL containing the avatar of a contact", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes which are set for the contact", + "type": "optional>", + }, + "email": { + "docs": "The contacts email", + "type": "optional", + }, + "external_id": { + "docs": "A unique identifier for the contact which is given to Intercom", + "type": "optional", + }, + "last_seen_at": { + "docs": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", + "type": "optional", + }, + "name": { + "docs": "The contacts name", + "type": "optional", + }, + "owner_id": { + "docs": "The id of an admin that has been assigned account ownership of the contact", + "type": "optional", + }, + "phone": { + "docs": "The contacts phone", + "type": "optional", + }, + "role": { + "docs": "The role of the contact.", + "type": "optional", + }, + "signed_up_at": { + "docs": "The time specified for when a contact signed up", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the contact is unsubscribed from emails", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listCompaniesForAContact": { + "auth": true, + "display-name": "List attached companies for contact", + "docs": "You can fetch a list of companies that are associated to a contact.", + "errors": [ + "root.ListCompaniesForAContactRequestUnauthorizedError", + "root.ListCompaniesForAContactRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "type": "company", + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": "next", + "page": 1, + "per_page": 50, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}/companies", + "path-parameters": { + "id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactAttachedCompanies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSegmentsForAContact": { + "auth": true, + "display-name": "List attached segments for contact", + "docs": "You can fetch a list of segments that are associated to a contact.", + "errors": [ + "root.ListSegmentsForAContactRequestUnauthorizedError", + "root.ListSegmentsForAContactRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "count": 3, + "created_at": 1719492761, + "id": "667d60998a68186f43bafda1", + "name": "segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492761, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/segments", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.Segments", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSubscriptionsForAContact": { + "auth": true, + "display-name": "List subscriptions for a contact", + "docs": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. +This will return a list of Subscription Type objects that the contact is associated with. + +The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. +", + "errors": [ + "root.ListSubscriptionsForAContactRequestUnauthorizedError", + "root.ListSubscriptionsForAContactRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "consent_type": "opt_out", + "content_types": [ + "email", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "93", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "95", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.SubscriptionTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTagsForAContact": { + "auth": true, + "display-name": "List tags attached to a contact", + "docs": "You can fetch a list of all tags that are attached to a specific contact.", + "errors": [ + "root.ListTagsForAContactRequestUnauthorizedError", + "root.ListTagsForAContactRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "applied_at": 1663597223, + "applied_by": { + "type": "contact", + }, + "id": "93", + "name": "Manual tag", + "type": "tag", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.Tags", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Contact": { + "docs": "Contact are the objects that represent your leads and users in Intercom.", + "properties": { + "android_app_name": { + "docs": "The name of the Android app which the contact is using.", + "type": "optional", + }, + "android_app_version": { + "docs": "The version of the Android app which the contact is using.", + "type": "optional", + }, + "android_device": { + "docs": "The Android device which the contact is using.", + "type": "optional", + }, + "android_last_seen_at": { + "docs": "(UNIX timestamp) The time when the contact was last seen on an Android device.", + "type": "optional", + }, + "android_os_version": { + "docs": "The version of the Android OS which the contact is using.", + "type": "optional", + }, + "android_sdk_version": { + "docs": "The version of the Android SDK which the contact is using.", + "type": "optional", + }, + "avatar": { + "type": "optional", + }, + "browser": { + "docs": "The name of the browser which the contact is using.", + "type": "optional", + }, + "browser_language": { + "docs": "The language set by the browser which the contact is using.", + "type": "optional", + }, + "browser_version": { + "docs": "The version of the browser which the contact is using.", + "type": "optional", + }, + "companies": { + "type": "optional", + }, + "created_at": { + "docs": "(UNIX timestamp) The time when the contact was created.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes which are set for the contact.", + "type": "optional>", + }, + "email": { + "docs": "The contact's email.", + "type": "optional", + }, + "email_domain": { + "docs": "The contact's email domain.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "formatted_phone": { + "docs": "The contacts phone number normalized to the E164 format", + "type": "optional", + }, + "has_hard_bounced": { + "docs": "Whether the contact has had an email sent to them hard bounce.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "ios_app_name": { + "docs": "The name of the iOS app which the contact is using.", + "type": "optional", + }, + "ios_app_version": { + "docs": "The version of the iOS app which the contact is using.", + "type": "optional", + }, + "ios_device": { + "docs": "The iOS device which the contact is using.", + "type": "optional", + }, + "ios_last_seen_at": { + "docs": "(UNIX timestamp) The last time the contact used the iOS app.", + "type": "optional", + }, + "ios_os_version": { + "docs": "The version of iOS which the contact is using.", + "type": "optional", + }, + "ios_sdk_version": { + "docs": "The version of the iOS SDK which the contact is using.", + "type": "optional", + }, + "language_override": { + "docs": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.", + "type": "optional", + }, + "last_contacted_at": { + "docs": "(UNIX timestamp) The time when the contact was last messaged.", + "type": "optional", + }, + "last_email_clicked_at": { + "docs": "(UNIX timestamp) The time when the contact last clicked a link in an email.", + "type": "optional", + }, + "last_email_opened_at": { + "docs": "(UNIX timestamp) The time when the contact last opened an email.", + "type": "optional", + }, + "last_replied_at": { + "docs": "(UNIX timestamp) The time when the contact last messaged in.", + "type": "optional", + }, + "last_seen_at": { + "docs": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).", + "type": "optional", + }, + "location": { + "type": "optional", + }, + "marked_email_as_spam": { + "docs": "Whether the contact has marked an email sent to them as spam.", + "type": "optional", + }, + "name": { + "docs": "The contacts name.", + "type": "optional", + }, + "notes": { + "type": "optional", + }, + "os": { + "docs": "The operating system which the contact is using.", + "type": "optional", + }, + "owner_id": { + "docs": "The id of an admin that has been assigned account ownership of the contact.", + "type": "optional", + }, + "phone": { + "docs": "The contacts phone.", + "type": "optional", + }, + "role": { + "docs": "The role of the contact.", + "type": "optional", + }, + "signed_up_at": { + "docs": "(UNIX timestamp) The time specified for when a contact signed up.", + "type": "optional", + }, + "social_profiles": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "type": { + "docs": "The type of object.", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the contact is unsubscribed from emails.", + "type": "optional", + }, + "updated_at": { + "docs": "(UNIX timestamp) The time when the contact was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the contact belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactAvatar": { + "docs": undefined, + "properties": { + "image_url": { + "docs": "An image URL containing the avatar of a contact.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "docs": "The type of object", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listCompaniesForAContact: + path: /contacts/{id}/companies + method: GET + auth: true + docs: You can fetch a list of companies that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List attached companies for contact + response: + docs: successful + type: root.ContactAttachedCompanies + errors: + - root.ListCompaniesForAContactRequestUnauthorizedError + - root.ListCompaniesForAContactRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: list + companies: + - type: company + id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + plan: + type: plan + id: '269315' + name: Pro + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + total_count: 1 + pages: + type: pages + page: 1 + next: next + per_page: 50 + total_pages: 1 + listSegmentsForAContact: + path: /contacts/{contact_id}/segments + method: GET + auth: true + docs: You can fetch a list of segments that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List attached segments for contact + response: + docs: successful + type: root.Segments + errors: + - root.ListSegmentsForAContactRequestUnauthorizedError + - root.ListSegmentsForAContactRequestNotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: segment + id: 667d60998a68186f43bafda1 + name: segment + created_at: 1719492761 + updated_at: 1719492761 + person_type: user + count: 3 + listSubscriptionsForAContact: + path: /contacts/{contact_id}/subscriptions + method: GET + auth: true + docs: > + You can fetch a list of subscription types that are attached to a + contact. These can be subscriptions that a user has 'opted-in' to or has + 'opted-out' from, depending on the subscription type. + + This will return a list of Subscription Type objects that the contact is + associated with. + + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List subscriptions for a contact + response: + docs: Successful + type: root.SubscriptionTypeList + errors: + - root.ListSubscriptionsForAContactRequestUnauthorizedError + - root.ListSubscriptionsForAContactRequestNotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: subscription + id: '93' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_out + content_types: + - email + - type: subscription + id: '95' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + listTagsForAContact: + path: /contacts/{contact_id}/tags + method: GET + auth: true + docs: >- + You can fetch a list of all tags that are attached to a specific + contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List tags attached to a contact + response: + docs: successful + type: root.Tags + errors: + - root.ListTagsForAContactRequestUnauthorizedError + - root.ListTagsForAContactRequestNotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: tag + id: '93' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + ShowContact: + path: /contacts/{id} + method: GET + auth: true + docs: You can fetch the details of a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Get a contact + response: + docs: successful + type: Contact + errors: + - root.ShowContactRequestUnauthorizedError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60a98a68186f43bafdb9 + external_id: '70' + workspace_id: this_is_an_id252_that_should_be_at_least_ + role: user + email: joe@bloggs.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: Joe Bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492777 + updated_at: 1719492777 + signed_up_at: 1719492777 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a98a68186f43bafdb9/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a98a68186f43bafdb9/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60a98a68186f43bafdb9/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + UpdateContact: + path: /contacts/{id} + method: PUT + auth: true + docs: You can update an existing contact (ie. user or lead). + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Update a contact + request: + name: UpdateContactRequest + body: + properties: + role: + type: optional + docs: The role of the contact. + external_id: + type: optional + docs: A unique identifier for the contact which is given to Intercom + email: + type: optional + docs: The contacts email + phone: + type: optional + docs: The contacts phone + name: + type: optional + docs: The contacts name + avatar: + type: optional + docs: An image URL containing the avatar of a contact + signed_up_at: + type: optional + docs: The time specified for when a contact signed up + last_seen_at: + type: optional + docs: >- + The time when the contact was last seen (either where the + Intercom Messenger was installed or when specified manually) + owner_id: + type: optional + docs: >- + The id of an admin that has been assigned account ownership of + the contact + unsubscribed_from_emails: + type: optional + docs: Whether the contact is unsubscribed from emails + custom_attributes: + type: optional> + docs: The custom attributes which are set for the contact + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.UpdateContactRequestUnauthorizedError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + request: + email: joebloggs@intercom.io + name: joe bloggs + response: + body: + type: contact + id: 667d60a88a68186f43bafdb8 + external_id: '70' + workspace_id: this_is_an_id248_that_should_be_at_least_ + role: user + email: joebloggs@intercom.io + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: joe bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492776 + updated_at: 1719492776 + signed_up_at: 1719492776 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a88a68186f43bafdb8/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a88a68186f43bafdb8/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60a88a68186f43bafdb8/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + DeleteContact: + path: /contacts/{id} + method: DELETE + auth: true + docs: You can delete a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Delete a contact + response: + docs: successful + type: root.ContactDeleted + errors: + - root.DeleteContactRequestUnauthorizedError + examples: + - name: successful + path-parameters: + id: id + response: + body: + type: contact + id: 667d60aa8a68186f43bafdba + external_id: '70' + deleted: true + MergeContact: + path: /contacts/merge + method: POST + auth: true + docs: >- + You can merge a contact with a `role` of `lead` into a contact with a + `role` of `user`. + source: + openapi: ../openapi.yml + display-name: Merge a lead and a user + request: + name: MergeContactsRequest + body: + properties: + from: + type: optional + docs: >- + The unique identifier for the contact to merge away from. Must + be a lead. + into: + type: optional + docs: >- + The unique identifier for the contact to merge into. Must be a + user. + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.MergeContactRequestUnauthorizedError + examples: + - name: successful + request: + from: 667d60ac8a68186f43bafdbb + into: 667d60ac8a68186f43bafdbc + response: + body: + type: contact + id: 667d60ac8a68186f43bafdbc + external_id: '70' + workspace_id: this_is_an_id260_that_should_be_at_least_ + role: user + email: joe@bloggs.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: Joe Bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492780 + updated_at: 1719492780 + signed_up_at: 1719492780 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60ac8a68186f43bafdbc/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60ac8a68186f43bafdbc/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60ac8a68186f43bafdbc/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + SearchContacts: + path: /contacts/search + method: POST + auth: true + docs: > + You can search for multiple contacts by the value of their attributes in + order to fetch exactly who you want. + + + To search for contacts, you need to send a `POST` request to + `https://api.intercom.io/contacts/search`. + + + This will accept a query object in the body which will define your + filters in order to search for contacts. + + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Contact Creation Delay + + + If a contact has recently been created, there is a possibility that it + will not yet be available when searching. This means that it may not + appear in the response. This delay can take a few minutes. If you need + to be instantly notified it is recommended to use webhooks and iterate + to see if they match your search filters. + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiple's there can be: + + * There's a limit of max 2 nested filters + + * There's a limit of max 15 filters for each AND or OR group + + + ### Searching for Timestamp Fields + + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates + for Contact Search queries; Datetime queries are not currently + supported. This means you can only query for timestamp fields by day - + not hour, minute or second. + + For example, if you search for all Contacts with a created_at value + greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 + 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 + 12:00 AM). The search results will then include Contacts created from + January 2nd, 2020 12:00 AM onwards. + + If you'd like to get contacts created on January 1st, 2020 you should + search with a created_at value equal (=) to 1577836800 (January 1st, + 2020 12:00 AM). + + This behaviour applies only to timestamps used in search queries. The + search results will still contain the full UNIX timestamp and be sorted + accordingly. + + + ### Accepted Fields + + + Most key listed as part of the Contacts Model are searchable, whether + writeable or not. The value you search for has to match the accepted + type, otherwise the query will fail (ie. as `created_at` accepts a date, + the `value` cannot be a string such as `"foorbar"`). + + + | Field | Type | + + | ---------------------------------- | ------------------------------ | + + | id | String | + + | role | String
Accepts user or lead | + + | name | String | + + | avatar | String | + + | owner_id | Integer | + + | email | String | + + | email_domain | String | + + | phone | String | + + | formatted_phone | String | + + | external_id | String | + + | created_at | Date (UNIX Timestamp) | + + | signed_up_at | Date (UNIX Timestamp) | + + | updated_at | Date (UNIX Timestamp) | + + | last_seen_at | Date (UNIX Timestamp) | + + | last_contacted_at | Date (UNIX Timestamp) | + + | last_replied_at | Date (UNIX Timestamp) | + + | last_email_opened_at | Date (UNIX Timestamp) | + + | last_email_clicked_at | Date (UNIX Timestamp) | + + | language_override | String | + + | browser | String | + + | browser_language | String | + + | os | String | + + | location.country | String | + + | location.region | String | + + | location.city | String | + + | unsubscribed_from_emails | Boolean | + + | marked_email_as_spam | Boolean | + + | has_hard_bounced | Boolean | + + | ios_last_seen_at | Date (UNIX Timestamp) | + + | ios_app_version | String | + + | ios_device | String | + + | ios_app_device | String | + + | ios_os_version | String | + + | ios_app_name | String | + + | ios_sdk_version | String | + + | android_last_seen_at | Date (UNIX Timestamp) | + + | android_app_version | String | + + | android_device | String | + + | android_app_name | String | + + | andoid_sdk_version | String | + + | segment_id | String | + + | tag_id | String | + + | custom_attributes.{attribute_name} | String | + + + ### Accepted Operators + + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :------------------------------- | + :--------------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In
Shortcut for `OR` + queries
Values must be in Array | + + | NIN | All | Not In
Shortcut for + `OR !` queries
Values must be in Array | + + | > | Integer
Date (UNIX Timestamp) | Greater + than | + + | < | Integer
Date (UNIX Timestamp) | Lower + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search contacts + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.ContactList + errors: + - root.SearchContactsRequestUnauthorizedError + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 0 + ListContacts: + path: /contacts + method: GET + auth: true + docs: > + You can fetch a list of all contacts (ie. users or leads) in your + workspace. + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all contacts + response: + docs: successful + type: root.ContactList + errors: + - root.ListContactsRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 0 + CreateContact: + path: /contacts + method: POST + auth: true + docs: You can create a new contact (ie. user or lead). + source: + openapi: ../openapi.yml + display-name: Create contact + request: + body: root.CreateContactRequestTwo + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.CreateContactRequestUnauthorizedError + examples: + - name: successful + request: + email: joebloggs@intercom.io + response: + body: + type: contact + id: 667d60b08a68186f43bafdbf + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: this_is_an_id272_that_should_be_at_least_ + role: user + email: joebloggs@intercom.io + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492784 + updated_at: 1719492784 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60b08a68186f43bafdbf/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60b08a68186f43bafdbf/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60b08a68186f43bafdbf/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + ArchiveContact: + path: /contacts/{id}/archive + method: POST + auth: true + docs: You can archive a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Archive contact + response: + docs: successful + type: root.ContactArchived + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60b18a68186f43bafdc0 + external_id: '70' + archived: true + UnarchiveContact: + path: /contacts/{id}/unarchive + method: POST + auth: true + docs: You can unarchive a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Unarchive contact + response: + docs: successful + type: root.ContactUnarchived + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60b28a68186f43bafdc1 + external_id: '70' + archived: false + source: + openapi: ../openapi.yml + display-name: Contacts +docs: Everything about your contacts +types: + ContactAvatar: + properties: + type: + type: optional + docs: The type of object + image_url: + type: optional + docs: An image URL containing the avatar of a contact. + validation: + format: uri + source: + openapi: ../openapi.yml + Contact: + docs: Contact are the objects that represent your leads and users in Intercom. + properties: + type: + type: optional + docs: The type of object. + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + workspace_id: + type: optional + docs: The id of the workspace which the contact belongs to. + role: + type: optional + docs: The role of the contact. + email: + type: optional + docs: The contact's email. + email_domain: + type: optional + docs: The contact's email domain. + phone: + type: optional + docs: The contacts phone. + formatted_phone: + type: optional + docs: The contacts phone number normalized to the E164 format + name: + type: optional + docs: The contacts name. + owner_id: + type: optional + docs: >- + The id of an admin that has been assigned account ownership of the + contact. + has_hard_bounced: + type: optional + docs: Whether the contact has had an email sent to them hard bounce. + marked_email_as_spam: + type: optional + docs: Whether the contact has marked an email sent to them as spam. + unsubscribed_from_emails: + type: optional + docs: Whether the contact is unsubscribed from emails. + created_at: + type: optional + docs: (UNIX timestamp) The time when the contact was created. + updated_at: + type: optional + docs: (UNIX timestamp) The time when the contact was last updated. + signed_up_at: + type: optional + docs: (UNIX timestamp) The time specified for when a contact signed up. + last_seen_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact was last seen (either where + the Intercom Messenger was installed or when specified manually). + last_replied_at: + type: optional + docs: (UNIX timestamp) The time when the contact last messaged in. + last_contacted_at: + type: optional + docs: (UNIX timestamp) The time when the contact was last messaged. + last_email_opened_at: + type: optional + docs: (UNIX timestamp) The time when the contact last opened an email. + last_email_clicked_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact last clicked a link in an + email. + language_override: + type: optional + docs: >- + A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + browser: + type: optional + docs: The name of the browser which the contact is using. + browser_version: + type: optional + docs: The version of the browser which the contact is using. + browser_language: + type: optional + docs: The language set by the browser which the contact is using. + os: + type: optional + docs: The operating system which the contact is using. + android_app_name: + type: optional + docs: The name of the Android app which the contact is using. + android_app_version: + type: optional + docs: The version of the Android app which the contact is using. + android_device: + type: optional + docs: The Android device which the contact is using. + android_os_version: + type: optional + docs: The version of the Android OS which the contact is using. + android_sdk_version: + type: optional + docs: The version of the Android SDK which the contact is using. + android_last_seen_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact was last seen on an Android + device. + ios_app_name: + type: optional + docs: The name of the iOS app which the contact is using. + ios_app_version: + type: optional + docs: The version of the iOS app which the contact is using. + ios_device: + type: optional + docs: The iOS device which the contact is using. + ios_os_version: + type: optional + docs: The version of iOS which the contact is using. + ios_sdk_version: + type: optional + docs: The version of the iOS SDK which the contact is using. + ios_last_seen_at: + type: optional + docs: (UNIX timestamp) The last time the contact used the iOS app. + custom_attributes: + type: optional> + docs: The custom attributes which are set for the contact. + avatar: + type: optional + tags: + type: optional + notes: + type: optional + companies: + type: optional + location: + type: optional + social_profiles: + type: optional + source: + openapi: ../openapi.yml +", + }, + "conversations.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Conversations", + "imports": { + "aiAgent": "aiAgent.yml", + "messages": "messages.yml", + "root": "__package__.yml", + "tickets": "tickets.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Conversations", + "endpoints": { + "attachContactToConversation": { + "auth": true, + "display-name": "Attach a contact to a conversation", + "docs": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="attention" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +", + "errors": [ + "root.AttachContactToConversationRequestUnauthorizedError", + "root.AttachContactToConversationRequestForbiddenError", + "root.AttachContactToConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "Attach a contact to a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "customer": { + "intercom_user_id": "667d61168a68186f43bafe0d", + }, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "customer": { + "intercom_user_id": "667d61188a68186f43bafe0e", + }, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/customers", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The `id` of the admin who is adding the new participant.", + "type": "optional", + }, + "customer": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachContactToConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Attach a contact to a conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "autoAssignConversation": { + "auth": true, + "display-name": "Run Assignment Rules on a conversation", + "docs": "You can let a conversation be automatically assigned following assignment rules. +{% admonition type="attention" name="When using workflows" %} +It is not possible to use this endpoint with Workflows. +{% /admonition %} +", + "errors": [ + "root.AutoAssignConversationRequestUnauthorizedError", + "root.AutoAssignConversationRequestForbiddenError", + "root.AutoAssignConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "Assign a conversation using assignment rules", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61108a68186f43bafe09", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "assigned_to": { + "type": "nobody_admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io", + "id": "991267624", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492881, + "id": "107", + "notified_at": 1719492881, + "part_type": "default_assignment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492881, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492880, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "409", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin197@email.com", + "id": "991267623", + "name": "Ciaran197 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918285", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492881, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/run_assignment_rules", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Assign a conversation using assignment rules", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "convertConversationToTicket": { + "auth": true, + "display-name": "Convert a conversation to a ticket", + "docs": "You can convert a conversation to a ticket.", + "errors": [ + "root.ConvertConversationToTicketRequestBadRequestError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "ticket_type_id": "79", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Customer", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61518a68186f43bafe45", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719492945, + "id": "474", + "is_shared": true, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "key": "value", + }, + "ticket_id": "37", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d61518a68186f43bafe45", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Comment for message

", + "created_at": 1719492945, + "id": "117", + "part_type": "comment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719492945, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "id": "991267667", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492947, + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719492947, + }, + ], + "total_count": 2, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Customer", + "created_at": 1719492947, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "79", + "name": "my-ticket-type-1", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719492947, + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719492947, + }, + }, + }, + { + "name": "Bad request", + "path-parameters": { + "id": 1, + }, + "request": { + "ticket_type_id": "80", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Customer", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61518a68186f43bafe45", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719492945, + "id": "474", + "is_shared": true, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "key": "value", + }, + "ticket_id": "37", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d61518a68186f43bafe45", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Comment for message

", + "created_at": 1719492945, + "id": "117", + "part_type": "comment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719492945, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "id": "991267667", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492947, + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719492947, + }, + ], + "total_count": 2, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Customer", + "created_at": 1719492947, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "79", + "name": "my-ticket-type-1", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719492947, + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719492947, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/convert", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "attributes": { + "type": "optional", + }, + "ticket_type_id": { + "docs": "The ID of the type of ticket you want to convert the conversation to", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "ConvertConversationToTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createConversation": { + "auth": true, + "display-name": "Creates a conversation", + "docs": "You can create a conversation that has been initiated by a contact (ie. user or lead). +The conversation can be an in-app message only. + +{% admonition type="info" name="Sending for visitors" %} +You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. +This visitor will be automatically converted to a contact with a lead role once the conversation is created. +{% /admonition %} + +This will return the Message model that has been created. + +", + "errors": [ + "root.CreateConversationRequestUnauthorizedError", + "root.CreateConversationRequestForbiddenError", + "root.CreateConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "conversation created", + "request": { + "body": "Hello there", + "from": { + "id": "667d60d18a68186f43bafddd", + "type": "user", + }, + }, + "response": { + "body": { + "body": "Hello there", + "conversation_id": "363", + "created_at": 1719492819, + "id": "403918251", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "Contact Not Found", + "request": { + "body": "Hello there", + "from": { + "id": "123_doesnt_exist", + "type": "user", + }, + }, + "response": { + "body": { + "body": "Hello there", + "conversation_id": "363", + "created_at": 1719492819, + "id": "403918251", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations", + "request": { + "body": { + "properties": { + "body": { + "docs": "The content of the message. HTML is not supported.", + "type": "string", + }, + "from": "CreateConversationRequestFrom", + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "conversation created", + "type": "messages.Message", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachContactFromConversation": { + "auth": true, + "display-name": "Detach a contact from a group conversation", + "docs": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="attention" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +", + "errors": [ + "root.DetachContactFromConversationRequestUnauthorizedError", + "root.DetachContactFromConversationRequestForbiddenError", + "root.DetachContactFromConversationRequestNotFoundError", + "root.DetachContactFromConversationRequestUnprocessableEntityError", + ], + "examples": [ + { + "name": "Detach a contact from a group conversation", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Last customer", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "path-parameters": { + "contact_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + "conversation_id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The `id` of the admin who is performing the action.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachContactFromConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Detach a contact from a group conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listConversations": { + "auth": true, + "display-name": "List all conversations", + "docs": "You can fetch a list of all conversations. + +You can optionally request the result page size and the cursor to start after to fetch the result. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.ListConversationsRequestUnauthorizedError", + "root.ListConversationsRequestForbiddenError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1674917488, + "id": "12312", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1674917488, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "conversation.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/conversations", + "request": { + "name": "ListConversationsRequest", + "query-parameters": { + "per_page": { + "docs": "How many results per page", + "type": "optional", + }, + "starting_after": { + "docs": "String used to get the next page of conversations.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "manageConversation": { + "auth": true, + "display-name": "Manage a conversation", + "docs": "For managing conversations you can: +- Close a conversation +- Snooze a conversation to reopen on a future date +- Open a conversation which is `snoozed` or `closed` +- Assign a conversation to an admin and/or team. +", + "errors": [ + "root.ManageConversationRequestUnauthorizedError", + "root.ManageConversationRequestForbiddenError", + "root.ManageConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "Close a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Goodbye :)", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60fd8a68186f43bafdfb", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

Goodbye :)

", + "created_at": 1719492862, + "id": "102", + "notified_at": 1719492862, + "part_type": "close", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492862, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492862, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "394", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918276", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492862, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Snooze a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60ff8a68186f43bafdfc", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin190@email.com", + "id": "991267610", + "name": "Ciaran190 Lee", + "type": "admin", + }, + "created_at": 1719492864, + "id": "103", + "notified_at": 1719492864, + "part_type": "snoozed", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492864, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492864, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "395", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1719496464, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin190@email.com", + "id": "991267610", + "name": "Ciaran190 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918277", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "snoozed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492864, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Open a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "74", + "id": "667d61038a68186f43bafe01", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin191@email.com", + "id": "991267612", + "name": "Ciaran191 Lee", + "type": "admin", + }, + "created_at": 1719492873, + "id": "105", + "notified_at": 1719492873, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492873, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492863, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "400", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin191@email.com", + "id": "991267612", + "name": "Ciaran191 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918278", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "", + "type": "conversation", + "updated_at": 1719492873, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Assign a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 991267615, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d610a8a68186f43bafe05", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "assigned_to": { + "id": "991267615", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin193@email.com", + "id": "991267615", + "name": "Ciaran193 Lee", + "type": "admin", + }, + "created_at": 1719492875, + "id": "106", + "notified_at": 1719492875, + "part_type": "assign_and_reopen", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492875, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492874, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "405", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin193@email.com", + "id": "991267615", + "name": "Ciaran193 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918281", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492875, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Goodbye :)", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60fd8a68186f43bafdfb", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

Goodbye :)

", + "created_at": 1719492862, + "id": "102", + "notified_at": 1719492862, + "part_type": "close", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492862, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492862, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "394", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918276", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492862, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/parts", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": "ManageConversationRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Assign a conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "redactConversation": { + "auth": true, + "display-name": "Redact a conversation part", + "docs": "You can redact a conversation part or the source message of a conversation (as seen in the source object). + +{% admonition type="info" name="Redacting parts and messages" %} +If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. +{% /admonition %} + +", + "errors": [ + "root.RedactConversationRequestUnauthorizedError", + "root.RedactConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "Redact a conversation part", + "request": { + "conversation_id": "19894788788", + "conversation_part_id": "19381789428", + "type": "conversation_part", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d614a8a68186f43bafe42", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d614a8a68186f43bafe42", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

This message was deleted

", + "created_at": 1719492939, + "id": "115", + "notified_at": 1719492939, + "part_type": "open", + "redacted": true, + "type": "conversation_part", + "updated_at": 1719492940, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492938, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "471", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin217@email.com", + "id": "991267657", + "name": "Ciaran217 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918311", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492940, + "waiting_since": 1719492939, + }, + }, + }, + { + "name": "Not found", + "request": { + "conversation_id": "really_123_doesnt_exist", + "conversation_part_id": "really_123_doesnt_exist", + "type": "conversation_part", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d614a8a68186f43bafe42", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d614a8a68186f43bafe42", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

This message was deleted

", + "created_at": 1719492939, + "id": "115", + "notified_at": 1719492939, + "part_type": "open", + "redacted": true, + "type": "conversation_part", + "updated_at": 1719492940, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492938, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "471", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin217@email.com", + "id": "991267657", + "name": "Ciaran217 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918311", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492940, + "waiting_since": 1719492939, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/redact", + "request": { + "body": "root.RedactConversationRequest", + "content-type": "application/json", + }, + "response": { + "docs": "Redact a conversation part", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "replyConversation": { + "auth": true, + "display-name": "Reply to a conversation", + "docs": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "errors": [ + "root.ReplyConversationRequestUnauthorizedError", + "root.ReplyConversationRequestForbiddenError", + "root.ReplyConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "User reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f18a68186f43bafdf4", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f18a68186f43bafdf4", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f18a68186f43bafdf4", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492850, + "id": "99", + "notified_at": 1719492850, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492850, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492849, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "387", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin182@email.com", + "id": "991267594", + "name": "Ciaran182 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918269", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492850, + "waiting_since": 1719492850, + }, + }, + }, + { + "name": "Admin note reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "admin_id": "3156780", + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "message_type": "note", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f38a68186f43bafdf5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin183@email.com", + "id": "991267596", + "name": "Ciaran183 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719492853, + "id": "100", + "notified_at": 1719492853, + "part_type": "note", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492853, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492852, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "388", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin183@email.com", + "id": "991267596", + "name": "Ciaran183 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918270", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492853, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "User last conversation reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f78a68186f43bafdf7", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f78a68186f43bafdf7", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f78a68186f43bafdf7", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492856, + "id": "101", + "notified_at": 1719492856, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492856, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492855, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492856, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "390", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin185@email.com", + "id": "991267600", + "name": "Ciaran185 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918272", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492856, + "waiting_since": 1719492856, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f98a68186f43bafdf8", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f18a68186f43bafdf4", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f18a68186f43bafdf4", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492850, + "id": "99", + "notified_at": 1719492850, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492850, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492849, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "387", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin182@email.com", + "id": "991267594", + "name": "Ciaran182 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918269", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492850, + "waiting_since": 1719492850, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/reply", + "path-parameters": { + "id": { + "docs": "The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation", + "type": "string", + }, + }, + "request": { + "body": "root.ReplyConversationRequest", + "content-type": "application/json", + }, + "response": { + "docs": "User last conversation reply", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveConversation": { + "auth": true, + "display-name": "Retrieve a conversation", + "docs": " +You can fetch the details of a single conversation. + +This will return a single Conversation model with all its conversation parts. + +{% admonition type="warning" name="Hard limit of 500 parts" %} +The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. +{% /admonition %} + +For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). +", + "errors": [ + "root.RetrieveConversationRequestUnauthorizedError", + "root.RetrieveConversationRequestForbiddenError", + "root.RetrieveConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "conversation found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60d88a68186f43bafde1", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 0, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492825, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "367", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin153@email.com", + "id": "991267553", + "name": "Ciaran153 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918255", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492825, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/conversations/{id}", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "name": "RetrieveConversationRequest", + "query-parameters": { + "display_as": { + "docs": "Set to plaintext to retrieve conversation messages in plain text.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "conversation found", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchConversations": { + "auth": true, + "display-name": "Search conversations", + "docs": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + +To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + +This will accept a query object in the body which will define your filters in order to search for conversations. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | +| source.id | String | +| source.delivered_as | String | +| source.subject | String | +| source.body | String | +| source.author.id | String | +| source.author.type | String | +| source.author.name | String | +| source.author.email | String | +| source.url | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| channel_initiated | String | +| open | Boolean | +| read | Boolean | +| state | String | +| waiting_since | Date (UNIX timestamp) | +| snoozed_until | Date (UNIX timestamp) | +| tag_ids | String | +| priority | String | +| statistics.time_to_assignment | Integer | +| statistics.time_to_admin_reply | Integer | +| statistics.time_to_first_close | Integer | +| statistics.time_to_last_close | Integer | +| statistics.median_time_to_reply | Integer | +| statistics.first_contact_reply_at | Date (UNIX timestamp) | +| statistics.first_assignment_at | Date (UNIX timestamp) | +| statistics.first_admin_reply_at | Date (UNIX timestamp) | +| statistics.first_close_at | Date (UNIX timestamp) | +| statistics.last_assignment_at | Date (UNIX timestamp) | +| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_contact_reply_at | Date (UNIX timestamp) | +| statistics.last_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_close_at | Date (UNIX timestamp) | +| statistics.last_closed_by_id | String | +| statistics.count_reopens | Integer | +| statistics.count_assignments | Integer | +| statistics.count_conversation_parts | Integer | +| conversation_rating.requested_at | Date (UNIX timestamp) | +| conversation_rating.replied_at | Date (UNIX timestamp) | +| conversation_rating.score | Integer | +| conversation_rating.remark | String | +| conversation_rating.contact_id | String | +| conversation_rating.admin_d | String | +| ai_agent_participated | Boolean | +| ai_agent.resolution_state | String | +| ai_agent.last_answer_type | String | +| ai_agent.rating | Integer | +| ai_agent.rating_remark | String | +| ai_agent.source_type | String | +| ai_agent.source_title | String | + +### Accepted Operators + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "conversations": [ + { + "admin_assignee_id": 0, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60ea8a68186f43bafdec", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "total_count": 2, + }, + "conversation_rating": { + "created_at": 1671028894, + "rating": 5, + "remark": "", + }, + "created_at": 1719492843, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + }, + "id": "378", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin180@email.com", + "id": "991267591", + "name": "Ciaran180 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918266", + "redacted": false, + "subject": "", + "type": "conversation", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492843, + "waiting_since": 1663597260, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "conversation.list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.ConversationList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateConversation": { + "auth": true, + "display-name": "Update a conversation", + "docs": " +You can update an existing conversation. + +{% admonition type="info" name="Replying and other actions" %} +If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. +{% /admonition %} + +", + "errors": [ + "root.UpdateConversationRequestUnauthorizedError", + "root.UpdateConversationRequestForbiddenError", + "root.UpdateConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "conversation found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "read": true, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60e08a68186f43bafde5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "96", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "97", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492832, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "371", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin157@email.com", + "id": "991267561", + "name": "Ciaran157 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918259", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492834, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "read": true, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60e08a68186f43bafde5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "96", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "97", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492832, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "371", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin157@email.com", + "id": "991267561", + "name": "Ciaran157 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918259", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492834, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/conversations/{id}", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "custom_attributes": { + "type": "optional", + }, + "read": { + "docs": "Mark a conversation as read within Intercom.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateConversationRequest", + "query-parameters": { + "display_as": { + "docs": "Set to plaintext to retrieve conversation messages in plain text.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "conversation found", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "AttachContactToConversationRequestCustomer": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "AttachContactToConversationRequestCustomerIntercomUserId", + }, + { + "type": "AttachContactToConversationRequestCustomerUserId", + }, + { + "type": "Email", + }, + ], + }, + "AttachContactToConversationRequestCustomerIntercomUserId": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AttachContactToConversationRequestCustomerUserId": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "user_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Conversation": { + "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "properties": { + "admin_assignee_id": { + "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", + "type": "optional", + }, + "ai_agent": { + "type": "optional", + }, + "ai_agent_participated": { + "docs": "Indicates whether the AI Agent participated in the conversation.", + "type": "optional", + }, + "contacts": { + "type": "optional", + }, + "conversation_parts": { + "type": "optional", + }, + "conversation_rating": { + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation was created.", + "type": "optional", + }, + "custom_attributes": { + "type": "optional", + }, + "first_contact_reply": { + "type": "optional", + }, + "id": { + "docs": "The id representing the conversation.", + "type": "optional", + }, + "linked_objects": { + "type": "optional", + }, + "open": { + "docs": "Indicates whether a conversation is open (true) or closed (false).", + "type": "optional", + }, + "priority": { + "docs": "If marked as priority, it will return priority or else not_priority.", + "type": "optional", + }, + "read": { + "docs": "Indicates whether a conversation has been read.", + "type": "optional", + }, + "sla_applied": { + "type": "optional", + }, + "snoozed_until": { + "docs": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", + "type": "optional", + }, + "source": { + "type": "optional", + }, + "state": { + "docs": "Can be set to "open", "closed" or "snoozed".", + "type": "optional", + }, + "statistics": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "team_assignee_id": { + "docs": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", + "type": "optional", + }, + "teammates": { + "type": "optional", + }, + "title": { + "docs": "The title given to the conversation.", + "type": "optional", + }, + "type": { + "docs": "Always conversation.", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the conversation was updated.", + "type": "optional", + }, + "waiting_since": { + "docs": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPriority": { + "docs": "If marked as priority, it will return priority or else not_priority.", + "enum": [ + "priority", + "not_priority", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationState": { + "docs": "Can be set to "open", "closed" or "snoozed".", + "enum": [ + "open", + "closed", + "snoozed", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateConversationRequestFrom": { + "docs": undefined, + "properties": { + "id": { + "docs": "The identifier for the contact which is given by Intercom.", + "type": "string", + "validation": { + "format": "uuid", + "maxLength": 24, + "minLength": 24, + "pattern": undefined, + }, + }, + "type": { + "docs": "The role associated to the contact - user or lead.", + "type": "CreateConversationRequestFromType", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateConversationRequestFromType": { + "docs": "The role associated to the contact - user or lead.", + "enum": [ + "lead", + "user", + "contact", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "email": { + "docs": "The email you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ManageConversationRequestBody": { + "availability": undefined, + "base-properties": {}, + "discriminant": "message_type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "assignment": { + "type": "root.AssignConversationRequest", + }, + "close": { + "type": "root.CloseConversationRequest", + }, + "open": { + "type": "root.OpenConversationRequest", + }, + "snoozed": { + "type": "root.SnoozeConversationRequest", + }, + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + messages: messages.yml + tickets: tickets.yml + aiAgent: aiAgent.yml +service: + auth: false + base-path: '' + endpoints: + listConversations: + path: /conversations + method: GET + auth: true + docs: > + You can fetch a list of all conversations. + + + You can optionally request the result page size and the cursor to start + after to fetch the result. + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all conversations + request: + name: ListConversationsRequest + query-parameters: + per_page: + type: optional + docs: How many results per page + starting_after: + type: optional + docs: String used to get the next page of conversations. + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.ListConversationsRequestUnauthorizedError + - root.ListConversationsRequestForbiddenError + examples: + - name: successful + response: + body: + type: conversation.list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + total_count: 1 + data: + - type: newsfeed + id: '12312' + name: My Newsfeed + created_at: 1674917488 + updated_at: 1674917488 + createConversation: + path: /conversations + method: POST + auth: true + docs: >+ + You can create a conversation that has been initiated by a contact (ie. + user or lead). + + The conversation can be an in-app message only. + + + {% admonition type="info" name="Sending for visitors" %} + + You can also send a message from a visitor by specifying their `user_id` + or `id` value in the `from` field, along with a `type` field value of + `contact`. + + This visitor will be automatically converted to a contact with a lead + role once the conversation is created. + + {% /admonition %} + + + This will return the Message model that has been created. + + source: + openapi: ../openapi.yml + display-name: Creates a conversation + request: + name: CreateConversationRequest + body: + properties: + from: CreateConversationRequestFrom + body: + type: string + docs: The content of the message. HTML is not supported. + content-type: application/json + response: + docs: conversation created + type: messages.Message + errors: + - root.CreateConversationRequestUnauthorizedError + - root.CreateConversationRequestForbiddenError + - root.CreateConversationRequestNotFoundError + examples: + - name: conversation created + request: + from: + type: user + id: 667d60d18a68186f43bafddd + body: Hello there + response: + body: + type: user_message + id: '403918251' + created_at: 1719492819 + subject: Greetings + body: Hello there + message_type: inapp + conversation_id: '363' + - name: Contact Not Found + request: + from: + type: user + id: 123_doesnt_exist + body: Hello there + response: + body: + type: user_message + id: '403918251' + created_at: 1719492819 + subject: Greetings + body: Hello there + message_type: inapp + conversation_id: '363' + retrieveConversation: + path: /conversations/{id} + method: GET + auth: true + docs: > + + You can fetch the details of a single conversation. + + + This will return a single Conversation model with all its conversation + parts. + + + {% admonition type="warning" name="Hard limit of 500 parts" %} + + The maximum number of conversation parts that can be returned via the + API is 500. If you have more than that we will return the 500 most + recent conversation parts. + + {% /admonition %} + + + For AI agent conversation metadata, please note that you need to have + the agent enabled in your workspace, which is a [paid + feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Retrieve a conversation + request: + name: RetrieveConversationRequest + query-parameters: + display_as: + type: optional + docs: Set to plaintext to retrieve conversation messages in plain text. + response: + docs: conversation found + type: Conversation + errors: + - root.RetrieveConversationRequestUnauthorizedError + - root.RetrieveConversationRequestForbiddenError + - root.RetrieveConversationRequestNotFoundError + examples: + - name: conversation found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + response: + body: + type: conversation + id: '367' + title: Conversation Title + created_at: 1719492825 + updated_at: 1719492825 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918255' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267553' + name: Ciaran153 Lee + email: admin153@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60d88a68186f43bafde1 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 0 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + updateConversation: + path: /conversations/{id} + method: PUT + auth: true + docs: >+ + + You can update an existing conversation. + + + {% admonition type="info" name="Replying and other actions" %} + + If you want to reply to a coveration or take an action such as assign, + unassign, open, close or snooze, take a look at the reply and manage + endpoints. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Update a conversation + request: + name: UpdateConversationRequest + query-parameters: + display_as: + type: optional + docs: Set to plaintext to retrieve conversation messages in plain text. + body: + properties: + read: + type: optional + docs: Mark a conversation as read within Intercom. + custom_attributes: + type: optional + content-type: application/json + response: + docs: conversation found + type: Conversation + errors: + - root.UpdateConversationRequestUnauthorizedError + - root.UpdateConversationRequestForbiddenError + - root.UpdateConversationRequestNotFoundError + examples: + - name: conversation found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + request: + read: true + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: conversation + id: '371' + title: Conversation Title + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + issue_type: Billing + priority: High + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + request: + read: true + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: conversation + id: '371' + title: Conversation Title + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + issue_type: Billing + priority: High + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + searchConversations: + path: /conversations/search + method: POST + auth: true + docs: > + You can search for multiple conversations by the value of their + attributes in order to fetch exactly which ones you want. + + + To search for conversations, you need to send a `POST` request to + `https://api.intercom.io/conversations/search`. + + + This will accept a query object in the body which will define your + filters in order to search for conversations. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiple's there can be: + + - There's a limit of max 2 nested filters + + - There's a limit of max 15 filters for each AND or OR group + + + ### Accepted Fields + + + Most keys listed as part of the The conversation model is searchable, + whether writeable or not. The value you search for has to match the + accepted type, otherwise the query will fail (ie. as `created_at` + accepts a date, the `value` cannot be a string such as `"foorbar"`). + + + | Field | + Type + | + + | :---------------------------------------- | + :----------------------------------------------------------------------------------------------------------------------------------------------------- + | + + | id | + String + | + + | created_at | Date (UNIX + timestamp) + | + + | updated_at | Date (UNIX + timestamp) + | + + | source.type | String
Accepted fields + are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, + `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + + | source.id | + String + | + + | source.delivered_as | + String + | + + | source.subject | + String + | + + | source.body | + String + | + + | source.author.id | + String + | + + | source.author.type | + String + | + + | source.author.name | + String + | + + | source.author.email | + String + | + + | source.url | + String + | + + | contact_ids | + String + | + + | teammate_ids | + String + | + + | admin_assignee_id | + String + | + + | team_assignee_id | + String + | + + | channel_initiated | + String + | + + | open | + Boolean + | + + | read | + Boolean + | + + | state | + String + | + + | waiting_since | Date (UNIX + timestamp) + | + + | snoozed_until | Date (UNIX + timestamp) + | + + | tag_ids | + String + | + + | priority | + String + | + + | statistics.time_to_assignment | + Integer + | + + | statistics.time_to_admin_reply | + Integer + | + + | statistics.time_to_first_close | + Integer + | + + | statistics.time_to_last_close | + Integer + | + + | statistics.median_time_to_reply | + Integer + | + + | statistics.first_contact_reply_at | Date (UNIX + timestamp) + | + + | statistics.first_assignment_at | Date (UNIX + timestamp) + | + + | statistics.first_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.first_close_at | Date (UNIX + timestamp) + | + + | statistics.last_assignment_at | Date (UNIX + timestamp) + | + + | statistics.last_assignment_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_contact_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_close_at | Date (UNIX + timestamp) + | + + | statistics.last_closed_by_id | + String + | + + | statistics.count_reopens | + Integer + | + + | statistics.count_assignments | + Integer + | + + | statistics.count_conversation_parts | + Integer + | + + | conversation_rating.requested_at | Date (UNIX + timestamp) + | + + | conversation_rating.replied_at | Date (UNIX + timestamp) + | + + | conversation_rating.score | + Integer + | + + | conversation_rating.remark | + String + | + + | conversation_rating.contact_id | + String + | + + | conversation_rating.admin_d | + String + | + + | ai_agent_participated | + Boolean + | + + | ai_agent.resolution_state | + String + | + + | ai_agent.last_answer_type | + String + | + + | ai_agent.rating | + Integer + | + + | ai_agent.rating_remark | + String + | + + | ai_agent.source_type | + String + | + + | ai_agent.source_title | + String + | + + + ### Accepted Operators + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :----------------------------- | + :----------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In Shortcut for `OR` + queries Values most be in Array | + + | NIN | All | Not In Shortcut for `OR + !` queries Values must be in Array | + + | > | Integer Date (UNIX Timestamp) | Greater (or equal) + than | + + | < | Integer Date (UNIX Timestamp) | Lower (or equal) + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search conversations + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.ConversationList + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: conversation.list + conversations: + - type: conversation + id: '378' + title: Conversation Title + created_at: 1719492843 + updated_at: 1719492843 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + source: + type: conversation + id: '403918266' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267591' + name: Ciaran180 Lee + email: admin180@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ea8a68186f43bafdec + external_id: '70' + teammates: + type: admin.list + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + sla_applied: + type: conversation_sla_summary + sla_name: '' + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + total_count: 1 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 1 + replyConversation: + path: /conversations/{id}/reply + method: POST + auth: true + docs: >- + You can reply to a conversation with a message from an admin or on + behalf of a contact, or with a note for admins. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + display-name: Reply to a conversation + request: + body: root.ReplyConversationRequest + content-type: application/json + response: + docs: User last conversation reply + type: Conversation + errors: + - root.ReplyConversationRequestUnauthorizedError + - root.ReplyConversationRequestForbiddenError + - root.ReplyConversationRequestNotFoundError + examples: + - name: User reply + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f18a68186f43bafdf4 + response: + body: + type: conversation + id: '387' + title: Conversation Title + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492850 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body:

Thanks again :)

+ created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + author: + type: user + id: 667d60f18a68186f43bafdf4 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Admin note reply + path-parameters: + id: 123 or "last" + request: + message_type: note + type: admin + body: >- +

An Unordered HTML List

    +
  • Coffee
  • Tea
  • Milk

An + Ordered HTML List

  1. Coffee
  2. Tea
  3. +
  4. Milk
+ admin_id: '3156780' + response: + body: + type: conversation + id: '388' + title: Conversation Title + created_at: 1719492852 + updated_at: 1719492853 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918270' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f38a68186f43bafdf5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '100' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719492853 + updated_at: 1719492853 + notified_at: 1719492853 + author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: User last conversation reply + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f78a68186f43bafdf7 + response: + body: + type: conversation + id: '390' + title: Conversation Title + created_at: 1719492855 + updated_at: 1719492856 + waiting_since: 1719492856 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918272' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267600' + name: Ciaran185 Lee + email: admin185@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f78a68186f43bafdf7 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492856 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '101' + part_type: open + body:

Thanks again :)

+ created_at: 1719492856 + updated_at: 1719492856 + notified_at: 1719492856 + author: + type: user + id: 667d60f78a68186f43bafdf7 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f98a68186f43bafdf8 + response: + body: + type: conversation + id: '387' + title: Conversation Title + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492850 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body:

Thanks again :)

+ created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + author: + type: user + id: 667d60f18a68186f43bafdf4 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + manageConversation: + path: /conversations/{id}/parts + method: POST + auth: true + docs: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Manage a conversation + request: + body: ManageConversationRequestBody + content-type: application/json + response: + docs: Assign a conversation + type: Conversation + errors: + - root.ManageConversationRequestUnauthorizedError + - root.ManageConversationRequestForbiddenError + - root.ManageConversationRequestNotFoundError + examples: + - name: Close a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Goodbye :) + response: + body: + type: conversation + id: '394' + title: Conversation Title + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body:

Goodbye :)

+ created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Snooze a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '395' + title: Conversation Title + created_at: 1719492864 + updated_at: 1719492864 + waiting_since: 1663597260 + snoozed_until: 1719496464 + open: true + state: snoozed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918277' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ff8a68186f43bafdfc + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '103' + part_type: snoozed + created_at: 1719492864 + updated_at: 1719492864 + notified_at: 1719492864 + author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Open a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '400' + title: '' + created_at: 1719492863 + updated_at: 1719492873 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918278' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61038a68186f43bafe01 + external_id: '74' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '105' + part_type: open + created_at: 1719492873 + updated_at: 1719492873 + notified_at: 1719492873 + author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Assign a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '405' + title: Conversation Title + created_at: 1719492874 + updated_at: 1719492875 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 991267615 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918281' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d610a8a68186f43bafe05 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '106' + part_type: assign_and_reopen + created_at: 1719492875 + updated_at: 1719492875 + notified_at: 1719492875 + assigned_to: + type: admin + id: '991267615' + author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Goodbye :) + response: + body: + type: conversation + id: '394' + title: Conversation Title + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body:

Goodbye :)

+ created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + autoAssignConversation: + path: /conversations/{id}/run_assignment_rules + method: POST + auth: true + docs: > + You can let a conversation be automatically assigned following + assignment rules. + + {% admonition type="attention" name="When using workflows" %} + + It is not possible to use this endpoint with Workflows. + + {% /admonition %} + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Run Assignment Rules on a conversation + response: + docs: Assign a conversation using assignment rules + type: Conversation + errors: + - root.AutoAssignConversationRequestUnauthorizedError + - root.AutoAssignConversationRequestForbiddenError + - root.AutoAssignConversationRequestNotFoundError + examples: + - name: Assign a conversation using assignment rules + path-parameters: + id: '123' + response: + body: + type: conversation + id: '409' + title: Conversation Title + created_at: 1719492880 + updated_at: 1719492881 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918285' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267623' + name: Ciaran197 Lee + email: admin197@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61108a68186f43bafe09 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '107' + part_type: default_assignment + created_at: 1719492881 + updated_at: 1719492881 + notified_at: 1719492881 + assigned_to: + type: nobody_admin + author: + type: bot + id: '991267624' + name: Operator + email: >- + operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + attachContactToConversation: + path: /conversations/{id}/customers + method: POST + auth: true + docs: >+ + You can add participants who are contacts to a conversation, on behalf + of either another contact or an admin. + + + {% admonition type="attention" name="Contacts without an email" %} + + If you add a contact via the email parameter and there is no user/lead + found on that workspace with he given email, then we will create a new + contact with `role` set to `lead`. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Attach a contact to a conversation + request: + name: AttachContactToConversationRequest + body: + properties: + admin_id: + type: optional + docs: The `id` of the admin who is adding the new participant. + customer: + type: optional + content-type: application/json + response: + docs: Attach a contact to a conversation + type: Conversation + errors: + - root.AttachContactToConversationRequestUnauthorizedError + - root.AttachContactToConversationRequestForbiddenError + - root.AttachContactToConversationRequestNotFoundError + examples: + - name: Attach a contact to a conversation + path-parameters: + id: '123' + request: + admin_id: '12345' + customer: + intercom_user_id: 667d61168a68186f43bafe0d + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: '123' + request: + admin_id: '12345' + customer: + intercom_user_id: 667d61188a68186f43bafe0e + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + detachContactFromConversation: + path: /conversations/{conversation_id}/customers/{contact_id} + method: DELETE + auth: true + docs: >+ + You can add participants who are contacts to a conversation, on behalf + of either another contact or an admin. + + + {% admonition type="attention" name="Contacts without an email" %} + + If you add a contact via the email parameter and there is no user/lead + found on that workspace with he given email, then we will create a new + contact with `role` set to `lead`. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: The identifier for the conversation as given by Intercom. + contact_id: + type: string + docs: The identifier for the contact as given by Intercom. + display-name: Detach a contact from a group conversation + request: + name: DetachContactFromConversationRequest + body: + properties: + admin_id: + type: string + docs: The `id` of the admin who is performing the action. + content-type: application/json + response: + docs: Detach a contact from a group conversation + type: Conversation + errors: + - root.DetachContactFromConversationRequestUnauthorizedError + - root.DetachContactFromConversationRequestForbiddenError + - root.DetachContactFromConversationRequestNotFoundError + - root.DetachContactFromConversationRequestUnprocessableEntityError + examples: + - name: Detach a contact from a group conversation + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Conversation not found + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Contact not found + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Last customer + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + redactConversation: + path: /conversations/redact + method: POST + auth: true + docs: >+ + You can redact a conversation part or the source message of a + conversation (as seen in the source object). + + + {% admonition type="info" name="Redacting parts and messages" %} + + If you are redacting a conversation part, it must have a `body`. If you + are redacting a source message, it must have been created by a contact. + We will return a `conversation_part_not_redactable` error if these + criteria are not met. + + {% /admonition %} + + source: + openapi: ../openapi.yml + display-name: Redact a conversation part + request: + body: root.RedactConversationRequest + content-type: application/json + response: + docs: Redact a conversation part + type: Conversation + errors: + - root.RedactConversationRequestUnauthorizedError + - root.RedactConversationRequestNotFoundError + examples: + - name: Redact a conversation part + request: + type: conversation_part + conversation_id: '19894788788' + conversation_part_id: '19381789428' + response: + body: + type: conversation + id: '471' + title: Conversation Title + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492939 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body:

This message was deleted

+ created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + author: + type: user + id: 667d614a8a68186f43bafe42 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: true + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + request: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + response: + body: + type: conversation + id: '471' + title: Conversation Title + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492939 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body:

This message was deleted

+ created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + author: + type: user + id: 667d614a8a68186f43bafe42 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: true + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + convertConversationToTicket: + path: /conversations/{id}/convert + method: POST + auth: true + docs: You can convert a conversation to a ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Convert a conversation to a ticket + request: + name: ConvertConversationToTicketRequest + body: + properties: + ticket_type_id: + type: string + docs: >- + The ID of the type of ticket you want to convert the + conversation to + attributes: + type: optional + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.ConvertConversationToTicketRequestBadRequestError + examples: + - name: successful + path-parameters: + id: 1 + request: + ticket_type_id: '79' + response: + body: + type: ticket + id: '474' + ticket_id: '37' + category: Customer + ticket_attributes: + key: value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + category: Customer + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id404_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719492947 + updated_at: 1719492947 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body:

Comment for message

+ created_at: 1719492945 + updated_at: 1719492945 + author: + type: user + id: 667d61518a68186f43bafe45 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + type: bot + id: '991267667' + name: Operator + email: >- + operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + - name: Bad request + path-parameters: + id: 1 + request: + ticket_type_id: '80' + response: + body: + type: ticket + id: '474' + ticket_id: '37' + category: Customer + ticket_attributes: + key: value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + category: Customer + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id404_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719492947 + updated_at: 1719492947 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body:

Comment for message

+ created_at: 1719492945 + updated_at: 1719492945 + author: + type: user + id: 667d61518a68186f43bafe45 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + type: bot + id: '991267667' + name: Operator + email: >- + operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + source: + openapi: ../openapi.yml + display-name: Conversations +docs: Everything about your Conversations +types: + CreateConversationRequestFromType: + enum: + - lead + - user + - contact + docs: The role associated to the contact - user or lead. + source: + openapi: ../openapi.yml + CreateConversationRequestFrom: + properties: + type: + type: CreateConversationRequestFromType + docs: The role associated to the contact - user or lead. + id: + type: string + docs: The identifier for the contact which is given by Intercom. + validation: + format: uuid + minLength: 24 + maxLength: 24 + source: + openapi: ../openapi.yml + ManageConversationRequestBody: + discriminant: message_type + base-properties: {} + union: + close: + type: root.CloseConversationRequest + snoozed: + type: root.SnoozeConversationRequest + open: + type: root.OpenConversationRequest + assignment: + type: root.AssignConversationRequest + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomerIntercomUserId: + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + customer: + type: optional + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomerUserId: + properties: + user_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + customer: + type: optional + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. + customer: + type: optional + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomer: + discriminated: false + union: + - type: AttachContactToConversationRequestCustomerIntercomUserId + - type: AttachContactToConversationRequestCustomerUserId + - type: Email + source: + openapi: ../openapi.yml + ConversationState: + enum: + - open + - closed + - snoozed + docs: Can be set to "open", "closed" or "snoozed". + source: + openapi: ../openapi.yml + ConversationPriority: + enum: + - priority + - not_priority + docs: If marked as priority, it will return priority or else not_priority. + source: + openapi: ../openapi.yml + Conversation: + docs: >- + Conversations are how you can communicate with users in Intercom. They are + created when a contact replies to an outbound message, or when one admin + directly sends a message to a single contact. + properties: + type: + type: optional + docs: Always conversation. + id: + type: optional + docs: The id representing the conversation. + title: + type: optional + docs: The title given to the conversation. + created_at: + type: optional + docs: The time the conversation was created. + updated_at: + type: optional + docs: The last time the conversation was updated. + waiting_since: + type: optional + docs: >- + The last time a Contact responded to an Admin. In other words, the + time a customer started waiting for a response. Set to null if last + reply is from an Admin. + snoozed_until: + type: optional + docs: >- + If set this is the time in the future when this conversation will be + marked as open. i.e. it will be in a snoozed state until this time. + i.e. it will be in a snoozed state until this time. + open: + type: optional + docs: Indicates whether a conversation is open (true) or closed (false). + state: + type: optional + docs: Can be set to "open", "closed" or "snoozed". + read: + type: optional + docs: Indicates whether a conversation has been read. + priority: + type: optional + docs: If marked as priority, it will return priority or else not_priority. + admin_assignee_id: + type: optional + docs: >- + The id of the admin assigned to the conversation. If it's not assigned + to an admin it will return null. + team_assignee_id: + type: optional + docs: >- + The id of the team assigned to the conversation. If it's not assigned + to a team it will return null. + tags: + type: optional + conversation_rating: + type: optional + source: + type: optional + contacts: + type: optional + teammates: + type: optional + custom_attributes: + type: optional + first_contact_reply: + type: optional + sla_applied: + type: optional + statistics: + type: optional + conversation_parts: + type: optional + linked_objects: + type: optional + ai_agent_participated: + type: optional + docs: Indicates whether the AI Agent participated in the conversation. + ai_agent: + type: optional + source: + openapi: ../openapi.yml +", + }, + "customObjectInstances.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "types": { + "CustomObjectInstance": { + "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "properties": { + "custom_attributes": { + "docs": "The custom attributes you have set on the custom object instance.", + "type": "optional>", + }, + "external_id": { + "docs": "The id you have defined for the custom object instance.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the custom object instance.", + "type": "optional", + }, + "type": { + "docs": "The identifier of the custom object type that defines the structure of the custom object instance.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + CustomObjectInstance: + docs: >- + A Custom Object Instance represents an instance of a custom object type. + This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom + attributes. + properties: + id: + type: optional + docs: The Intercom defined id representing the custom object instance. + external_id: + type: optional + docs: The id you have defined for the custom object instance. + type: + type: optional + docs: >- + The identifier of the custom object type that defines the structure of + the custom object instance. + custom_attributes: + type: optional> + docs: The custom attributes you have set on the custom object instance. + source: + openapi: ../openapi.yml +", + }, + "dataAttributes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Attributes", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Attributes", + "endpoints": { + "createDataAttribute": { + "auth": true, + "display-name": "Create a data attribute", + "docs": "You can create a data attributes for a `contact` or a `company`.", + "errors": [ + "root.CreateDataAttributeRequestBadRequestError", + "root.CreateDataAttributeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "request": { + "data_type": "string", + "model": "company", + "name": "Mithril Shirt", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Same name already exists", + "request": { + "data_type": "integer", + "model": "contact", + "name": "The One Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Invalid name", + "request": { + "data_type": "string", + "model": "company", + "name": "!nv@l!d n@me", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Attribute already exists", + "request": { + "data_type": "string", + "model": "company", + "name": "The One Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Invalid Data Type", + "request": { + "data_type": "string", + "model": "company", + "name": "The Second Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Too few options for list", + "request": { + "data_type": "string", + "description": "Just a plain old ring", + "model": "contact", + "name": "My Data Attribute", + "options": [ + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/data_attributes", + "request": { + "body": { + "properties": { + "data_type": { + "docs": "The type of data stored for this attribute.", + "type": "CreateDataAttributeRequestDataType", + }, + "description": { + "docs": "The readable description you see in the UI for the attribute.", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "model": { + "docs": "The model that the data attribute belongs to.", + "type": "CreateDataAttributeRequestModel", + }, + "name": { + "docs": "The name of the data attribute.", + "type": "string", + }, + "options": { + "docs": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "DataAttribute", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "lisDataAttributes": { + "auth": true, + "display-name": "List all data attributes", + "docs": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "errors": [ + "root.LisDataAttributesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "data": [ + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The name of a company", + "full_name": "name", + "id": 12878, + "label": "Company name", + "messenger_writable": true, + "model": "company", + "name": "name", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "A number identifying a company", + "full_name": "company_id", + "id": 12878, + "label": "Company ID", + "messenger_writable": true, + "model": "company", + "name": "company_id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The last day anyone from a company visited your site or app", + "full_name": "last_request_at", + "id": 12878, + "label": "Company last seen", + "messenger_writable": true, + "model": "company", + "name": "last_request_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The day a company was added to Intercom", + "full_name": "remote_created_at", + "id": 12878, + "label": "Company created at", + "messenger_writable": true, + "model": "company", + "name": "remote_created_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "The number of people in a company", + "full_name": "user_count", + "id": 12878, + "label": "People", + "messenger_writable": true, + "model": "company", + "name": "user_count", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "All visits from anyone in a company to your product's site or app", + "full_name": "session_count", + "id": 12878, + "label": "Company web sessions", + "messenger_writable": true, + "model": "company", + "name": "session_count", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "A specific plan or level within your product that companies have signed up to", + "full_name": "plan.name", + "id": 12878, + "label": "Plan", + "messenger_writable": true, + "model": "company", + "name": "name", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "float", + "description": "The monthly revenue you receive from a company", + "full_name": "monthly_spend", + "id": 12878, + "label": "Monthly Spend", + "messenger_writable": true, + "model": "company", + "name": "monthly_spend", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "The number of people employed in this company, expressed as a single number", + "full_name": "size", + "id": 12878, + "label": "Company size", + "messenger_writable": true, + "model": "company", + "name": "size", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "full_name": "industry", + "id": 12878, + "label": "Company industry", + "messenger_writable": true, + "model": "company", + "name": "industry", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The web address for the company's primary marketing site", + "full_name": "website", + "id": 12878, + "label": "Company website", + "messenger_writable": true, + "model": "company", + "name": "website", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "991267684", + "api_writable": true, + "archived": false, + "created_at": 1719492954, + "custom": true, + "data_type": "string", + "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "full_name": "custom_attributes.The One Ring", + "id": 34, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492954, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the company", + "full_name": "id", + "id": 12878, + "label": "ID", + "messenger_writable": true, + "model": "company", + "name": "id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The time the company was added to Intercom", + "full_name": "created_at", + "id": 12878, + "label": "Created at", + "messenger_writable": true, + "model": "company", + "name": "created_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The last time the company was updated", + "full_name": "updated_at", + "id": 12878, + "label": "Updated at", + "messenger_writable": true, + "model": "company", + "name": "updated_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the plan", + "full_name": "plan.id", + "id": 12878, + "label": "Plan ID", + "messenger_writable": true, + "model": "company", + "name": "id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the app", + "full_name": "app_id", + "id": 12878, + "label": "App ID", + "messenger_writable": true, + "model": "company", + "name": "app_id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/data_attributes", + "request": { + "name": "LisDataAttributesRequest", + "query-parameters": { + "include_archived": { + "docs": "Include archived attributes in the list. By default we return only non archived data attributes.", + "type": "optional", + }, + "model": { + "docs": "Specify the data attribute model to return.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.DataAttributeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateDataAttribute": { + "auth": true, + "display-name": "Update a data attribute", + "docs": " +You can update a data attribute. + +> 🚧 Updating the data type is not possible +> +> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead. +", + "errors": [ + "root.UpdateDataAttributeRequestBadRequestError", + "root.UpdateDataAttributeRequestUnauthorizedError", + "root.UpdateDataAttributeRequestNotFoundError", + "root.UpdateDataAttributeRequestUnprocessableEntityError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Just a plain old ring", + "options": [ + "options", + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Too few options in list", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Too few options", + "options": [ + "option1", + "option2", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Attribute Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Just a plain old ring", + "options": [ + "options", + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Has Dependant Object", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": true, + "description": "Trying to archieve", + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/data_attributes/{id}", + "path-parameters": { + "id": { + "docs": "The data attribute id", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "archived": { + "docs": "Whether the attribute is to be archived or not.", + "type": "optional", + }, + "description": { + "docs": "The readable description you see in the UI for the attribute.", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "options": { + "docs": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateDataAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "DataAttribute", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateDataAttributeRequestDataType": { + "docs": "The type of data stored for this attribute.", + "enum": [ + "string", + "integer", + "float", + "boolean", + "datetime", + "date", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateDataAttributeRequestModel": { + "docs": "The model that the data attribute belongs to.", + "enum": [ + "contact", + "company", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttribute": { + "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "properties": { + "admin_id": { + "docs": "Teammate who created the attribute. Only applicable to CDAs", + "type": "optional", + }, + "api_writable": { + "docs": "Can this attribute be updated through API", + "type": "optional", + }, + "archived": { + "docs": "Is this attribute archived. (Only applicable to CDAs)", + "type": "optional", + }, + "created_at": { + "docs": "The time the attribute was created as a UTC Unix timestamp", + "type": "optional", + }, + "custom": { + "docs": "Set to true if this is a CDA", + "type": "optional", + }, + "data_type": { + "docs": "The data type of the attribute.", + "type": "optional", + }, + "description": { + "docs": "Readable description of the attribute.", + "type": "optional", + }, + "full_name": { + "docs": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.", + "type": "optional", + }, + "label": { + "docs": "Readable name of the attribute (i.e. name you see in the UI)", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "model": { + "docs": "Value is `contact` for user/lead attributes and `company` for company attributes.", + "type": "optional", + }, + "name": { + "docs": "Name of the attribute.", + "type": "optional", + }, + "options": { + "docs": "List of predefined options for attribute value.", + "type": "optional>", + }, + "type": { + "docs": "Value is `data_attribute`.", + "type": "optional>", + }, + "ui_writable": { + "docs": "Can this attribute be updated in the UI", + "type": "optional", + }, + "updated_at": { + "docs": "The time the attribute was last updated as a UTC Unix timestamp", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeDataType": { + "docs": "The data type of the attribute.", + "enum": [ + "string", + "integer", + "float", + "boolean", + "date", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeModel": { + "docs": "Value is `contact` for user/lead attributes and `company` for company attributes.", + "enum": [ + "contact", + "company", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataAttributesRequestModel": { + "enum": [ + "contact", + "company", + "conversation", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + LisDataAttributesRequestModel: + enum: + - contact + - company + - conversation + source: + openapi: ../openapi.yml + CreateDataAttributeRequestModel: + enum: + - contact + - company + docs: The model that the data attribute belongs to. + source: + openapi: ../openapi.yml + CreateDataAttributeRequestDataType: + enum: + - string + - integer + - float + - boolean + - datetime + - date + docs: The type of data stored for this attribute. + source: + openapi: ../openapi.yml + DataAttributeModel: + enum: + - contact + - company + docs: >- + Value is `contact` for user/lead attributes and `company` for company + attributes. + source: + openapi: ../openapi.yml + DataAttributeDataType: + enum: + - string + - integer + - float + - boolean + - date + docs: The data type of the attribute. + source: + openapi: ../openapi.yml + DataAttribute: + docs: >- + Data Attributes are metadata used to describe your contact, company and + conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of + attributes for your workspace, as well as create and archive custom + attributes. + properties: + type: + type: optional> + docs: Value is `data_attribute`. + id: + type: optional + docs: >- + The unique identifier for the data attribute which is given by + Intercom. Only available for custom attributes. + model: + type: optional + docs: >- + Value is `contact` for user/lead attributes and `company` for company + attributes. + name: + type: optional + docs: Name of the attribute. + full_name: + type: optional + docs: >- + Full name of the attribute. Should match the name unless it's a nested + attribute. We can split full_name on `.` to access nested user object + values. + label: + type: optional + docs: Readable name of the attribute (i.e. name you see in the UI) + description: + type: optional + docs: Readable description of the attribute. + data_type: + type: optional + docs: The data type of the attribute. + options: + type: optional> + docs: List of predefined options for attribute value. + api_writable: + type: optional + docs: Can this attribute be updated through API + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + ui_writable: + type: optional + docs: Can this attribute be updated in the UI + custom: + type: optional + docs: Set to true if this is a CDA + archived: + type: optional + docs: Is this attribute archived. (Only applicable to CDAs) + created_at: + type: optional + docs: The time the attribute was created as a UTC Unix timestamp + updated_at: + type: optional + docs: The time the attribute was last updated as a UTC Unix timestamp + admin_id: + type: optional + docs: Teammate who created the attribute. Only applicable to CDAs + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + lisDataAttributes: + path: /data_attributes + method: GET + auth: true + docs: >- + You can fetch a list of all data attributes belonging to a workspace for + contacts, companies or conversations. + source: + openapi: ../openapi.yml + display-name: List all data attributes + request: + name: LisDataAttributesRequest + query-parameters: + model: + type: optional + docs: Specify the data attribute model to return. + include_archived: + type: optional + docs: >- + Include archived attributes in the list. By default we return only + non archived data attributes. + response: + docs: Successful response + type: root.DataAttributeList + errors: + - root.LisDataAttributesRequestUnauthorizedError + examples: + - name: Successful response + response: + body: + type: list + data: + - type: data_attribute + id: 12878 + model: company + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your site or app + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: session_count + full_name: session_count + label: Company web sessions + description: >- + All visits from anyone in a company to your product's site + or app + data_type: integer + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: name + full_name: plan.name + label: Plan + description: >- + A specific plan or level within your product that companies + have signed up to + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: size + full_name: size + label: Company size + description: >- + The number of people employed in this company, expressed as + a single number + data_type: integer + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: industry + full_name: industry + label: Company industry + description: >- + The category or domain this company belongs to e.g. + 'ecommerce' or 'SaaS' + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing site + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 34 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: >- + One ring to rule them all, one ring to find them, One ring + to bring them all and in the darkness bind them. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492954 + updated_at: 1719492954 + admin_id: '991267684' + - type: data_attribute + id: 12878 + model: company + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + createDataAttribute: + path: /data_attributes + method: POST + auth: true + docs: You can create a data attributes for a `contact` or a `company`. + source: + openapi: ../openapi.yml + display-name: Create a data attribute + request: + name: CreateDataAttributeRequest + body: + properties: + name: + type: string + docs: The name of the data attribute. + model: + type: CreateDataAttributeRequestModel + docs: The model that the data attribute belongs to. + data_type: + type: CreateDataAttributeRequestDataType + docs: The type of data stored for this attribute. + description: + type: optional + docs: The readable description you see in the UI for the attribute. + options: + type: optional> + docs: >- + To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be + `string`. + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + content-type: application/json + response: + docs: Successful + type: DataAttribute + errors: + - root.CreateDataAttributeRequestBadRequestError + - root.CreateDataAttributeRequestUnauthorizedError + examples: + - name: Successful + request: + name: Mithril Shirt + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Same name already exists + request: + name: The One Ring + model: contact + data_type: integer + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Invalid name + request: + name: '!nv@l!d n@me' + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Attribute already exists + request: + name: The One Ring + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Invalid Data Type + request: + name: The Second Ring + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Too few options for list + request: + name: My Data Attribute + model: contact + data_type: string + description: Just a plain old ring + options: + - options + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + updateDataAttribute: + path: /data_attributes/{id} + method: PUT + auth: true + docs: > + + You can update a data attribute. + + + > 🚧 Updating the data type is not possible + + > + + > It is currently a dangerous action to execute changing a data + attribute's type via the API. You will need to update the type via the + UI instead. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The data attribute id + display-name: Update a data attribute + request: + name: UpdateDataAttributeRequest + body: + properties: + archived: + type: optional + docs: Whether the attribute is to be archived or not. + description: + type: optional + docs: The readable description you see in the UI for the attribute. + options: + type: optional> + docs: >- + To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be + `string`. + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + content-type: application/json + response: + docs: Successful + type: DataAttribute + errors: + - root.UpdateDataAttributeRequestBadRequestError + - root.UpdateDataAttributeRequestUnauthorizedError + - root.UpdateDataAttributeRequestNotFoundError + - root.UpdateDataAttributeRequestUnprocessableEntityError + examples: + - name: Successful + path-parameters: + id: 1 + request: + archived: false + description: Just a plain old ring + options: + - options + - options + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Too few options in list + path-parameters: + id: 1 + request: + archived: false + description: Too few options + options: + - option1 + - option2 + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Attribute Not Found + path-parameters: + id: 1 + request: + archived: false + description: Just a plain old ring + options: + - options + - options + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Has Dependant Object + path-parameters: + id: 1 + request: + archived: true + description: Trying to archieve + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + source: + openapi: ../openapi.yml + display-name: Data Attributes +docs: Everything about your Data Attributes +", + }, + "dataEvents.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Events", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Events", + "endpoints": { + "createDataEvent": { + "auth": true, + "display-name": "Submit a data event", + "docs": " +You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + +When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + +With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + +**NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + +| Type | Description | Example | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| String | The value is a JSON String | `"source":"desktop"` | +| Number | The value is a JSON Number | `"load": 3.67` | +| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | +| Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | +| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | +| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + +**Lead Events** + +When submitting events for Leads, you will need to specify the Lead's `id`. + +**Metadata behaviour** + +- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. +- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. +- There might be up to 24 hrs delay when you send a new metadata for an existing event. + +**Event de-duplication** + +The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + +Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + +### HTTP API Responses + +- Successful responses to submitted events return `202 Accepted` with an empty body. +- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. +- Events sent about users that cannot be found will return a `404 Not Found`. +- Event lists containing duplicate events will have those duplicates ignored. +- Server errors will return a `500` response code and may contain an error message in the body. + +", + "errors": [ + "root.CreateDataEventRequestUnauthorizedError", + ], + "method": "POST", + "pagination": undefined, + "path": "/events", + "request": { + "body": "root.CreateDataEventRequestTwo", + "content-type": "application/json", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "dataEventSummaries": { + "auth": true, + "display-name": "Create event summaries", + "docs": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + +", + "errors": [ + "root.DataEventSummariesRequestUnauthorizedError", + ], + "examples": [ + { + "request": {}, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/events/summaries", + "request": { + "body": { + "properties": { + "event_summaries": { + "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "optional", + }, + "user_id": { + "docs": "Your identifier for the user.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataEventSummariesRequest", + "query-parameters": undefined, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "lisDataEvents": { + "auth": true, + "display-name": "List all data events", + "docs": " +> 🚧 +> +> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days + +The events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`. + +- `https://api.intercom.io/events?type=user&user_id={user_id}` +- `https://api.intercom.io/events?type=user&email={email}` +- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads) + +The `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + +You can optionally define the result page size as well with the `per_page` parameter. +", + "errors": [ + "root.LisDataEventsRequestUnauthorizedError", + ], + "method": "GET", + "pagination": undefined, + "path": "/events", + "request": { + "name": "LisDataEventsRequest", + "query-parameters": { + "filter": "LisDataEventsRequestFilter", + "summary": { + "docs": "summary flag", + "type": "optional", + }, + "type": { + "docs": "The value must be user", + "type": "string", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.DataEventSummary", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateDataEventSummariesRequestEventSummaries": { + "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "properties": { + "count": { + "docs": "The number of times the event occurred.", + "type": "optional", + }, + "event_name": { + "docs": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "optional", + }, + "first": { + "docs": "The first time the event was sent", + "type": "optional", + }, + "last": { + "docs": "The last time the event was sent", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEvent": { + "docs": "Data events are used to notify Intercom of changes to your data.", + "properties": { + "created_at": { + "docs": "The time the event occurred as a UTC Unix timestamp", + "type": "integer", + }, + "email": { + "docs": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", + "type": "optional", + }, + "event_name": { + "docs": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "string", + }, + "id": { + "docs": "Your identifier for a lead or a user.", + "type": "optional", + }, + "intercom_user_id": { + "docs": "The Intercom identifier for the user.", + "type": "optional", + }, + "metadata": { + "docs": "Optional metadata about the event.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + "user_id": { + "docs": "Your identifier for the user.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilter": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "LisDataEventsRequestFilterUserId", + }, + { + "type": "LisDataEventsRequestFilterIntercomUserId", + }, + { + "type": "LisDataEventsRequestFilterEmail", + }, + ], + }, + "LisDataEventsRequestFilterEmail": { + "docs": undefined, + "properties": { + "email": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilterIntercomUserId": { + "docs": undefined, + "properties": { + "intercom_user_id": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilterUserId": { + "docs": undefined, + "properties": { + "user_id": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + LisDataEventsRequestFilterUserId: + properties: + user_id: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilterIntercomUserId: + properties: + intercom_user_id: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilterEmail: + properties: + email: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilter: + discriminated: false + union: + - type: LisDataEventsRequestFilterUserId + - type: LisDataEventsRequestFilterIntercomUserId + - type: LisDataEventsRequestFilterEmail + source: + openapi: ../openapi.yml + CreateDataEventSummariesRequestEventSummaries: + docs: >- + A list of event summaries for the user. Each event summary should contain + the event name, the time the event occurred, and the number of times the + event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: optional + docs: >- + The name of the event that occurred. A good event name is typically a + past tense 'verb-noun' combination, to improve readability, for + example `updated-plan`. + count: + type: optional + docs: The number of times the event occurred. + first: + type: optional + docs: The first time the event was sent + last: + type: optional + docs: The last time the event was sent + source: + openapi: ../openapi.yml + DataEvent: + docs: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: optional> + docs: The type of the object + event_name: + type: string + docs: >- + The name of the event that occurred. This is presented to your App's + admins when filtering and creating segments - a good event name is + typically a past tense 'verb-noun' combination, to improve + readability, for example `updated-plan`. + created_at: + type: integer + docs: The time the event occurred as a UTC Unix timestamp + user_id: + type: optional + docs: Your identifier for the user. + id: + type: optional + docs: Your identifier for a lead or a user. + intercom_user_id: + type: optional + docs: The Intercom identifier for the user. + email: + type: optional + docs: >- + An email address for your user. An email should only be used where + your application uses email to uniquely identify users. + metadata: + type: optional> + docs: Optional metadata about the event. + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + lisDataEvents: + path: /events + method: GET + auth: true + docs: > + + > 🚧 + + > + + > Please note that you can only 'list' events that are less than 90 days + old. Event counts and summaries will still include your events older + than 90 days but you cannot 'list' these events individually if they are + older than 90 days + + + The events belonging to a customer can be listed by sending a GET + request to `https://api.intercom.io/events` with a user or lead + identifier along with a `type` parameter. The identifier parameter can + be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`. + + + - `https://api.intercom.io/events?type=user&user_id={user_id}` + + - `https://api.intercom.io/events?type=user&email={email}` + + - `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this + call can be used to list leads) + + + The `email` parameter value should be [url + encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + + + You can optionally define the result page size as well with the + `per_page` parameter. + source: + openapi: ../openapi.yml + display-name: List all data events + request: + name: LisDataEventsRequest + query-parameters: + filter: LisDataEventsRequestFilter + type: + type: string + docs: The value must be user + summary: + type: optional + docs: summary flag + response: + docs: Successful response + type: root.DataEventSummary + errors: + - root.LisDataEventsRequestUnauthorizedError + createDataEvent: + path: /events + method: POST + auth: true + docs: >+ + + You will need an Access Token that has write permissions to send Events. + Once you have a key you can submit events via POST to the Events + resource, which is located at https://api.intercom.io/events, or you can + send events using one of the client libraries. When working with the + HTTP API directly a client should send the event with a `Content-Type` + of `application/json`. + + + When using the JavaScript API, [adding the code to your + app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) + makes the Events API available. Once added, you can submit an event + using the `trackEvent` method. This will associate the event with the + Lead or currently logged-in user or logged-out visitor/lead and send it + to Intercom. The final parameter is a map that can be used to send + optional metadata about the event. + + + With the Ruby client you pass a hash describing the event to + `Intercom::Event.create`, or call the `track_user` method directly on + the current user object (e.g. `user.track_event`). + + + **NB: For the JSON object types, please note that we do not currently + support nested JSON structure.** + + + | Type | + Description + | + Example + | + + | :-------------- | + :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + | + :-------------------------------------------------------------------------------- + | + + | String | The value is a JSON + String + | + `"source":"desktop"` + | + + | Number | The value is a JSON + Number + | `"load": + 3.67` + | + + | Date | The key ends with the String `_date` and the value + is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed + to be in the + [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. + | `"contact_date": + 1392036272` | + + | Link | The value is a HTTP or HTTPS + URI. + | `"article": + "https://example.org/ab1de.html"` | + + | Rich Link | The value is a JSON object that contains `url` and + `value` + keys. + | `"article": {"url": "https://example.org/ab1de.html", "value":"the + dude abides"}` | + + | Monetary Amount | The value is a JSON object that contains `amount` + and `currency` keys. The `amount` key is a positive integer representing + the amount in cents. The price in the example to the right denotes + €349.99. | `"price": {"amount": 34999, "currency": + "eur"}` | + + + **Lead Events** + + + When submitting events for Leads, you will need to specify the Lead's + `id`. + + + **Metadata behaviour** + + + - We currently limit the number of tracked metadata keys to 10 per + event. Once the quota is reached, we ignore any further keys we receive. + The first 10 metadata keys are determined by the order in which they are + sent in with the event. + + - It is not possible to change the metadata keys once the event has been + sent. A new event will need to be created with the new keys and you can + archive the old one. + + - There might be up to 24 hrs delay when you send a new metadata for an + existing event. + + + **Event de-duplication** + + + The API may detect and ignore duplicate events. Each event is uniquely + identified as a combination of the following data - the Workspace + identifier, the Contact external identifier, the Data Event name and the + Data Event created time. As a result, it is **strongly recommended** to + send a second granularity Unix timestamp in the `created_at` field. + + + Duplicated events are responded to using the normal `202 Accepted` code + - an error is not thrown, however repeat requests will be counted + against any rate limit that is in place. + + + ### HTTP API Responses + + + - Successful responses to submitted events return `202 Accepted` with an + empty body. + + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 + Forbidden` response code. + + - Events sent about users that cannot be found will return a `404 Not + Found`. + + - Event lists containing duplicate events will have those duplicates + ignored. + + - Server errors will return a `500` response code and may contain an + error message in the body. + + source: + openapi: ../openapi.yml + display-name: Submit a data event + request: + body: root.CreateDataEventRequestTwo + content-type: application/json + errors: + - root.CreateDataEventRequestUnauthorizedError + dataEventSummaries: + path: /events/summaries + method: POST + auth: true + docs: >+ + Create event summaries for a user. Event summaries are used to track the + number of times an event has occurred, the first time it occurred and + the last time it occurred. + + source: + openapi: ../openapi.yml + display-name: Create event summaries + request: + name: CreateDataEventSummariesRequest + body: + properties: + user_id: + type: optional + docs: Your identifier for the user. + event_summaries: + type: optional + docs: >- + A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and + the number of times the event occurred. The event name should be + a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + content-type: application/json + errors: + - root.DataEventSummariesRequestUnauthorizedError + examples: + - request: {} + source: + openapi: ../openapi.yml + display-name: Data Events +docs: Everything about your Data Events +", + }, + "dataExport.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Exports", + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Export", + "endpoints": { + "cancelDataExport": { + "auth": true, + "display-name": "Cancel content data export", + "docs": "You can cancel your job", + "examples": [ + { + "name": "successful", + "path-parameters": { + "job_identifier": "job_identifier", + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "canceled", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/export/cancel/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createDataExport": { + "auth": true, + "display-name": "Create content data export", + "docs": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`. + +The only parameters you need to provide are the range of dates that you want exported. + +>🚧 Limit of one active job +> +> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job. + +>❗️ Updated_at not included +> +> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job. + +>📘 Date ranges are inclusive +> +> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99. +", + "examples": [ + { + "name": "successful", + "request": { + "created_at_after": 1719474967, + "created_at_before": 1719492967, + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "pending", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/export/content/data", + "request": { + "body": { + "properties": { + "created_at_after": { + "docs": "The start date that you request data for. It must be formatted as a unix timestamp.", + "type": "integer", + }, + "created_at_before": { + "docs": "The end date that you request data for. It must be formatted as a unix timestamp.", + "type": "integer", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataExportsRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "downloadDataExport": { + "auth": true, + "display-name": "Download content data export", + "docs": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + +Your exported message data will be streamed continuously back down to you in a gzipped CSV format. + +> 📘 Octet header required +> +> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. +", + "examples": [ + { + "path-parameters": { + "job_identifier": "job_identifier", + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/download/content/data/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getDataExport": { + "auth": true, + "display-name": "Show content data export", + "docs": "You can view the status of your job by sending a `GET` request to the URL +`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + +> 🚧 Jobs expire after two days +> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available. +", + "examples": [ + { + "name": "successful", + "path-parameters": { + "job_identifier": "job_identifier", + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "pending", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/export/content/data/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "DataExport": { + "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "properties": { + "download_expires_at": { + "docs": "The time after which you will not be able to access the data.", + "type": "optional", + }, + "download_url": { + "docs": "The location where you can download your data.", + "type": "optional", + }, + "job_identfier": { + "docs": "The identifier for your job.", + "type": "optional", + }, + "status": { + "docs": "The current state of your job.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataExportStatus": { + "docs": "The current state of your job.", + "enum": [ + "pending", + "in_progress", + "failed", + "completed", + "no_data", + "canceled", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "service: + auth: false + base-path: '' + endpoints: + createDataExport: + path: /export/content/data + method: POST + auth: true + docs: > + To create your export job, you need to send a `POST` request to the + export endpoint `https://api.intercom.io/export/content/data`. + + + The only parameters you need to provide are the range of dates that you + want exported. + + + >🚧 Limit of one active job + + > + + > You can only have one active job per workspace. You will receive a + HTTP status code of 429 with the message Exceeded rate limit of 1 + pending message data export jobs if you attempt to create a second + concurrent job. + + + >❗️ Updated_at not included + + > + + > It should be noted that the timeframe only includes messages sent + during the time period and not messages that were only updated during + this period. For example, if a message was updated yesterday but sent + two days ago, you would need to set the created_at_after date before the + message was sent to include that in your retrieval job. + + + >📘 Date ranges are inclusive + + > + + > Requesting data for 2018-06-01 until 2018-06-30 will get all data for + those days including those specified - e.g. 2018-06-01 00:00:00 until + 2018-06-30 23:59:99. + source: + openapi: ../openapi.yml + display-name: Create content data export + request: + name: CreateDataExportsRequest + body: + properties: + created_at_after: + type: integer + docs: >- + The start date that you request data for. It must be formatted + as a unix timestamp. + created_at_before: + type: integer + docs: >- + The end date that you request data for. It must be formatted as + a unix timestamp. + content-type: application/json + response: + docs: successful + type: DataExport + examples: + - name: successful + request: + created_at_after: 1719474967 + created_at_before: 1719492967 + response: + body: + job_identfier: orzzsbd7hk67xyu + status: pending + download_expires_at: '' + download_url: '' + getDataExport: + path: /export/content/data/{job_identifier} + method: GET + auth: true + docs: > + You can view the status of your job by sending a `GET` request to the + URL + + `https://api.intercom.io/export/content/data/{job_identifier}` - the + `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model. + + + > 🚧 Jobs expire after two days + + > All jobs that have completed processing (and are thus available to + download from the provided URL) will have an expiry limit of two days + from when the export ob completed. After this, the data will no longer + be available. + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Show content data export + response: + docs: successful + type: DataExport + examples: + - name: successful + path-parameters: + job_identifier: job_identifier + response: + body: + job_identfier: orzzsbd7hk67xyu + status: pending + download_expires_at: '' + download_url: '' + cancelDataExport: + path: /export/cancel/{job_identifier} + method: POST + auth: true + docs: You can cancel your job + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Cancel content data export + response: + docs: successful + type: DataExport + examples: + - name: successful + path-parameters: + job_identifier: job_identifier + response: + body: + job_identfier: orzzsbd7hk67xyu + status: canceled + download_expires_at: '' + download_url: '' + downloadDataExport: + path: /download/content/data/{job_identifier} + method: GET + auth: true + docs: > + When a job has a status of complete, and thus a filled download_url, you + can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234. + + + Your exported message data will be streamed continuously back down to + you in a gzipped CSV format. + + + > 📘 Octet header required + + > + + > You will have to specify the header Accept: `application/octet-stream` + when hitting this endpoint. + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Download content data export + examples: + - path-parameters: + job_identifier: job_identifier + source: + openapi: ../openapi.yml + display-name: Data Export +docs: Everything about your Data Exports +types: + DataExportStatus: + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + docs: The current state of your job. + source: + openapi: ../openapi.yml + DataExport: + docs: >- + The data export api is used to view all message sent & viewed in a given + timeframe. + properties: + job_identfier: + type: optional + docs: The identifier for your job. + status: + type: optional + docs: The current state of your job. + download_expires_at: + type: optional + docs: The time after which you will not be able to access the data. + download_url: + type: optional + docs: The location where you can download your data. + source: + openapi: ../openapi.yml +", + }, + "helpCenter.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Help Center", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Help Center", + "endpoints": { + "createCollection": { + "auth": true, + "display-name": "Create a collection", + "docs": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "errors": [ + "root.CreateCollectionRequestBadRequestError", + "root.CreateCollectionRequestUnauthorizedError", + ], + "examples": [ + { + "name": "collection created", + "request": { + "name": "Thanks for everything", + }, + "response": { + "body": { + "created_at": 1719492721, + "default_locale": "en", + "description": "", + "help_center_id": 81, + "icon": "book-bookmark", + "id": "165", + "name": "Thanks for everything", + "order": 1, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492721, + "url": "http://help-center.test/myapp-69/", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Bad Request", + "request": { + "description": "Missing required parameter", + "name": "collection 51", + }, + "response": { + "body": { + "created_at": 1719492721, + "default_locale": "en", + "description": "", + "help_center_id": 81, + "icon": "book-bookmark", + "id": "165", + "name": "Thanks for everything", + "order": 1, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492721, + "url": "http://help-center.test/myapp-69/", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/help_center/collections", + "request": { + "body": { + "properties": { + "description": { + "docs": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "type": "optional", + }, + "help_center_id": { + "docs": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "string", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it will be created as the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateCollectionRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "collection created", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteCollection": { + "auth": true, + "display-name": "Delete a collection", + "docs": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "errors": [ + "root.DeleteCollectionRequestUnauthorizedError", + "root.DeleteCollectionRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "182", + "object": "collection", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedCollectionObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAllCollections": { + "auth": true, + "display-name": "List all collections", + "docs": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + +Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. +", + "errors": [ + "root.ListAllCollectionsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492720, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 79, + "icon": "bookmark", + "id": "159", + "name": "English collection title", + "order": 17, + "parent_id": "6871118", + "updated_at": 1719492720, + "url": "http://help-center.test/myapp-65/collection-17", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + }, + { + "created_at": 1719492720, + "default_locale": "en", + "description": "Default language description", + "help_center_id": 1, + "icon": "bookmark", + "id": "160", + "name": "English section title", + "order": 1, + "parent_id": "159", + "updated_at": 1719492720, + "url": "http://help-center.test/myapp-65/section-1", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/collections", + "response": { + "docs": "Successful", + "type": "root.Collections", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listHelpCenters": { + "auth": true, + "display-name": "List all Help Centers", + "docs": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "errors": [ + "root.ListHelpCentersRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Help Centers found", + "response": { + "body": { + "data": [ + { + "created_at": 1672928359, + "display_name": "Intercom Help Center", + "id": "123", + "identifier": "intercom", + "updated_at": 1672928610, + "website_turned_on": true, + "workspace_id": "hfi1bx4l", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/help_centers", + "response": { + "docs": "Help Centers found", + "type": "HelpCenterList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveCollection": { + "auth": true, + "display-name": "Retrieve a collection", + "docs": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "errors": [ + "root.RetrieveCollectionRequestUnauthorizedError", + "root.RetrieveCollectionRequestNotFoundError", + ], + "examples": [ + { + "name": "Collection found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "created_at": 1719492723, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 84, + "icon": "bookmark", + "id": "170", + "name": "English collection title", + "order": 22, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492723, + "url": "http://help-center.test/myapp-75/collection-22", + "workspace_id": "this_is_an_id75_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Collection found", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveHelpCenter": { + "auth": true, + "display-name": "Retrieve a Help Center", + "docs": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "errors": [ + "root.RetrieveHelpCenterRequestUnauthorizedError", + "root.RetrieveHelpCenterRequestNotFoundError", + ], + "examples": [ + { + "name": "Collection found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "created_at": 1719492727, + "display_name": "Intercom Help Center", + "id": "93", + "identifier": "help-center-1", + "updated_at": 1719492727, + "website_turned_on": false, + "workspace_id": "this_is_an_id93_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/help_centers/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Collection found", + "type": "HelpCenter", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateCollection": { + "auth": true, + "display-name": "Update a collection", + "docs": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "errors": [ + "root.UpdateCollectionRequestUnauthorizedError", + "root.UpdateCollectionRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "name": "Update collection name", + }, + "response": { + "body": { + "created_at": 1719492724, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 87, + "icon": "folder", + "id": "176", + "name": "Update collection name", + "order": 25, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492724, + "url": "http://help-center.test/myapp-81/collection-25", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Collection Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "name": "Update collection name", + }, + "response": { + "body": { + "created_at": 1719492724, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 87, + "icon": "folder", + "id": "176", + "name": "Update collection name", + "order": 25, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492724, + "url": "http://help-center.test/myapp-81/collection-25", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "description": { + "docs": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it will be updated as the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateCollectionRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Collection": { + "docs": "Collections are top level containers for Articles within the Help Center.", + "properties": { + "created_at": { + "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", + "type": "optional", + }, + "default_locale": { + "docs": "The default locale of the help center. This field is only returned for multilingual help centers.", + "type": "optional", + }, + "description": { + "docs": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.", + "type": "optional", + }, + "help_center_id": { + "docs": "The id of the help center the collection is in.", + "type": "optional", + }, + "icon": { + "docs": "The icon of the collection.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "optional", + }, + "order": { + "docs": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it is the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + "updated_at": { + "docs": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.", + "type": "optional", + }, + "url": { + "docs": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the collection belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "HelpCenter": { + "docs": "Help Centers contain collections", + "properties": { + "created_at": { + "docs": "The time when the Help Center was created.", + "type": "optional", + }, + "display_name": { + "docs": "The display name of the Help Center only seen by teammates.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the Help Center which is given by Intercom.", + "type": "optional", + }, + "identifier": { + "docs": "The identifier of the Help Center. This is used in the URL of the Help Center.", + "type": "optional", + }, + "updated_at": { + "docs": "The time when the Help Center was last updated.", + "type": "optional", + }, + "website_turned_on": { + "docs": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the Help Center belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "HelpCenterList": { + "docs": "A list of Help Centers belonging to the App", + "properties": { + "data": { + "docs": "An array of Help Center objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listAllCollections: + path: /help_center/collections + method: GET + auth: true + docs: > + You can fetch a list of all collections by making a GET request to + `https://api.intercom.io/help_center/collections`. + + + Collections will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll + show the most recently updated collections first. + source: + openapi: ../openapi.yml + display-name: List all collections + response: + docs: Successful + type: root.Collections + errors: + - root.ListAllCollectionsRequestUnauthorizedError + examples: + - name: Successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + total_count: 2 + data: + - id: '159' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English collection title + description: english collection description + created_at: 1719492720 + updated_at: 1719492720 + url: http://help-center.test/myapp-65/collection-17 + icon: bookmark + order: 17 + default_locale: en + parent_id: '6871118' + help_center_id: 79 + - id: '160' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English section title + description: Default language description + created_at: 1719492720 + updated_at: 1719492720 + url: http://help-center.test/myapp-65/section-1 + icon: bookmark + order: 1 + default_locale: en + parent_id: '159' + help_center_id: 1 + createCollection: + path: /help_center/collections + method: POST + auth: true + docs: >- + You can create a new collection by making a POST request to + `https://api.intercom.io/help_center/collections.` + source: + openapi: ../openapi.yml + display-name: Create a collection + request: + name: CreateCollectionRequest + body: + properties: + name: + type: string + docs: >- + The name of the collection. For multilingual collections, this + will be the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual collections, + this will be the description of the default language's content. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it will be + created as the first level collection. + help_center_id: + type: optional + docs: >- + The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + content-type: application/json + response: + docs: collection created + type: Collection + errors: + - root.CreateCollectionRequestBadRequestError + - root.CreateCollectionRequestUnauthorizedError + examples: + - name: collection created + request: + name: Thanks for everything + response: + body: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + description: '' + created_at: 1719492721 + updated_at: 1719492721 + url: http://help-center.test/myapp-69/ + icon: book-bookmark + order: 1 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 81 + - name: Bad Request + request: + name: collection 51 + description: Missing required parameter + response: + body: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + description: '' + created_at: 1719492721 + updated_at: 1719492721 + url: http://help-center.test/myapp-69/ + icon: book-bookmark + order: 1 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 81 + retrieveCollection: + path: /help_center/collections/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single collection by making a GET request + to `https://api.intercom.io/help_center/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Retrieve a collection + response: + docs: Collection found + type: Collection + errors: + - root.RetrieveCollectionRequestUnauthorizedError + - root.RetrieveCollectionRequestNotFoundError + examples: + - name: Collection found + path-parameters: + id: 1 + response: + body: + id: '170' + workspace_id: this_is_an_id75_that_should_be_at_least_4 + name: English collection title + description: english collection description + created_at: 1719492723 + updated_at: 1719492723 + url: http://help-center.test/myapp-75/collection-22 + icon: bookmark + order: 22 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 84 + updateCollection: + path: /help_center/collections/{id} + method: PUT + auth: true + docs: >- + You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Update a collection + request: + name: UpdateCollectionRequest + body: + properties: + name: + type: optional + docs: >- + The name of the collection. For multilingual collections, this + will be the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual collections, + this will be the description of the default language's content. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it will be + updated as the first level collection. + content-type: application/json + response: + docs: successful + type: Collection + errors: + - root.UpdateCollectionRequestUnauthorizedError + - root.UpdateCollectionRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + name: Update collection name + response: + body: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + description: english collection description + created_at: 1719492724 + updated_at: 1719492724 + url: http://help-center.test/myapp-81/collection-25 + icon: folder + order: 25 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 87 + - name: Collection Not Found + path-parameters: + id: 1 + request: + name: Update collection name + response: + body: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + description: english collection description + created_at: 1719492724 + updated_at: 1719492724 + url: http://help-center.test/myapp-81/collection-25 + icon: folder + order: 25 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 87 + deleteCollection: + path: /help_center/collections/{id} + method: DELETE + auth: true + docs: >- + You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Delete a collection + response: + docs: successful + type: root.DeletedCollectionObject + errors: + - root.DeleteCollectionRequestUnauthorizedError + - root.DeleteCollectionRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '182' + object: collection + deleted: true + retrieveHelpCenter: + path: /help_center/help_centers/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Retrieve a Help Center + response: + docs: Collection found + type: HelpCenter + errors: + - root.RetrieveHelpCenterRequestUnauthorizedError + - root.RetrieveHelpCenterRequestNotFoundError + examples: + - name: Collection found + path-parameters: + id: 1 + response: + body: + id: '93' + workspace_id: this_is_an_id93_that_should_be_at_least_4 + created_at: 1719492727 + updated_at: 1719492727 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + listHelpCenters: + path: /help_center/help_centers + method: GET + auth: true + docs: >- + You can list all Help Centers by making a GET request to + `https://api.intercom.io/help_center/help_centers`. + source: + openapi: ../openapi.yml + display-name: List all Help Centers + response: + docs: Help Centers found + type: HelpCenterList + errors: + - root.ListHelpCentersRequestUnauthorizedError + examples: + - name: Help Centers found + response: + body: + type: list + data: + - id: '123' + workspace_id: hfi1bx4l + created_at: 1672928359 + updated_at: 1672928610 + identifier: intercom + website_turned_on: true + display_name: Intercom Help Center + source: + openapi: ../openapi.yml + display-name: Help Center +docs: Everything about your Help Center +types: + Collection: + docs: Collections are top level containers for Articles within the Help Center. + properties: + id: + type: optional + docs: The unique identifier for the collection which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the collection belongs to. + name: + type: optional + docs: >- + The name of the collection. For multilingual collections, this will be + the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual help centers, this + will be the description of the collection for the default language. + created_at: + type: optional + docs: >- + The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default + language's content. + updated_at: + type: optional + docs: >- + The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default + language's content. + url: + type: optional + docs: >- + The URL of the collection. For multilingual help centers, this will be + the URL of the collection for the default language. + icon: + type: optional + docs: The icon of the collection. + order: + type: optional + docs: >- + The order of the section in relation to others sections within a + collection. Values go from `0` upwards. `0` is the default if there's + no order. + default_locale: + type: optional + docs: >- + The default locale of the help center. This field is only returned for + multilingual help centers. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it is the first level + collection. + help_center_id: + type: optional + docs: The id of the help center the collection is in. + source: + openapi: ../openapi.yml + HelpCenter: + docs: Help Centers contain collections + properties: + id: + type: optional + docs: The unique identifier for the Help Center which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the Help Center belongs to. + created_at: + type: optional + docs: The time when the Help Center was created. + updated_at: + type: optional + docs: The time when the Help Center was last updated. + identifier: + type: optional + docs: >- + The identifier of the Help Center. This is used in the URL of the Help + Center. + website_turned_on: + type: optional + docs: >- + Whether the Help Center is turned on or not. This is controlled in + your Help Center settings. + display_name: + type: optional + docs: The display name of the Help Center only seen by teammates. + source: + openapi: ../openapi.yml + HelpCenterList: + docs: A list of Help Centers belonging to the App + properties: + type: + type: optional> + docs: The type of the object - `list`. + data: + type: optional> + docs: An array of Help Center objects + source: + openapi: ../openapi.yml +", + }, + "messages.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your messages", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Messages", + "endpoints": { + "createMessage": { + "auth": true, + "display-name": "Create a message", + "docs": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + +> 🚧 Sending for visitors +> +> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case. + +This will return the Message model that has been created. + +> 🚧 Retrieving Associated Conversations +> +> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message. +", + "errors": [ + "root.CreateMessageRequestBadRequestError", + "root.CreateMessageRequestUnauthorizedError", + "root.CreateMessageRequestForbiddenError", + "root.CreateMessageRequestUnprocessableEntityError", + ], + "examples": [ + { + "name": "user message created", + "request": { + "body": "heyy", + "from": { + "id": "667d61698a68186f43bafe50", + "type": "user", + }, + "referer": "https://twitter.com/bob", + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "lead message created", + "request": { + "body": "heyy", + "from": { + "id": "667d616a8a68186f43bafe51", + "type": "lead", + }, + "referer": "https://twitter.com/bob", + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "477", + "created_at": 1719492971, + "id": "403918317", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "admin message created", + "request": { + "body": "heyy", + "from": { + "id": "991267716", + "type": "admin", + }, + "message_type": "conversation", + "to": { + "id": "667d616c8a68186f43bafe52", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "64619700005570", + "created_at": 1719492972, + "id": "15", + "message_type": "inapp", + "subject": "heyy", + "type": "admin_message", + }, + }, + }, + { + "name": "No body supplied for message", + "request": { + "from": { + "id": "991267718", + "type": "admin", + }, + "message_type": "inapp", + "subject": "heyy", + "to": { + "id": "667d616d8a68186f43bafe53", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "No subject supplied for email message", + "request": { + "body": "hey there", + "from": { + "id": "991267719", + "type": "admin", + }, + "message_type": "email", + "to": { + "type": "user", + "user_id": "70", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "No body supplied for email message", + "request": { + "from": { + "id": "991267720", + "type": "admin", + }, + "message_type": "email", + "subject": "heyy", + "to": { + "id": "667d616e8a68186f43bafe55", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/messages", + "request": { + "body": "root.CreateMessageRequestOne", + "content-type": "application/json", + }, + "response": { + "docs": "admin message created", + "type": "Message", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Message": { + "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "properties": { + "body": { + "docs": "The message body, which may contain HTML.", + "type": "string", + }, + "conversation_id": { + "docs": "The associated conversation_id", + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation was created.", + "type": "integer", + }, + "id": { + "docs": "The id representing the message.", + "type": "string", + }, + "message_type": { + "docs": "The type of message that was sent. Can be email, inapp, facebook or twitter.", + "type": "MessageMessageType", + }, + "subject": { + "docs": "The subject of the message. Only present if message_type: email.", + "type": "optional", + }, + "type": { + "docs": "The type of the message", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MessageMessageType": { + "docs": "The type of message that was sent. Can be email, inapp, facebook or twitter.", + "enum": [ + "email", + "inapp", + "facebook", + "twitter", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createMessage: + path: /messages + method: POST + auth: true + docs: > + You can create a message that has been initiated by an admin. The + conversation can be either an in-app message or an email. + + + > 🚧 Sending for visitors + + > + + > There can be a short delay between when a contact is created and when + a contact becomes available to be messaged through the API. A 404 Not + Found error will be returned in this case. + + + This will return the Message model that has been created. + + + > 🚧 Retrieving Associated Conversations + + > + + > As this is a message, there will be no conversation present until the + contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message. + source: + openapi: ../openapi.yml + display-name: Create a message + request: + body: root.CreateMessageRequestOne + content-type: application/json + response: + docs: admin message created + type: Message + errors: + - root.CreateMessageRequestBadRequestError + - root.CreateMessageRequestUnauthorizedError + - root.CreateMessageRequestForbiddenError + - root.CreateMessageRequestUnprocessableEntityError + examples: + - name: user message created + request: + from: + type: user + id: 667d61698a68186f43bafe50 + body: heyy + referer: https://twitter.com/bob + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: lead message created + request: + from: + type: lead + id: 667d616a8a68186f43bafe51 + body: heyy + referer: https://twitter.com/bob + response: + body: + type: user_message + id: '403918317' + created_at: 1719492971 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '477' + - name: admin message created + request: + from: + type: admin + id: '991267716' + to: + type: user + id: 667d616c8a68186f43bafe52 + message_type: conversation + body: heyy + response: + body: + type: admin_message + id: '15' + created_at: 1719492972 + subject: heyy + body: heyy + message_type: inapp + conversation_id: '64619700005570' + - name: No body supplied for message + request: + from: + type: admin + id: '991267718' + to: + type: user + id: 667d616d8a68186f43bafe53 + message_type: inapp + subject: heyy + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: No subject supplied for email message + request: + from: + type: admin + id: '991267719' + to: + type: user + user_id: '70' + message_type: email + body: hey there + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: No body supplied for email message + request: + from: + type: admin + id: '991267720' + to: + type: user + id: 667d616e8a68186f43bafe55 + message_type: email + subject: heyy + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + source: + openapi: ../openapi.yml + display-name: Messages +docs: Everything about your messages +types: + MessageMessageType: + enum: + - email + - inapp + - facebook + - twitter + docs: >- + The type of message that was sent. Can be email, inapp, facebook or + twitter. + source: + openapi: ../openapi.yml + Message: + docs: >- + Message are how you reach out to contacts in Intercom. They are created + when an admin sends an outbound message to a contact. + properties: + type: + type: string + docs: The type of the message + id: + type: string + docs: The id representing the message. + created_at: + type: integer + docs: The time the conversation was created. + subject: + type: optional + docs: 'The subject of the message. Only present if message_type: email.' + body: + type: string + docs: The message body, which may contain HTML. + message_type: + type: MessageMessageType + docs: >- + The type of message that was sent. Can be email, inapp, facebook or + twitter. + conversation_id: + type: optional + docs: The associated conversation_id + source: + openapi: ../openapi.yml +", + }, + "news.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your News", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "News", + "endpoints": { + "createNewsItem": { + "auth": true, + "display-name": "Create a news item", + "docs": "You can create a news item", + "errors": [ + "root.CreateNewsItemRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "body": "

New costumes in store for this spooky season

", + "deliver_silently": true, + "labels": [ + "Product", + "Update", + "New", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214, + }, + ], + "reactions": [ + "😆", + "😅", + ], + "sender_id": 991267734, + "state": "live", + "title": "Halloween is here!", + }, + "response": { + "body": { + "body": "

New costumes in store for this spooky season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492978, + "deliver_silently": true, + "id": "33", + "labels": [ + "New", + "Product", + "Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214, + }, + ], + "reactions": [ + "😆", + "😅", + ], + "sender_id": 991267734, + "state": "live", + "title": "Halloween is here!", + "updated_at": 1719492978, + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/news/news_items", + "request": { + "body": { + "type": "root.NewsItemRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteNewsItem": { + "auth": true, + "display-name": "Delete a news item", + "docs": "You can delete a single news item.", + "errors": [ + "root.DeleteNewsItemRequestUnauthorizedError", + "root.DeleteNewsItemRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "40", + "object": "news-item", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listLiveNewsfeedItems": { + "auth": true, + "display-name": "List all live newsfeed items", + "docs": "You can fetch a list of all news items that are live on a given newsfeed", + "errors": [ + "root.ListLiveNewsfeedItemsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "data": [ + { + "created_at": 1674917488, + "id": "12312", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1674917488, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds/{id}/items", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news feed item which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNewsItems": { + "auth": true, + "display-name": "List all news items", + "docs": "You can fetch a list of all news items", + "errors": [ + "root.ListNewsItemsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492976, + "id": "29", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1719492976, + }, + { + "created_at": 1719492976, + "id": "30", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1719492976, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/news_items", + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNewsfeeds": { + "auth": true, + "display-name": "List all newsfeeds", + "docs": "You can fetch a list of all newsfeeds", + "errors": [ + "root.ListNewsfeedsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492987, + "id": "68", + "name": "Visitor Feed", + "type": "newsfeed", + "updated_at": 1719492987, + }, + { + "created_at": 1719492987, + "id": "69", + "name": "Visitor Feed", + "type": "newsfeed", + "updated_at": 1719492987, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds", + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNewsItem": { + "auth": true, + "display-name": "Retrieve a news item", + "docs": "You can fetch the details of a single news item.", + "errors": [ + "root.RetrieveNewsItemRequestUnauthorizedError", + "root.RetrieveNewsItemRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "body": "

Hello there,

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492979, + "deliver_silently": false, + "id": "34", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 55, + "published_at": 1719492980, + }, + ], + "reactions": [ + "👍", + "👍", + "👍", + "👍", + ], + "sender_id": 991267737, + "state": "live", + "title": "We have news", + "updated_at": 1719492979, + "workspace_id": "this_is_an_id502_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNewsfeed": { + "auth": true, + "display-name": "Retrieve a newsfeed", + "docs": "You can fetch the details of a single newsfeed", + "errors": [ + "root.RetrieveNewsfeedRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "created_at": 1719492988, + "id": "72", + "name": "Visitor Feed", + "updated_at": 1719492988, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news feed item which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Newsfeed", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateNewsItem": { + "auth": true, + "display-name": "Update a news item", + "docs": undefined, + "errors": [ + "root.UpdateNewsItemRequestUnauthorizedError", + "root.UpdateNewsItemRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "title": "Christmas is here!", + }, + "response": { + "body": { + "body": "

New gifts in store for the jolly season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492982, + "deliver_silently": false, + "id": "37", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 198313, + "published_at": 1674917488, + }, + ], + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "state": "live", + "title": "Christmas is here!", + "updated_at": 1719492982, + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + }, + }, + }, + { + "name": "News Item Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267748, + "title": "Christmas is here!", + }, + "response": { + "body": { + "body": "

New gifts in store for the jolly season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492982, + "deliver_silently": false, + "id": "37", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 198313, + "published_at": 1674917488, + }, + ], + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "state": "live", + "title": "Christmas is here!", + "updated_at": 1719492982, + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "type": "root.NewsItemRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "NewsItem": { + "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "properties": { + "body": { + "docs": "The news item body, which may contain HTML.", + "type": "optional", + }, + "cover_image_url": { + "docs": "URL of the image used as cover. Must have .jpg or .png extension.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "created_at": { + "docs": "Timestamp for when the news item was created.", + "type": "optional", + }, + "deliver_silently": { + "docs": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "optional", + }, + "labels": { + "docs": "Label names displayed to users to categorize the news item.", + "type": "optional>>", + }, + "newsfeed_assignments": { + "docs": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "type": "optional>", + }, + "reactions": { + "docs": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "type": "optional>>", + }, + "sender_id": { + "docs": "The id of the sender of the news item. Must be a teammate on the workspace.", + "type": "optional", + }, + "state": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "type": "optional", + }, + "title": { + "docs": "The title of the news item.", + "type": "optional", + }, + "updated_at": { + "docs": "Timestamp for when the news item was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the news item belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsItemState": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "enum": [ + "draft", + "live", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "Newsfeed": { + "docs": "A newsfeed is a collection of news items, targeted to a specific audience. + +Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. +", + "properties": { + "created_at": { + "docs": "Timestamp for when the newsfeed was created.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the newsfeed which is given by Intercom.", + "type": "optional", + }, + "name": { + "docs": "The name of the newsfeed. This name will never be visible to your users.", + "type": "optional", + }, + "updated_at": { + "docs": "Timestamp for when the newsfeed was last updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsfeedAssignment": { + "docs": "Assigns a news item to a newsfeed.", + "properties": { + "newsfeed_id": { + "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", + "type": "optional", + }, + "published_at": { + "docs": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listNewsItems: + path: /news/news_items + method: GET + auth: true + docs: You can fetch a list of all news items + source: + openapi: ../openapi.yml + display-name: List all news items + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.ListNewsItemsRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + total_count: 2 + data: + - type: newsfeed + id: '29' + name: My Newsfeed + created_at: 1719492976 + updated_at: 1719492976 + - type: newsfeed + id: '30' + name: My Newsfeed + created_at: 1719492976 + updated_at: 1719492976 + createNewsItem: + path: /news/news_items + method: POST + auth: true + docs: You can create a news item + source: + openapi: ../openapi.yml + display-name: Create a news item + request: + body: + type: root.NewsItemRequest + content-type: application/json + response: + docs: successful + type: NewsItem + errors: + - root.CreateNewsItemRequestUnauthorizedError + examples: + - name: successful + request: + title: Halloween is here! + body:

New costumes in store for this spooky season

+ sender_id: 991267734 + state: live + deliver_silently: true + labels: + - Product + - Update + - New + reactions: + - 😆 + - 😅 + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + response: + body: + id: '33' + workspace_id: this_is_an_id498_that_should_be_at_least_ + title: Halloween is here! + body:

New costumes in store for this spooky season

+ sender_id: 991267734 + state: live + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + labels: + - New + - Product + - Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😆 + - 😅 + deliver_silently: true + created_at: 1719492978 + updated_at: 1719492978 + retrieveNewsItem: + path: /news/news_items/{id} + method: GET + auth: true + docs: You can fetch the details of a single news item. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Retrieve a news item + response: + docs: successful + type: NewsItem + errors: + - root.RetrieveNewsItemRequestUnauthorizedError + - root.RetrieveNewsItemRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '34' + workspace_id: this_is_an_id502_that_should_be_at_least_ + title: We have news + body:

Hello there,

+ sender_id: 991267737 + state: live + newsfeed_assignments: + - newsfeed_id: 55 + published_at: 1719492980 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 👍 + - 👍 + - 👍 + - 👍 + deliver_silently: false + created_at: 1719492979 + updated_at: 1719492979 + updateNewsItem: + path: /news/news_items/{id} + method: PUT + auth: true + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Update a news item + request: + body: + type: root.NewsItemRequest + content-type: application/json + response: + docs: successful + type: NewsItem + errors: + - root.UpdateNewsItemRequestUnauthorizedError + - root.UpdateNewsItemRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + reactions: + - 😝 + - 😂 + response: + body: + id: '37' + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + state: live + newsfeed_assignments: + - newsfeed_id: 198313 + published_at: 1674917488 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😝 + - 😂 + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + - name: News Item Not Found + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267748 + reactions: + - 😝 + - 😂 + response: + body: + id: '37' + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + state: live + newsfeed_assignments: + - newsfeed_id: 198313 + published_at: 1674917488 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😝 + - 😂 + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + deleteNewsItem: + path: /news/news_items/{id} + method: DELETE + auth: true + docs: You can delete a single news item. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Delete a news item + response: + docs: successful + type: root.DeletedObject + errors: + - root.DeleteNewsItemRequestUnauthorizedError + - root.DeleteNewsItemRequestNotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '40' + object: news-item + deleted: true + listLiveNewsfeedItems: + path: /news/newsfeeds/{id}/items + method: GET + auth: true + docs: You can fetch a list of all news items that are live on a given newsfeed + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the news feed item which is given by + Intercom. + display-name: List all live newsfeed items + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.ListLiveNewsfeedItemsRequestUnauthorizedError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 0 + total_count: 0 + data: + - type: newsfeed + id: '12312' + name: My Newsfeed + created_at: 1674917488 + updated_at: 1674917488 + listNewsfeeds: + path: /news/newsfeeds + method: GET + auth: true + docs: You can fetch a list of all newsfeeds + source: + openapi: ../openapi.yml + display-name: List all newsfeeds + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.ListNewsfeedsRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + total_count: 2 + data: + - type: newsfeed + id: '68' + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + - type: newsfeed + id: '69' + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + retrieveNewsfeed: + path: /news/newsfeeds/{id} + method: GET + auth: true + docs: You can fetch the details of a single newsfeed + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the news feed item which is given by + Intercom. + display-name: Retrieve a newsfeed + response: + docs: successful + type: Newsfeed + errors: + - root.RetrieveNewsfeedRequestUnauthorizedError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + id: '72' + name: Visitor Feed + created_at: 1719492988 + updated_at: 1719492988 + source: + openapi: ../openapi.yml + display-name: News +docs: Everything about your News +types: + NewsItemState: + enum: + - draft + - live + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + source: + openapi: ../openapi.yml + NewsItem: + docs: >- + A News Item is a content type in Intercom enabling you to announce product + updates, company news, promotions, events and more with your customers. + properties: + id: + type: optional + docs: The unique identifier for the news item which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the news item belongs to. + title: + type: optional + docs: The title of the news item. + body: + type: optional + docs: The news item body, which may contain HTML. + sender_id: + type: optional + docs: >- + The id of the sender of the news item. Must be a teammate on the + workspace. + state: + type: optional + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + newsfeed_assignments: + type: optional> + docs: A list of newsfeed_assignments to assign to the specified newsfeed. + labels: + type: optional>> + docs: Label names displayed to users to categorize the news item. + cover_image_url: + type: optional + docs: URL of the image used as cover. Must have .jpg or .png extension. + validation: + format: uri + reactions: + type: optional>> + docs: >- + Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + deliver_silently: + type: optional + docs: >- + When set to true, the news item will appear in the messenger newsfeed + without showing a notification badge. + created_at: + type: optional + docs: Timestamp for when the news item was created. + updated_at: + type: optional + docs: Timestamp for when the news item was last updated. + source: + openapi: ../openapi.yml + Newsfeed: + docs: > + A newsfeed is a collection of news items, targeted to a specific audience. + + + Newsfeeds currently cannot be edited through the API, please refer to + [this + article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) + to set up your newsfeeds in Intercom. + properties: + id: + type: optional + docs: The unique identifier for the newsfeed which is given by Intercom. + name: + type: optional + docs: >- + The name of the newsfeed. This name will never be visible to your + users. + created_at: + type: optional + docs: Timestamp for when the newsfeed was created. + updated_at: + type: optional + docs: Timestamp for when the newsfeed was last updated. + source: + openapi: ../openapi.yml + NewsfeedAssignment: + docs: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: optional + docs: >- + The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + published_at: + type: optional + docs: >- + Publish date of the news item on the newsfeed, use this field if you + want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item + state is "draft". + source: + openapi: ../openapi.yml +", + }, + "notes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Notes", + "imports": { + "admins": "admins.yml", + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Notes", + "endpoints": { + "createNote": { + "auth": true, + "display-name": "Create a note", + "docs": "You can add a note to a single contact.", + "errors": [ + "root.CreateNoteRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "667d60978a68186f43bafd9e", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "667d60988a68186f43bafd9f", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "123", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/notes", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given contact.", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier of a given admin.", + "type": "optional", + }, + "body": { + "docs": "The text of the note.", + "type": "string", + }, + "contact_id": { + "docs": "The unique identifier of a given contact.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateNoteRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "Note", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNotes": { + "auth": true, + "display-name": "List all notes", + "docs": "You can fetch a list of notes that are associated to a contact.", + "errors": [ + "root.ListNotesRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "data": [ + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718887958, + "id": "29", + "type": "note", + }, + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718801558, + "id": "28", + "type": "note", + }, + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718801558, + "id": "27", + "type": "note", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 50, + "total_pages": 1, + "type": "pages", + }, + "total_count": 3, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}/notes", + "path-parameters": { + "id": { + "docs": "The unique identifier of a contact.", + "type": "integer", + }, + }, + "response": { + "docs": "Successful response", + "type": "root.NoteList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNote": { + "auth": true, + "display-name": "Retrieve a note", + "docs": "You can fetch the details of a single note.", + "errors": [ + "root.RetrieveNoteRequestUnauthorizedError", + "root.RetrieveNoteRequestNotFoundError", + ], + "examples": [ + { + "name": "Note found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin316@email.com", + "has_inbox_seat": true, + "id": "991267764", + "job_title": "Philosopher", + "name": "Ciaran316 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d617d8a68186f43bafe58", + "type": "contact", + }, + "created_at": 1718801789, + "id": "37", + "type": "note", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/notes/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given note", + "type": "integer", + }, + }, + "response": { + "docs": "Note found", + "type": "Note", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Note": { + "docs": "Notes allow you to annotate and comment on your contacts.", + "properties": { + "author": { + "docs": "Optional. Represents the Admin that created the note.", + "type": "optional", + }, + "body": { + "docs": "The body text of the note.", + "type": "optional", + }, + "contact": { + "docs": "Represents the contact that the note was created about.", + "type": "optional", + }, + "created_at": { + "docs": "The time the note was created.", + "type": "optional", + }, + "id": { + "docs": "The id of the note.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `note`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NoteContact": { + "docs": "Represents the contact that the note was created about.", + "properties": { + "id": { + "docs": "The id of the contact.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `contact`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + admins: admins.yml +service: + auth: false + base-path: '' + endpoints: + listNotes: + path: /contacts/{id}/notes + method: GET + auth: true + docs: You can fetch a list of notes that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a contact. + display-name: List all notes + response: + docs: Successful response + type: root.NoteList + errors: + - root.ListNotesRequestNotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + response: + body: + type: list + data: + - type: note + id: '29' + created_at: 1718887958 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ - type: note + id: '28' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ - type: note + id: '27' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ total_count: 3 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 50 + total_pages: 1 + createNote: + path: /contacts/{id}/notes + method: POST + auth: true + docs: You can add a note to a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given contact. + display-name: Create a note + request: + name: CreateNoteRequest + body: + properties: + body: + type: string + docs: The text of the note. + contact_id: + type: optional + docs: The unique identifier of a given contact. + admin_id: + type: optional + docs: The unique identifier of a given admin. + content-type: application/json + response: + docs: Successful response + type: Note + errors: + - root.CreateNoteRequestNotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + request: + body: Hello + contact_id: 667d60978a68186f43bafd9e + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ - name: Admin not found + path-parameters: + id: 1 + request: + body: Hello + contact_id: 667d60988a68186f43bafd9f + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ - name: Contact not found + path-parameters: + id: 1 + request: + body: Hello + contact_id: '123' + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ retrieveNote: + path: /notes/{id} + method: GET + auth: true + docs: You can fetch the details of a single note. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given note + display-name: Retrieve a note + response: + docs: Note found + type: Note + errors: + - root.RetrieveNoteRequestUnauthorizedError + - root.RetrieveNoteRequestNotFoundError + examples: + - name: Note found + path-parameters: + id: 1 + response: + body: + type: note + id: '37' + created_at: 1718801789 + contact: + type: contact + id: 667d617d8a68186f43bafe58 + author: + type: admin + id: '991267764' + name: Ciaran316 Lee + email: admin316@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

This is a note.

+ source: + openapi: ../openapi.yml + display-name: Notes +docs: Everything about your Notes +types: + NoteContact: + docs: Represents the contact that the note was created about. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `contact`. + id: + type: optional + docs: The id of the contact. + source: + openapi: ../openapi.yml + Note: + docs: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `note`. + id: + type: optional + docs: The id of the note. + created_at: + type: optional + docs: The time the note was created. + contact: + type: optional + docs: Represents the contact that the note was created about. + author: + type: optional + docs: Optional. Represents the Admin that created the note. + body: + type: optional + docs: The body text of the note. + source: + openapi: ../openapi.yml +", + }, + "segments.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Segments", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Segments", + "endpoints": { + "listSegments": { + "auth": true, + "display-name": "List all segments", + "docs": "You can fetch a list of all segments.", + "errors": [ + "root.ListSegmentsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "pages": { + "key": "value", + }, + "segments": [ + { + "count": 3, + "created_at": 1719492991, + "id": "667d617f8a68186f43bafe5b", + "name": "John segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492991, + }, + { + "count": 3, + "created_at": 1719492991, + "id": "667d617f8a68186f43bafe5c", + "name": "Jane segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492991, + }, + ], + "type": "segment.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/segments", + "request": { + "name": "ListSegmentsRequest", + "query-parameters": { + "include_count": { + "docs": "It includes the count of contacts that belong to each segment.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.SegmentList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveSegment": { + "auth": true, + "display-name": "Retrieve a segment", + "docs": "You can fetch the details of a single segment.", + "errors": [ + "root.RetrieveSegmentRequestUnauthorizedError", + "root.RetrieveSegmentRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "count": 3, + "created_at": 1719492992, + "id": "667d61808a68186f43bafe5f", + "name": "John segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492992, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/segments/{id}", + "path-parameters": { + "id": { + "docs": "The unique identified of a given segment.", + "type": "string", + }, + }, + "response": { + "docs": "Successful response", + "type": "Segment", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Segment": { + "docs": "A segment is a group of your contacts defined by the rules that you set.", + "properties": { + "count": { + "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", + "type": "optional", + }, + "created_at": { + "docs": "The time the segment was created.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier representing the segment.", + "type": "optional", + }, + "name": { + "docs": "The name of the segment.", + "type": "optional", + }, + "person_type": { + "docs": "Type of the contact: contact (lead) or user.", + "type": "optional", + }, + "type": { + "docs": "The type of object.", + "type": "optional>", + }, + "updated_at": { + "docs": "The time the segment was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SegmentPersonType": { + "docs": "Type of the contact: contact (lead) or user.", + "enum": [ + "contact", + "user", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listSegments: + path: /segments + method: GET + auth: true + docs: You can fetch a list of all segments. + source: + openapi: ../openapi.yml + display-name: List all segments + request: + name: ListSegmentsRequest + query-parameters: + include_count: + type: optional + docs: It includes the count of contacts that belong to each segment. + response: + docs: Successful response + type: root.SegmentList + errors: + - root.ListSegmentsRequestUnauthorizedError + examples: + - name: Successful response + response: + body: + type: segment.list + segments: + - type: segment + id: 667d617f8a68186f43bafe5b + name: John segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + count: 3 + - type: segment + id: 667d617f8a68186f43bafe5c + name: Jane segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + count: 3 + pages: + key: value + retrieveSegment: + path: /segments/{id} + method: GET + auth: true + docs: You can fetch the details of a single segment. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identified of a given segment. + display-name: Retrieve a segment + response: + docs: Successful response + type: Segment + errors: + - root.RetrieveSegmentRequestUnauthorizedError + - root.RetrieveSegmentRequestNotFoundError + examples: + - name: Successful response + path-parameters: + id: '123' + response: + body: + type: segment + id: 667d61808a68186f43bafe5f + name: John segment + created_at: 1719492992 + updated_at: 1719492992 + person_type: user + count: 3 + source: + openapi: ../openapi.yml + display-name: Segments +docs: Everything about your Segments +types: + SegmentPersonType: + enum: + - contact + - user + docs: 'Type of the contact: contact (lead) or user.' + source: + openapi: ../openapi.yml + Segment: + docs: A segment is a group of your contacts defined by the rules that you set. + properties: + type: + type: optional> + docs: The type of object. + id: + type: optional + docs: The unique identifier representing the segment. + name: + type: optional + docs: The name of the segment. + created_at: + type: optional + docs: The time the segment was created. + updated_at: + type: optional + docs: The time the segment was updated. + person_type: + type: optional + docs: 'Type of the contact: contact (lead) or user.' + count: + type: optional + docs: >- + The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + source: + openapi: ../openapi.yml +", + }, + "subscriptionTypes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about subscription types", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Subscription Types", + "endpoints": { + "attachSubscriptionTypeToContact": { + "auth": true, + "display-name": "Add subscription to a contact", + "docs": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + +This will return a subscription type model for the subscription type that was added to the contact. +", + "errors": [ + "root.AttachSubscriptionTypeToContactRequestUnauthorizedError", + "root.AttachSubscriptionTypeToContactRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + { + "name": "Resource not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "invalid_id", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "consent_type": { + "docs": "The consent_type of a subscription, opt_out or opt_in.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the subscription which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachSubscriptionTypeToContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "SubscriptionType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachSubscriptionTypeToContact": { + "auth": true, + "display-name": "Remove subscription from a contact", + "docs": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "errors": [ + "root.DetachSubscriptionTypeToContactRequestUnauthorizedError", + "root.DetachSubscriptionTypeToContactRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "124", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the subscription type which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "SubscriptionType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSubscriptionTypes": { + "auth": true, + "display-name": "List subscription types", + "docs": "You can list all subscription types. A list of subscription type objects will be returned.", + "errors": [ + "root.ListSubscriptionTypesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "consent_type": "opt_out", + "content_types": [ + "email", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "137", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/subscription_types", + "response": { + "docs": "Successful", + "type": "root.SubscriptionTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "SubscriptionType": { + "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "properties": { + "consent_type": { + "docs": "Describes the type of consent.", + "type": "optional", + }, + "content_types": { + "docs": "The message types that this subscription supports - can contain `email` or `sms_message`.", + "type": "optional>", + }, + "default_translation": { + "type": "optional", + }, + "id": { + "docs": "The unique identifier representing the subscription type.", + "type": "optional", + }, + "state": { + "docs": "The state of the subscription type.", + "type": "optional", + }, + "translations": { + "docs": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - subscription", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeConsentType": { + "docs": "Describes the type of consent.", + "enum": [ + "opt_out", + "opt_in", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeContentTypesItem": { + "enum": [ + "email", + "sms_message", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeState": { + "docs": "The state of the subscription type.", + "enum": [ + "live", + "draft", + "archived", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + attachSubscriptionTypeToContact: + path: /contacts/{contact_id}/subscriptions + method: POST + auth: true + docs: > + You can add a specific subscription to a contact. In Intercom, we have + two different subscription types based on user consent - opt-out and + opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type + that was added to the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Add subscription to a contact + request: + name: AttachSubscriptionTypeToContactRequest + body: + properties: + id: + type: string + docs: >- + The unique identifier for the subscription which is given by + Intercom + consent_type: + type: string + docs: The consent_type of a subscription, opt_out or opt_in. + content-type: application/json + response: + docs: Successful + type: SubscriptionType + errors: + - root.AttachSubscriptionTypeToContactRequestUnauthorizedError + - root.AttachSubscriptionTypeToContactRequestNotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '37846' + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + - name: Contact not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '37846' + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + - name: Resource not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: invalid_id + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + detachSubscriptionTypeToContact: + path: /contacts/{contact_id}/subscriptions/{id} + method: DELETE + auth: true + docs: >- + You can remove a specific subscription from a contact. This will return + a subscription type model for the subscription type that was removed + from the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: >- + The unique identifier for the subscription type which is given by + Intercom + display-name: Remove subscription from a contact + response: + docs: Successful + type: SubscriptionType + errors: + - root.DetachSubscriptionTypeToContactRequestUnauthorizedError + - root.DetachSubscriptionTypeToContactRequestNotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + id: '37846' + response: + body: + type: subscription + id: '124' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + listSubscriptionTypes: + path: /subscription_types + method: GET + auth: true + docs: >- + You can list all subscription types. A list of subscription type objects + will be returned. + source: + openapi: ../openapi.yml + display-name: List subscription types + response: + docs: Successful + type: root.SubscriptionTypeList + errors: + - root.ListSubscriptionTypesRequestUnauthorizedError + examples: + - name: Successful + response: + body: + type: list + data: + - type: subscription + id: '137' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_out + content_types: + - email + source: + openapi: ../openapi.yml + display-name: Subscription Types +docs: Everything about subscription types +types: + SubscriptionTypeState: + enum: + - live + - draft + - archived + docs: The state of the subscription type. + source: + openapi: ../openapi.yml + SubscriptionTypeConsentType: + enum: + - opt_out + - opt_in + docs: Describes the type of consent. + source: + openapi: ../openapi.yml + SubscriptionTypeContentTypesItem: + enum: + - email + - sms_message + source: + openapi: ../openapi.yml + SubscriptionType: + docs: >- + A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: optional + docs: The type of the object - subscription + id: + type: optional + docs: The unique identifier representing the subscription type. + state: + type: optional + docs: The state of the subscription type. + default_translation: + type: optional + translations: + type: optional> + docs: >- + An array of translations objects with the localised version of the + subscription type in each available locale within your translation + settings. + consent_type: + type: optional + docs: Describes the type of consent. + content_types: + type: optional> + docs: >- + The message types that this subscription supports - can contain + `email` or `sms_message`. + source: + openapi: ../openapi.yml +", + }, + "switch.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about Switch", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Switch", + "endpoints": { + "createPhoneSwitch": { + "auth": true, + "display-name": "Create a phone Switch", + "docs": "You can use the API to deflect phone calls to the Intercom Messenger. +Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + +If custom attributes are specified, they will be added to the user or lead's custom data attributes. +", + "errors": [ + "root.CreatePhoneSwitchRequestBadRequestError", + "root.CreatePhoneSwitchRequestUnauthorizedError", + "root.CreatePhoneSwitchRequestUnprocessableEntityError", + ], + "examples": [ + { + "name": "successful", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "bad request - exception sending sms", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "bad request - invalid number", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "unprocessable entity", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+40241100100", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/phone_call_redirects", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createPhoneSwitch: + path: /phone_call_redirects + method: POST + auth: true + docs: > + You can use the API to deflect phone calls to the Intercom Messenger. + + Calling this endpoint will send an SMS with a link to the Messenger to + the phone number specified. + + + If custom attributes are specified, they will be added to the user or + lead's custom data attributes. + source: + openapi: ../openapi.yml + display-name: Create a phone Switch + request: + body: + type: optional + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.CreatePhoneSwitchRequestBadRequestError + - root.CreatePhoneSwitchRequestUnauthorizedError + - root.CreatePhoneSwitchRequestUnprocessableEntityError + examples: + - name: successful + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: bad request - exception sending sms + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: bad request - invalid number + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: unprocessable entity + request: + phone: '+40241100100' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + source: + openapi: ../openapi.yml + display-name: Switch +docs: Everything about Switch +", + }, + "tags.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about tags", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Tags", + "endpoints": { + "attachTagToContact": { + "auth": true, + "display-name": "Add tag to a contact", + "docs": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "errors": [ + "root.AttachTagToContactRequestUnauthorizedError", + "root.AttachTagToContactRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachTagToConversation": { + "auth": true, + "display-name": "Add tag to a conversation", + "docs": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "errors": [ + "root.AttachTagToConversationRequestUnauthorizedError", + "root.AttachTagToConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "conversation_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "99", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "conversation_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "99", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{conversation_id}/tags", + "path-parameters": { + "conversation_id": { + "docs": "conversation_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachTagToTicket": { + "auth": true, + "display-name": "Add tag to a ticket", + "docs": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "errors": [ + "root.AttachTagToTicketRequestUnauthorizedError", + "root.AttachTagToTicketRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "134", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Ticket not found", + "path-parameters": { + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "134", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/{ticket_id}/tags", + "path-parameters": { + "ticket_id": { + "docs": "ticket_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createTag": { + "auth": true, + "display-name": "Create or update a tag, Tag or untag companies, Tag contacts", + "docs": "You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + +Each operation will return a tag object. +", + "errors": [ + "root.CreateTagRequestBadRequestError", + "root.CreateTagRequestUnauthorizedError", + "root.CreateTagRequestNotFoundError", + ], + "examples": [ + { + "name": "Action successful", + "request": { + "name": "test", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "Invalid parameters", + "request": { + "name": "Independent", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "Company not found", + "request": { + "companies": [ + { + "company_id": "123", + }, + ], + "name": "test", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "User not found", + "request": { + "name": "test", + "users": [ + { + "id": "123", + }, + ], + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tags", + "request": { + "body": "CreateTagRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Action successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteTag": { + "auth": true, + "display-name": "Delete tag", + "docs": "You can delete the details of tags that are on the workspace by passing in the id.", + "errors": [ + "root.DeleteTagRequestBadRequestError", + "root.DeleteTagRequestUnauthorizedError", + "root.DeleteTagRequestNotFoundError", + ], + "examples": [ + { + "path-parameters": { + "id": "123", + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given tag", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromContact": { + "auth": true, + "display-name": "Remove tag from a contact", + "docs": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "errors": [ + "root.DetachTagFromContactRequestUnauthorizedError", + "root.DetachTagFromContactRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "97", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromConversation": { + "auth": true, + "display-name": "Remove tag from a conversation", + "docs": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "errors": [ + "root.DetachTagFromConversationRequestUnauthorizedError", + "root.DetachTagFromConversationRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/conversations/{conversation_id}/tags/{id}", + "path-parameters": { + "conversation_id": { + "docs": "conversation_id", + "type": "string", + }, + "id": { + "docs": "id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachTagFromConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromTicket": { + "auth": true, + "display-name": "Remove tag from a ticket", + "docs": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "errors": [ + "root.DetachTagFromTicketRequestUnauthorizedError", + "root.DetachTagFromTicketRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Ticket not found", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/tickets/{ticket_id}/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + "ticket_id": { + "docs": "ticket_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachTagFromTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "findTag": { + "auth": true, + "display-name": "Find a specific tag", + "docs": "You can fetch the details of tags that are on the workspace by their id. +This will return a tag object. +", + "errors": [ + "root.FindTagRequestUnauthorizedError", + "root.FindTagRequestNotFoundError", + ], + "examples": [ + { + "name": "Tag found", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "126", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given tag", + "type": "string", + }, + }, + "response": { + "docs": "Tag found", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTags": { + "auth": true, + "display-name": "List all tags", + "docs": "You can fetch a list of all tags for a given workspace. + +", + "errors": [ + "root.ListTagsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "applied_at": 1663597223, + "applied_by": { + "type": "contact", + }, + "id": "115", + "name": "Manual tag 1", + "type": "tag", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tags", + "response": { + "docs": "successful", + "type": "root.Tags", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateTagRequestBody": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "root.CreateOrUpdateTagRequest", + }, + { + "type": "root.TagCompanyRequest", + }, + { + "type": "root.UntagCompanyRequest", + }, + { + "type": "root.TagMultipleUsersRequest", + }, + ], + }, + "Tag": { + "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "properties": { + "applied_at": { + "docs": "The time when the tag was applied to the object", + "type": "optional", + }, + "applied_by": { + "type": "optional", + }, + "id": { + "docs": "The id of the tag", + "type": "optional", + }, + "name": { + "docs": "The name of the tag", + "type": "optional", + }, + "type": { + "docs": "value is "tag"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + attachTagToContact: + path: /contacts/{contact_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific contact. This will return a tag object for the + tag that was added to the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Add tag to a contact + request: + name: AttachTagToContactRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.AttachTagToContactRequestUnauthorizedError + - root.AttachTagToContactRequestNotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '7522907' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Contact not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '7522907' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '123' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromContact: + path: /contacts/{contact_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific contact. This will return a tag + object for the tag that was removed from the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + display-name: Remove tag from a contact + response: + docs: successful + type: Tag + errors: + - root.DetachTagFromContactRequestUnauthorizedError + - root.DetachTagFromContactRequestNotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + id: '7522907' + response: + body: + type: tag + id: '97' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + attachTagToConversation: + path: /conversations/{conversation_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific conversation. This will return a tag object for + the tag that was added to the conversation. + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: conversation_id + display-name: Add tag to a conversation + request: + name: AttachTagToConversationRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.AttachTagToConversationRequestUnauthorizedError + - root.AttachTagToConversationRequestNotFoundError + examples: + - name: successful + path-parameters: + conversation_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '99' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Conversation not found + path-parameters: + conversation_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '99' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromConversation: + path: /conversations/{conversation_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific conversation. This will return a tag + object for the tag that was removed from the conversation. + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: conversation_id + id: + type: string + docs: id + display-name: Remove tag from a conversation + request: + name: DetachTagFromConversationRequest + body: + properties: + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.DetachTagFromConversationRequestUnauthorizedError + - root.DetachTagFromConversationRequestNotFoundError + examples: + - name: successful + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Conversation not found + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + listTags: + path: /tags + method: GET + auth: true + docs: |+ + You can fetch a list of all tags for a given workspace. + + source: + openapi: ../openapi.yml + display-name: List all tags + response: + docs: successful + type: root.Tags + errors: + - root.ListTagsRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + data: + - type: tag + id: '115' + name: Manual tag 1 + applied_at: 1663597223 + applied_by: + type: contact + createTag: + path: /tags + method: POST + auth: true + docs: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + source: + openapi: ../openapi.yml + display-name: Create or update a tag, Tag or untag companies, Tag contacts + request: + body: CreateTagRequestBody + content-type: application/json + response: + docs: Action successful + type: Tag + errors: + - root.CreateTagRequestBadRequestError + - root.CreateTagRequestUnauthorizedError + - root.CreateTagRequestNotFoundError + examples: + - name: Action successful + request: + name: test + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Invalid parameters + request: + name: Independent + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Company not found + request: + name: test + companies: + - company_id: '123' + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: User not found + request: + name: test + users: + - id: '123' + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + findTag: + path: /tags/{id} + method: GET + auth: true + docs: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given tag + display-name: Find a specific tag + response: + docs: Tag found + type: Tag + errors: + - root.FindTagRequestUnauthorizedError + - root.FindTagRequestNotFoundError + examples: + - name: Tag found + path-parameters: + id: '123' + response: + body: + type: tag + id: '126' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + deleteTag: + path: /tags/{id} + method: DELETE + auth: true + docs: >- + You can delete the details of tags that are on the workspace by passing + in the id. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given tag + display-name: Delete tag + errors: + - root.DeleteTagRequestBadRequestError + - root.DeleteTagRequestUnauthorizedError + - root.DeleteTagRequestNotFoundError + examples: + - path-parameters: + id: '123' + attachTagToTicket: + path: /tickets/{ticket_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific ticket. This will return a tag object for the tag + that was added to the ticket. + source: + openapi: ../openapi.yml + path-parameters: + ticket_id: + type: string + docs: ticket_id + display-name: Add tag to a ticket + request: + name: AttachTagToTicketRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.AttachTagToTicketRequestUnauthorizedError + - root.AttachTagToTicketRequestNotFoundError + examples: + - name: successful + path-parameters: + ticket_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '134' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Ticket not found + path-parameters: + ticket_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '134' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromTicket: + path: /tickets/{ticket_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific ticket. This will return a tag object + for the tag that was removed from the ticket. + source: + openapi: ../openapi.yml + path-parameters: + ticket_id: + type: string + docs: ticket_id + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + display-name: Remove tag from a ticket + request: + name: DetachTagFromTicketRequest + body: + properties: + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.DetachTagFromTicketRequestUnauthorizedError + - root.DetachTagFromTicketRequestNotFoundError + examples: + - name: successful + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Ticket not found + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + source: + openapi: ../openapi.yml + display-name: Tags +docs: Everything about tags +types: + CreateTagRequestBody: + discriminated: false + union: + - type: root.CreateOrUpdateTagRequest + - type: root.TagCompanyRequest + - type: root.UntagCompanyRequest + - type: root.TagMultipleUsersRequest + source: + openapi: ../openapi.yml + Tag: + docs: >- + A tag allows you to label your contacts, companies, and conversations and + list them using that tag. + properties: + type: + type: optional + docs: value is "tag" + id: + type: optional + docs: The id of the tag + name: + type: optional + docs: The name of the tag + applied_at: + type: optional + docs: The time when the tag was applied to the object + applied_by: + type: optional + source: + openapi: ../openapi.yml +", + }, + "teams.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Teams", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Teams", + "endpoints": { + "listTeams": { + "auth": true, + "display-name": "List all teams", + "docs": "This will return a list of team objects for the App.", + "errors": [ + "root.ListTeamsRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "teams": [ + { + "admin_ids": [ + 493881, + ], + "id": "814865", + "name": "Example Team", + "type": "team", + }, + ], + "type": "team.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/teams", + "response": { + "docs": "successful", + "type": "root.TeamList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveTeam": { + "auth": true, + "display-name": "Retrieve a team", + "docs": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "errors": [ + "root.RetrieveTeamRequestUnauthorizedError", + "root.RetrieveTeamRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "admin_ids": [ + 493881, + ], + "admin_priority_level": { + "primary_admin_ids": [ + 493881, + ], + "secondary_admin_ids": [ + 814865, + ], + }, + "id": "991267802", + "name": "team 1", + "type": "team", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/teams/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given team.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Team", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Team": { + "docs": "Teams are groups of admins in Intercom.", + "properties": { + "admin_ids": { + "docs": "The list of admin IDs that are a part of the team.", + "type": "optional>", + }, + "admin_priority_level": { + "type": "optional", + }, + "id": { + "docs": "The id of the team", + "type": "optional", + }, + "name": { + "docs": "The name of the team", + "type": "optional", + }, + "type": { + "docs": "Value is always "team"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listTeams: + path: /teams + method: GET + auth: true + docs: This will return a list of team objects for the App. + source: + openapi: ../openapi.yml + display-name: List all teams + response: + docs: successful + type: root.TeamList + errors: + - root.ListTeamsRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: team.list + teams: + - type: team + id: '814865' + name: Example Team + admin_ids: + - 493881 + retrieveTeam: + path: /teams/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single team, containing an array of + admins that belong to this team. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given team. + display-name: Retrieve a team + response: + docs: successful + type: Team + errors: + - root.RetrieveTeamRequestUnauthorizedError + - root.RetrieveTeamRequestNotFoundError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + type: team + id: '991267802' + name: team 1 + admin_ids: + - 493881 + admin_priority_level: + primary_admin_ids: + - 493881 + secondary_admin_ids: + - 814865 + source: + openapi: ../openapi.yml + display-name: Teams +docs: Everything about your Teams +types: + Team: + docs: Teams are groups of admins in Intercom. + properties: + type: + type: optional + docs: Value is always "team" + id: + type: optional + docs: The id of the team + name: + type: optional + docs: The name of the team + admin_ids: + type: optional> + docs: The list of admin IDs that are a part of the team. + admin_priority_level: + type: optional + source: + openapi: ../openapi.yml +", + }, + "ticketTypeAttributes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your ticket type attributes", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Ticket Type Attributes", + "endpoints": { + "createTicketTypeAttribute": { + "auth": true, + "display-name": "Create a new attribute for a ticket type", + "docs": "You can create a new attribute for a ticket type.", + "errors": [ + "root.CreateTicketTypeAttributeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket Type Attribute created", + "path-parameters": { + "ticket_type_id": "ticket_type_id", + }, + "request": { + "data_type": "string", + "description": "Attribute Description", + "name": "Attribute Title", + "required_to_create": false, + }, + "response": { + "body": { + "archived": false, + "created_at": 1719493013, + "data_type": "string", + "default": false, + "description": "Attribute Description", + "id": "210", + "input_options": { + "multiline": false, + }, + "name": "Attribute Title", + "order": 2, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 81, + "type": "ticket_type_attribute", + "updated_at": 1719493013, + "visible_on_create": true, + "visible_to_contacts": true, + "workspace_id": "this_is_an_id600_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/ticket_types/{ticket_type_id}/attributes", + "path-parameters": { + "ticket_type_id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "allow_multiple_values": { + "docs": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "type": "optional", + }, + "data_type": { + "docs": "The data type of the attribute", + "type": "CreateTicketTypeAttributeRequestDataType", + }, + "description": { + "docs": "The description of the attribute presented to the teammate or contact", + "type": "string", + }, + "list_items": { + "docs": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "type": "optional", + }, + "multiline": { + "docs": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "string", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateTicketTypeAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Ticket Type Attribute created", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicketTypeAttribute": { + "auth": true, + "display-name": "Update an existing attribute for a ticket type", + "docs": "You can update an existing attribute for a ticket type.", + "errors": [ + "root.UpdateTicketTypeAttributeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket Type Attribute updated", + "path-parameters": { + "id": "id", + "ticket_type_id": "ticket_type_id", + }, + "request": { + "description": "New Attribute Description", + }, + "response": { + "body": { + "archived": false, + "created_at": 1719493013, + "data_type": "string", + "default": false, + "description": "New Attribute Description", + "id": "215", + "input_options": { + "key": "value", + }, + "name": "name", + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 83, + "type": "ticket_type_attribute", + "updated_at": 1719493014, + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "this_is_an_id604_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type attribute which is given by Intercom.", + "type": "string", + }, + "ticket_type_id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "allow_multiple_values": { + "docs": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "type": "optional", + }, + "archived": { + "docs": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)", + "type": "optional", + }, + "description": { + "docs": "The description of the attribute presented to the teammate or contact", + "type": "optional", + }, + "list_items": { + "docs": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "type": "optional", + }, + "multiline": { + "docs": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "optional", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateTicketTypeAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Ticket Type Attribute updated", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateTicketTypeAttributeRequestDataType": { + "docs": "The data type of the attribute", + "enum": [ + "string", + "list", + "integer", + "decimal", + "boolean", + "datetime", + "files", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + CreateTicketTypeAttributeRequestDataType: + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + docs: The data type of the attribute + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createTicketTypeAttribute: + path: /ticket_types/{ticket_type_id}/attributes + method: POST + auth: true + docs: You can create a new attribute for a ticket type. + source: + openapi: ../openapi.yml + path-parameters: + ticket_type_id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Create a new attribute for a ticket type + request: + name: CreateTicketTypeAttributeRequest + body: + properties: + name: + type: string + docs: The name of the ticket type attribute + description: + type: string + docs: >- + The description of the attribute presented to the teammate or + contact + data_type: + type: CreateTicketTypeAttributeRequestDataType + docs: The data type of the attribute + required_to_create: + type: optional + docs: >- + Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + required_to_create_for_contacts: + type: optional + docs: >- + Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + visible_on_create: + type: optional + docs: >- + Whether the attribute is visible to teammates when creating a + ticket in Inbox. + default: true + visible_to_contacts: + type: optional + docs: >- + Whether the attribute is visible to contacts when creating a + ticket in Messenger. + default: true + multiline: + type: optional + docs: >- + Whether the attribute allows multiple lines of text (only + applicable to string attributes) + list_items: + type: optional + docs: >- + A comma delimited list of items for the attribute value (only + applicable to list attributes) + allow_multiple_values: + type: optional + docs: >- + Whether the attribute allows multiple files to be attached to it + (only applicable to file attributes) + content-type: application/json + response: + docs: Ticket Type Attribute created + type: optional + errors: + - root.CreateTicketTypeAttributeRequestUnauthorizedError + examples: + - name: Ticket Type Attribute created + path-parameters: + ticket_type_id: ticket_type_id + request: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + response: + body: + type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id600_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + order: 2 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: false + ticket_type_id: 81 + archived: false + created_at: 1719493013 + updated_at: 1719493013 + updateTicketTypeAttribute: + path: /ticket_types/{ticket_type_id}/attributes/{id} + method: PUT + auth: true + docs: You can update an existing attribute for a ticket type. + source: + openapi: ../openapi.yml + path-parameters: + ticket_type_id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + id: + type: string + docs: >- + The unique identifier for the ticket type attribute which is given + by Intercom. + display-name: Update an existing attribute for a ticket type + request: + name: UpdateTicketTypeAttributeRequest + body: + properties: + name: + type: optional + docs: The name of the ticket type attribute + description: + type: optional + docs: >- + The description of the attribute presented to the teammate or + contact + required_to_create: + type: optional + docs: >- + Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + required_to_create_for_contacts: + type: optional + docs: >- + Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + visible_on_create: + type: optional + docs: >- + Whether the attribute is visible to teammates when creating a + ticket in Inbox. + default: true + visible_to_contacts: + type: optional + docs: >- + Whether the attribute is visible to contacts when creating a + ticket in Messenger. + default: true + multiline: + type: optional + docs: >- + Whether the attribute allows multiple lines of text (only + applicable to string attributes) + list_items: + type: optional + docs: >- + A comma delimited list of items for the attribute value (only + applicable to list attributes) + allow_multiple_values: + type: optional + docs: >- + Whether the attribute allows multiple files to be attached to it + (only applicable to file attributes) + archived: + type: optional + docs: >- + Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously + created tickets) + content-type: application/json + response: + docs: Ticket Type Attribute updated + type: optional + errors: + - root.UpdateTicketTypeAttributeRequestUnauthorizedError + examples: + - name: Ticket Type Attribute updated + path-parameters: + ticket_type_id: ticket_type_id + id: id + request: + description: New Attribute Description + response: + body: + type: ticket_type_attribute + id: '215' + workspace_id: this_is_an_id604_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + input_options: + key: value + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 83 + archived: false + created_at: 1719493013 + updated_at: 1719493014 + source: + openapi: ../openapi.yml + display-name: Ticket Type Attributes +docs: Everything about your ticket type attributes +", + }, + "ticketTypes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your ticket types", + "imports": { + "root": "__package__.yml", + "tickets": "tickets.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Ticket Types", + "endpoints": { + "createTicketType": { + "auth": true, + "display-name": "Create a ticket type", + "docs": "You can create a new ticket type. +> 📘 Creating ticket types. +> +> Every ticket type will be created with two default attributes: _default_title_ and _default_description_. +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "errors": [ + "root.CreateTicketTypeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type created", + "request": { + "category": "Customer", + "description": "Customer Report Template", + "icon": "🎟️", + "name": "Customer Issue", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493016, + "description": "Customer Report Template", + "icon": "🎟️", + "id": "88", + "name": "Customer Issue", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493016, + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/ticket_types", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Ticket type created", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getTicketType": { + "auth": true, + "display-name": "Retrieve a ticket type", + "docs": "You can fetch the details of a single ticket type.", + "errors": [ + "root.GetTicketTypeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type found", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493017, + "description": "Bug Report Template", + "icon": "🎟️", + "id": "90", + "name": "Bug Report", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493017, + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/ticket_types/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Ticket type found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTicketTypes": { + "auth": true, + "display-name": "List all ticket types", + "docs": "You can get a list of all ticket types for a workspace.", + "errors": [ + "root.ListTicketTypesRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "ticket_types": [ + { + "archived": false, + "category": "Customer", + "created_at": 1, + "description": "A bug that has been reported.", + "icon": "🐞", + "id": "1295", + "name": "Bug", + "type": "ticket_type", + "updated_at": 1, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/ticket_types", + "response": { + "docs": "successful", + "type": "root.TicketTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicketType": { + "auth": true, + "display-name": "Update a ticket type", + "docs": " +You can update a ticket type. + +> 📘 Updating a ticket type. +> +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "errors": [ + "root.UpdateTicketTypeRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type updated", + "path-parameters": { + "id": "id", + }, + "request": { + "name": "Bug Report 2", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493018, + "description": "Bug Report Template", + "icon": "🎟️", + "id": "92", + "name": "Bug Report 2", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493018, + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/ticket_types/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Ticket type updated", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + tickets: tickets.yml +service: + auth: false + base-path: '' + endpoints: + listTicketTypes: + path: /ticket_types + method: GET + auth: true + docs: You can get a list of all ticket types for a workspace. + source: + openapi: ../openapi.yml + display-name: List all ticket types + response: + docs: successful + type: root.TicketTypeList + errors: + - root.ListTicketTypesRequestUnauthorizedError + examples: + - name: successful + response: + body: + type: list + ticket_types: + - type: ticket_type + id: '1295' + category: Customer + name: Bug + description: A bug that has been reported. + icon: 🐞 + workspace_id: ecahpwf5 + archived: false + created_at: 1 + updated_at: 1 + createTicketType: + path: /ticket_types + method: POST + auth: true + docs: > + You can create a new ticket type. + + > 📘 Creating ticket types. + + > + + > Every ticket type will be created with two default attributes: + _default_title_ and _default_description_. + + > For the `icon` propery, use an emoji from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + source: + openapi: ../openapi.yml + display-name: Create a ticket type + request: + body: + type: optional + content-type: application/json + response: + docs: Ticket type created + type: optional + errors: + - root.CreateTicketTypeRequestUnauthorizedError + examples: + - name: Ticket type created + request: + name: Customer Issue + description: Customer Report Template + category: Customer + icon: 🎟️ + response: + body: + type: ticket_type + id: '88' + category: Customer + name: Customer Issue + description: Customer Report Template + icon: 🎟️ + workspace_id: this_is_an_id612_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493016 + updated_at: 1719493016 + getTicketType: + path: /ticket_types/{id} + method: GET + auth: true + docs: You can fetch the details of a single ticket type. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Retrieve a ticket type + response: + docs: Ticket type found + type: optional + errors: + - root.GetTicketTypeRequestUnauthorizedError + examples: + - name: Ticket type found + path-parameters: + id: id + response: + body: + type: ticket_type + id: '90' + category: Customer + name: Bug Report + description: Bug Report Template + icon: 🎟️ + workspace_id: this_is_an_id616_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493017 + updated_at: 1719493017 + updateTicketType: + path: /ticket_types/{id} + method: PUT + auth: true + docs: > + + You can update a ticket type. + + + > 📘 Updating a ticket type. + + > + + > For the `icon` propery, use an emoji from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Update a ticket type + request: + body: + type: optional + content-type: application/json + response: + docs: Ticket type updated + type: optional + errors: + - root.UpdateTicketTypeRequestUnauthorizedError + examples: + - name: Ticket type updated + path-parameters: + id: id + request: + name: Bug Report 2 + response: + body: + type: ticket_type + id: '92' + category: Customer + name: Bug Report 2 + description: Bug Report Template + icon: 🎟️ + workspace_id: this_is_an_id620_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493018 + updated_at: 1719493018 + source: + openapi: ../openapi.yml + display-name: Ticket Types +docs: Everything about your ticket types +", + }, + "tickets.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your tickets", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Tickets", + "endpoints": { + "createTicket": { + "auth": true, + "display-name": "Create a ticket", + "docs": "You can create a new ticket.", + "errors": [ + "root.CreateTicketRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "request": { + "contacts": [ + { + "id": "667d61b78a68186f43bafe8d", + }, + ], + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_type_id": "1234", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61b78a68186f43bafe8d", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493048, + "id": "489", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "48", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io", + "id": "991267871", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493048, + "id": "125", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493048, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493047, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "106", + "name": "my-ticket-type-15", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493047, + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493048, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets", + "request": { + "body": { + "properties": { + "company_id": { + "docs": "The ID of the company that the ticket is associated with. The ID that you set upon company creation.", + "type": "optional", + }, + "contacts": { + "docs": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed", + "type": "list", + }, + "created_at": { + "docs": "The time the ticket was created. If not provided, the current time will be used.", + "type": "optional", + }, + "ticket_attributes": { + "type": "optional", + }, + "ticket_type_id": { + "docs": "The ID of the type of ticket you want to create", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getTicket": { + "auth": true, + "display-name": "Retrieve a ticket", + "docs": "You can fetch the details of a single ticket.", + "errors": [ + "root.GetTicketRequestUnauthorizedError", + ], + "examples": [ + { + "name": "Ticket found", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "038050f6-d917-4b9d-89cb-539b1d371172", + "id": "667d61c48a68186f43bafe91", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493061, + "id": "493", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "ticket_attributes", + "_default_title_": "attribute_value", + }, + "ticket_id": "52", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin445@email.com", + "id": "991267912", + "name": "Ciaran445 Lee", + "type": "admin", + }, + "created_at": 1719493061, + "id": "134", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493061, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493060, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "112", + "name": "my-ticket-type-21", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493060, + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493061, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tickets/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Ticket found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "replyTicket": { + "auth": true, + "display-name": "Reply to a ticket", + "docs": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "errors": [ + "root.ReplyTicketRequestBadRequestError", + "root.ReplyTicketRequestUnauthorizedError", + "root.ReplyTicketRequestNotFoundError", + ], + "examples": [ + { + "name": "User reply", + "path-parameters": { + "id": "123", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d619d8a68186f43bafe82", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + { + "name": "Admin note reply", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "3156780", + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "message_type": "note", + "type": "admin", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + { + "name": "Admin quick_reply reply", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "3156780", + "message_type": "quick_reply", + "reply_options": [ + { + "text": "Yes", + "uuid": "22d6d1f4-1a19-41d0-94c2-e54031f78aca", + }, + { + "text": "No", + "uuid": "fbc3dbe0-ec0c-4fb6-826d-e19127191906", + }, + ], + "type": "admin", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin379@email.com", + "id": "991267834", + "name": "Ciaran379 Lee", + "type": "admin", + }, + "body": "

Okay!

", + "created_at": 1719493029, + "id": "124", + "part_type": "quick_reply", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493029, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d61a68a68186f43bafe85", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/{id}/reply", + "path-parameters": { + "id": "string", + }, + "request": { + "body": "ReplyTicketRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Admin quick_reply reply", + "type": "root.TicketReply", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchTickets": { + "auth": true, + "display-name": "Search tickets", + "docs": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + +To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + +This will accept a query object in the body which will define your filters. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiples there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + +| Field | Type | +| :---------------------------------------- | :--------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| _default_title_ | String | +| _default_description_ | String | +| category | String | +| ticket_type_id | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| open | Boolean | +| state | String | +| snoozed_until | Date (UNIX timestamp) | +| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + +### Accepted Operators + +{% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 1, + "type": "pages", + }, + "tickets": [ + { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "6895b33e-2768-4611-908e-da6632dfc8ea", + "id": "667d61c98a68186f43bafe92", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493065, + "id": "494", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_title_": "attribute_value", + }, + "ticket_id": "53", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin472@email.com", + "id": "991267940", + "name": "Ciaran472 Lee", + "type": "admin", + }, + "created_at": 1719493066, + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493066, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493065, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "117", + "name": "my-ticket-type-26", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493065, + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493066, + }, + ], + "total_count": 1, + "type": "ticket.list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.TicketList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicket": { + "auth": true, + "display-name": "Update a ticket", + "docs": "You can update a ticket.", + "errors": [ + "root.UpdateTicketRequestUnauthorizedError", + "root.UpdateTicketRequestNotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "991267883", + "assignee_id": "991267885", + }, + "open": true, + "snoozed_until": 1673609604, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "123", + "assignee_id": "991267893", + }, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + { + "name": "Assignee not found", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "991267899", + "assignee_id": "456", + }, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/tickets/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "assignment": { + "type": "optional", + }, + "is_shared": { + "docs": "Specify whether the ticket is visible to users.", + "type": "optional", + }, + "open": { + "docs": "Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.", + "type": "optional", + }, + "snoozed_until": { + "docs": "The time you want the ticket to reopen.", + "type": "optional", + }, + "state": { + "docs": "The state of the ticket.", + "type": "optional", + }, + "ticket_attributes": { + "docs": "The attributes set on the ticket.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Contacts": { + "docs": "The list of contacts affected by a ticket.", + "properties": { + "contacts": { + "docs": "The list of contacts affected by this ticket.", + "type": "optional>", + }, + "type": { + "docs": "always contact.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketRequestContactsItem": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ID", + }, + { + "type": "CreateTicketRequestContactsItemExternalId", + }, + { + "type": "Email", + }, + ], + }, + "CreateTicketRequestContactsItemExternalId": { + "docs": undefined, + "properties": { + "external_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "email": { + "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ID": { + "docs": undefined, + "properties": { + "id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ReplyTicketRequestBody": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "root.ContactReplyTicketRequest", + }, + { + "type": "root.AdminReplyTicketRequest", + }, + ], + }, + "Ticket": { + "docs": "Tickets are how you track requests from your users.", + "properties": { + "admin_assignee_id": { + "docs": "The id representing the admin assigned to the ticket.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket.", + "type": "optional", + }, + "contacts": { + "type": "optional", + }, + "created_at": { + "docs": "The time the ticket was created as a UTC Unix timestamp.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom.", + "type": "optional", + }, + "is_shared": { + "docs": "Whether or not the ticket is shared with the customer.", + "type": "optional", + }, + "linked_objects": { + "type": "optional", + }, + "open": { + "docs": "Whether or not the ticket is open. If false, the ticket is closed.", + "type": "optional", + }, + "snoozed_until": { + "docs": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.", + "type": "optional", + }, + "team_assignee_id": { + "docs": "The id representing the team assigned to the ticket.", + "type": "optional", + }, + "ticket_attributes": { + "type": "optional", + }, + "ticket_id": { + "docs": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.", + "type": "optional", + }, + "ticket_parts": { + "type": "optional", + }, + "ticket_state": { + "docs": "The state the ticket is currently in", + "type": "optional", + }, + "ticket_state_external_label": { + "docs": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.", + "type": "optional", + }, + "ticket_state_internal_label": { + "docs": "The state the ticket is currently in, in a human readable form - visible in Intercom", + "type": "optional", + }, + "ticket_type": { + "type": "optional", + }, + "type": { + "docs": "Always ticket", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the ticket was updated as a UTC Unix timestamp.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketCategory": { + "docs": "Category of the Ticket.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPart": { + "docs": "A Ticket Part represents a message in the ticket.", + "properties": { + "assigned_to": { + "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", + "type": "optional", + }, + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML.", + "type": "optional", + }, + "created_at": { + "docs": "The time the ticket part was created.", + "type": "optional", + }, + "external_id": { + "docs": "The external id of the ticket part", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket part.", + "type": "optional", + }, + "part_type": { + "docs": "The type of ticket part.", + "type": "optional", + }, + "previous_ticket_state": { + "docs": "The previous state of the ticket.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the ticket part has been redacted.", + "type": "optional", + }, + "ticket_state": { + "docs": "The state of the ticket.", + "type": "optional", + }, + "type": { + "docs": "Always ticket_part", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the ticket part was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartPreviousTicketState": { + "docs": "The previous state of the ticket.", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartTicketState": { + "docs": "The state of the ticket.", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTicketState": { + "docs": "The state the ticket is currently in", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketType": { + "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "properties": { + "archived": { + "docs": "Whether the ticket type is archived or not.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "created_at": { + "docs": "The date and time the ticket type was created.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type", + "type": "optional", + }, + "icon": { + "docs": "The icon of the ticket type", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket type.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type", + "type": "optional", + }, + "ticket_type_attributes": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type`.", + "type": "optional", + }, + "updated_at": { + "docs": "The date and time the ticket type was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace that the ticket type belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketRequestAssignment": { + "docs": undefined, + "properties": { + "admin_id": { + "docs": "The ID of the admin performing the action.", + "type": "optional", + }, + "assignee_id": { + "docs": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketRequestState": { + "docs": "The state of the ticket.", + "enum": [ + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +types: + ReplyTicketRequestBody: + discriminated: false + union: + - type: root.ContactReplyTicketRequest + - type: root.AdminReplyTicketRequest + source: + openapi: ../openapi.yml + ID: + properties: + id: + type: string + docs: The identifier for the contact as given by Intercom. + source: + openapi: ../openapi.yml + CreateTicketRequestContactsItemExternalId: + properties: + external_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. If a contact with this email does not exist, one will be + created. + source: + openapi: ../openapi.yml + CreateTicketRequestContactsItem: + discriminated: false + union: + - type: ID + - type: CreateTicketRequestContactsItemExternalId + - type: Email + source: + openapi: ../openapi.yml + UpdateTicketRequestState: + enum: + - in_progress + - waiting_on_customer + - resolved + docs: The state of the ticket. + source: + openapi: ../openapi.yml + UpdateTicketRequestAssignment: + properties: + admin_id: + type: optional + docs: The ID of the admin performing the action. + assignee_id: + type: optional + docs: >- + The ID of the admin or team to which the ticket is assigned. Set this + 0 to unassign it. + source: + openapi: ../openapi.yml + TicketCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket. + source: + openapi: ../openapi.yml + TicketTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The state the ticket is currently in + source: + openapi: ../openapi.yml + Ticket: + docs: Tickets are how you track requests from your users. + properties: + type: + type: optional> + docs: Always ticket + id: + type: optional + docs: The unique identifier for the ticket which is given by Intercom. + ticket_id: + type: optional + docs: >- + The ID of the Ticket used in the Intercom Inbox and Messenger. Do not + use ticket_id for API queries. + category: + type: optional + docs: Category of the Ticket. + ticket_attributes: + type: optional + ticket_state: + type: optional + docs: The state the ticket is currently in + ticket_type: + type: optional + contacts: + type: optional + admin_assignee_id: + type: optional + docs: The id representing the admin assigned to the ticket. + team_assignee_id: + type: optional + docs: The id representing the team assigned to the ticket. + created_at: + type: optional + docs: The time the ticket was created as a UTC Unix timestamp. + updated_at: + type: optional + docs: The last time the ticket was updated as a UTC Unix timestamp. + open: + type: optional + docs: Whether or not the ticket is open. If false, the ticket is closed. + snoozed_until: + type: optional + docs: >- + The time the ticket will be snoozed until as a UTC Unix timestamp. If + null, the ticket is not currently snoozed. + linked_objects: + type: optional + ticket_parts: + type: optional + is_shared: + type: optional + docs: Whether or not the ticket is shared with the customer. + ticket_state_internal_label: + type: optional + docs: >- + The state the ticket is currently in, in a human readable form - + visible in Intercom + ticket_state_external_label: + type: optional + docs: >- + The state the ticket is currently in, in a human readable form - + visible to customers, in the messenger, email and tickets portal. + source: + openapi: ../openapi.yml + Contacts: + docs: The list of contacts affected by a ticket. + properties: + type: + type: optional> + docs: always contact.list + contacts: + type: optional> + docs: The list of contacts affected by this ticket. + source: + openapi: ../openapi.yml + TicketPartPreviousTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The previous state of the ticket. + source: + openapi: ../openapi.yml + TicketPartTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The state of the ticket. + source: + openapi: ../openapi.yml + TicketPart: + docs: A Ticket Part represents a message in the ticket. + properties: + type: + type: optional + docs: Always ticket_part + id: + type: optional + docs: The id representing the ticket part. + part_type: + type: optional + docs: The type of ticket part. + body: + type: optional + docs: The message body, which may contain HTML. + previous_ticket_state: + type: optional + docs: The previous state of the ticket. + ticket_state: + type: optional + docs: The state of the ticket. + created_at: + type: optional + docs: The time the ticket part was created. + updated_at: + type: optional + docs: The last time the ticket part was updated. + assigned_to: + type: optional + docs: >- + The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + external_id: + type: optional + docs: The external id of the ticket part + redacted: + type: optional + docs: Whether or not the ticket part has been redacted. + source: + openapi: ../openapi.yml + TicketTypeCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + TicketType: + docs: A ticket type, used to define the data fields to be captured in a ticket. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type`. + id: + type: optional + docs: The id representing the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + name: + type: optional + docs: The name of the ticket type + description: + type: optional + docs: The description of the ticket type + icon: + type: optional + docs: The icon of the ticket type + workspace_id: + type: optional + docs: The id of the workspace that the ticket type belongs to. + ticket_type_attributes: + type: optional + archived: + type: optional + docs: Whether the ticket type is archived or not. + created_at: + type: optional + docs: The date and time the ticket type was created. + updated_at: + type: optional + docs: The date and time the ticket type was last updated. + source: + openapi: ../openapi.yml +service: + auth: false + base-path: '' + endpoints: + replyTicket: + path: /tickets/{id}/reply + method: POST + auth: true + docs: >- + You can reply to a ticket with a message from an admin or on behalf of a + contact, or with a note for admins. + source: + openapi: ../openapi.yml + path-parameters: + id: string + display-name: Reply to a ticket + request: + body: ReplyTicketRequestBody + content-type: application/json + response: + docs: Admin quick_reply reply + type: root.TicketReply + errors: + - root.ReplyTicketRequestBadRequestError + - root.ReplyTicketRequestUnauthorizedError + - root.ReplyTicketRequestNotFoundError + examples: + - name: User reply + path-parameters: + id: '123' + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d619d8a68186f43bafe82 + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Admin note reply + path-parameters: + id: '123' + request: + message_type: note + type: admin + body: >- +

An Unordered HTML List

    +
  • Coffee
  • Tea
  • Milk

An + Ordered HTML List

  1. Coffee
  2. Tea
  3. +
  4. Milk
+ admin_id: '3156780' + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Admin quick_reply reply + path-parameters: + id: '123' + request: + message_type: quick_reply + type: admin + admin_id: '3156780' + reply_options: + - text: 'Yes' + uuid: 22d6d1f4-1a19-41d0-94c2-e54031f78aca + - text: 'No' + uuid: fbc3dbe0-ec0c-4fb6-826d-e19127191906 + response: + body: + type: ticket_part + id: '124' + part_type: quick_reply + body:

Okay!

+ created_at: 1719493029 + updated_at: 1719493029 + author: + type: admin + id: '991267834' + name: Ciaran379 Lee + email: admin379@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Not found + path-parameters: + id: '123' + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d61a68a68186f43bafe85 + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + createTicket: + path: /tickets + method: POST + auth: true + docs: You can create a new ticket. + source: + openapi: ../openapi.yml + display-name: Create a ticket + request: + name: CreateTicketRequest + body: + properties: + ticket_type_id: + type: string + docs: The ID of the type of ticket you want to create + contacts: + docs: >- + The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + type: list + company_id: + type: optional + docs: >- + The ID of the company that the ticket is associated with. The ID + that you set upon company creation. + created_at: + type: optional + docs: >- + The time the ticket was created. If not provided, the current + time will be used. + ticket_attributes: + type: optional + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.CreateTicketRequestUnauthorizedError + examples: + - name: Successful response + request: + ticket_type_id: '1234' + contacts: + - id: 667d61b78a68186f43bafe8d + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + response: + body: + type: ticket + id: '489' + ticket_id: '48' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '106' + category: Back-office + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id648_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493047 + updated_at: 1719493047 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61b78a68186f43bafe8d + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493048 + updated_at: 1719493048 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '125' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493048 + updated_at: 1719493048 + author: + type: bot + id: '991267871' + name: Operator + email: >- + operator+this_is_an_id648_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + getTicket: + path: /tickets/{id} + method: GET + auth: true + docs: You can fetch the details of a single ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the ticket which is given by Intercom. + display-name: Retrieve a ticket + response: + docs: Ticket found + type: optional + errors: + - root.GetTicketRequestUnauthorizedError + examples: + - name: Ticket found + path-parameters: + id: id + response: + body: + type: ticket + id: '493' + ticket_id: '52' + category: Back-office + ticket_attributes: + _default_title_: attribute_value + _default_description_: ticket_attributes + ticket_state: submitted + ticket_type: + type: ticket_type + id: '112' + category: Back-office + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id660_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493060 + updated_at: 1719493060 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c48a68186f43bafe91 + external_id: 038050f6-d917-4b9d-89cb-539b1d371172 + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493061 + updated_at: 1719493061 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '134' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493061 + updated_at: 1719493061 + author: + type: admin + id: '991267912' + name: Ciaran445 Lee + email: admin445@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + updateTicket: + path: /tickets/{id} + method: PUT + auth: true + docs: You can update a ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the ticket which is given by Intercom + display-name: Update a ticket + request: + name: UpdateTicketRequest + body: + properties: + ticket_attributes: + type: optional> + docs: The attributes set on the ticket. + state: + type: optional + docs: The state of the ticket. + open: + type: optional + docs: >- + Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + is_shared: + type: optional + docs: Specify whether the ticket is visible to users. + snoozed_until: + type: optional + docs: The time you want the ticket to reopen. + assignment: + type: optional + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.UpdateTicketRequestUnauthorizedError + - root.UpdateTicketRequestNotFoundError + examples: + - name: Successful response + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + open: true + snoozed_until: 1673609604 + assignment: + admin_id: '991267883' + assignee_id: '991267885' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + - name: Admin not found + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991267893' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + - name: Assignee not found + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267899' + assignee_id: '456' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + searchTickets: + path: /tickets/search + method: POST + auth: true + docs: > + You can search for multiple tickets by the value of their attributes in + order to fetch exactly which ones you want. + + + To search for tickets, you send a `POST` request to + `https://api.intercom.io/tickets/search`. + + + This will accept a query object in the body which will define your + filters. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiples there can be: + + - There's a limit of max 2 nested filters + + - There's a limit of max 15 filters for each AND or OR group + + + ### Accepted Fields + + + Most keys listed as part of the Ticket model are searchable, whether + writeable or not. The value you search for has to match the accepted + type, otherwise the query will fail (ie. as `created_at` accepts a date, + the `value` cannot be a string such as `"foobar"`). + + + | Field | + Type + | + + | :---------------------------------------- | + :--------------------------------------------------------------------------------------- + | + + | id | + String + | + + | created_at | Date (UNIX + timestamp) + | + + | updated_at | Date (UNIX + timestamp) + | + + | _default_title_ | + String + | + + | _default_description_ | + String + | + + | category | + String + | + + | ticket_type_id | + String + | + + | contact_ids | + String + | + + | teammate_ids | + String + | + + | admin_assignee_id | + String + | + + | team_assignee_id | + String + | + + | open | + Boolean + | + + | state | + String + | + + | snoozed_until | Date (UNIX + timestamp) + | + + | ticket_attribute.{id} | String or Boolean or Date + (UNIX timestamp) or Float or Integer | + + + ### Accepted Operators + + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :----------------------------- | + :----------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In Shortcut for `OR` + queries Values most be in Array | + + | NIN | All | Not In Shortcut for `OR + !` queries Values must be in Array | + + | > | Integer Date (UNIX Timestamp) | Greater (or equal) + than | + + | < | Integer Date (UNIX Timestamp) | Lower (or equal) + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search tickets + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.TicketList + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: ticket.list + tickets: + - type: ticket + id: '494' + ticket_id: '53' + category: Back-office + ticket_attributes: + _default_title_: attribute_value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '117' + category: Back-office + name: my-ticket-type-26 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id667_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493065 + updated_at: 1719493065 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c98a68186f43bafe92 + external_id: 6895b33e-2768-4611-908e-da6632dfc8ea + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493065 + updated_at: 1719493066 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '135' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493066 + updated_at: 1719493066 + author: + type: admin + id: '991267940' + name: Ciaran472 Lee + email: admin472@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + total_count: 1 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 1 + source: + openapi: ../openapi.yml + display-name: Tickets +docs: Everything about your tickets +", + }, + "visitors.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Visitors", + "imports": { + "contacts": "contacts.yml", + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Visitors", + "endpoints": { + "convertVisitor": { + "auth": true, + "display-name": "Convert a visitor", + "docs": "You can merge a Visitor to a Contact of role type `lead` or `user`. + +> 📘 What happens upon a visitor being converted? +> +> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers. +", + "errors": [ + "root.ConvertVisitorRequestUnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "type": "user", + "user": { + "email": "foo@bar.com", + }, + "visitor": { + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + }, + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/companies", + }, + "created_at": 1719493072, + "custom_attributes": { + "key": "value", + }, + "email": "foo@bar.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d61d08a68186f43bafea2", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "John Doe", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719493072, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719493072, + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/visitors/convert", + "request": { + "body": { + "properties": { + "type": { + "docs": "Represents the role of the Contact model. Accepts `lead` or `user`.", + "type": "string", + }, + "user": "unknown", + "visitor": "unknown", + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "ConvertVisitorRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "contacts.Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveVisitorWithUserId": { + "auth": true, + "display-name": "Retrieve a visitor with User ID", + "docs": "You can fetch the details of a single visitor.", + "errors": [ + "root.RetrieveVisitorWithUserIdRequestUnauthorizedError", + "root.RetrieveVisitorWithUserIdRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "query-parameters": { + "user_id": "user_id", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id677_that_should_be_at_least_", + "avatar": { + "image_url": "https://example.com/avatar.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493070, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61ce8a68186f43bafe9b", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Jane Doe", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Red Duck from Dublin", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493070, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493070, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493070, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/visitors", + "request": { + "name": "RetrieveVisitorWithUserIdRequest", + "query-parameters": { + "user_id": { + "docs": "The user_id of the Visitor you want to retrieve.", + "type": "string", + }, + }, + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateVisitor": { + "auth": true, + "display-name": "Update a visitor", + "docs": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + +**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + +**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. +", + "errors": [ + "root.UpdateVisitorRequestUnauthorizedError", + "root.UpdateVisitorRequestNotFoundError", + ], + "examples": [ + { + "name": "successful", + "request": { + "id": "667d61cc8a68186f43bafe95", + "name": "Gareth Bale", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "avatar": { + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493068, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61cc8a68186f43bafe95", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Gareth Bale", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Indigo Ghost", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493068, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493068, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493068, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + { + "name": "visitor Not Found", + "request": { + "name": "Christian Fail", + "user_id": "fail", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "avatar": { + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493068, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61cc8a68186f43bafe95", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Gareth Bale", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Indigo Ghost", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493068, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493068, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493068, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/visitors", + "request": { + "body": "root.UpdateVisitorRequestOne", + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + contacts: contacts.yml +service: + auth: false + base-path: '' + endpoints: + retrieveVisitorWithUserId: + path: /visitors + method: GET + auth: true + docs: You can fetch the details of a single visitor. + source: + openapi: ../openapi.yml + display-name: Retrieve a visitor with User ID + request: + name: RetrieveVisitorWithUserIdRequest + query-parameters: + user_id: + type: string + docs: The user_id of the Visitor you want to retrieve. + response: + docs: successful + type: optional + errors: + - root.RetrieveVisitorWithUserIdRequestUnauthorizedError + - root.RetrieveVisitorWithUserIdRequestNotFoundError + examples: + - name: successful + query-parameters: + user_id: user_id + response: + body: + type: visitor + id: 667d61ce8a68186f43bafe9b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Jane Doe + pseudonym: Red Duck from Dublin + avatar: + type: avatar + image_url: https://example.com/avatar.png + app_id: this_is_an_id677_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493070 + remote_created_at: 1719493070 + signed_up_at: 1719493070 + updated_at: 1719493070 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + updateVisitor: + path: /visitors + method: PUT + auth: true + docs: > + Sending a PUT request to `/visitors` will result in an update of an + existing Visitor. + + + **Option 1.** You can update a visitor by passing in the `user_id` of + the visitor in the Request body. + + + **Option 2.** You can update a visitor by passing in the `id` of the + visitor in the Request body. + source: + openapi: ../openapi.yml + display-name: Update a visitor + request: + body: root.UpdateVisitorRequestOne + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.UpdateVisitorRequestUnauthorizedError + - root.UpdateVisitorRequestNotFoundError + examples: + - name: successful + request: + id: 667d61cc8a68186f43bafe95 + name: Gareth Bale + response: + body: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + - name: visitor Not Found + request: + user_id: fail + name: Christian Fail + response: + body: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + convertVisitor: + path: /visitors/convert + method: POST + auth: true + docs: > + You can merge a Visitor to a Contact of role type `lead` or `user`. + + + > 📘 What happens upon a visitor being converted? + + > + + > If the User exists, then the Visitor will be merged into it, the + Visitor deleted and the User returned. If the User does not exist, the + Visitor will be converted to a User, with the User identifiers replacing + it's Visitor identifiers. + source: + openapi: ../openapi.yml + display-name: Convert a visitor + request: + name: ConvertVisitorRequest + body: + properties: + type: + type: string + docs: >- + Represents the role of the Contact model. Accepts `lead` or + `user`. + user: unknown + visitor: unknown + content-type: application/json + response: + docs: successful + type: contacts.Contact + errors: + - root.ConvertVisitorRequestUnauthorizedError + examples: + - name: successful + request: + type: user + user: + email: foo@bar.com + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + response: + body: + type: contact + id: 667d61d08a68186f43bafea2 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: this_is_an_id683_that_should_be_at_least_ + role: user + email: foo@bar.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719493072 + updated_at: 1719493072 + signed_up_at: 1719493072 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d61d08a68186f43bafea2/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d61d08a68186f43bafea2/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d61d08a68186f43bafea2/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + source: + openapi: ../openapi.yml + display-name: Visitors +docs: Everything about your Visitors +", + }, + }, + "packageMarkers": {}, + "rootApiFile": { + "contents": { + "auth": "BearerAuthScheme", + "auth-schemes": { + "BearerAuthScheme": { + "scheme": "bearer", + }, + }, + "default-environment": "Default", + "display-name": "Intercom API", + "environments": { + "Default": "https://api.intercom.io", + }, + "error-discrimination": { + "strategy": "status-code", + }, + "headers": { + "Intercom-Version": { + "name": "intercomVersion", + "type": "optional", + }, + }, + "imports": { + "root": "__package__.yml", + }, + "name": "api", + }, + "defaultUrl": undefined, + "rawContents": "name: api +error-discrimination: + strategy: status-code +display-name: Intercom API +environments: + Default: https://api.intercom.io +default-environment: Default +imports: + root: __package__.yml +headers: + Intercom-Version: + type: optional + name: intercomVersion +auth-schemes: + BearerAuthScheme: + scheme: bearer +auth: BearerAuthScheme +", + }, +} \ No newline at end of file diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/only-include-referenced-schemas.json new file mode 100644 index 00000000000..e721eefc875 --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-ir/only-include-referenced-schemas.json @@ -0,0 +1,134685 @@ +{ + "title": "Intercom API", + "description": "The intercom API reference.", + "servers": [ + { + "url": "https://api.intercom.io", + "description": "The production API server" + }, + { + "url": "https://api.eu.intercom.io", + "description": "The european API server" + }, + { + "url": "https://api.au.intercom.io", + "description": "The australian API server" + } + ], + "tags": { + "tagsById": { + "Admins": { + "id": "Admins", + "description": "Everything about your Admins" + }, + "Articles": { + "id": "Articles", + "description": "Everything about your Articles" + }, + "Companies": { + "id": "Companies", + "description": "Everything about your Companies" + }, + "Contacts": { + "id": "Contacts", + "description": "Everything about your contacts" + }, + "Conversations": { + "id": "Conversations", + "description": "Everything about your Conversations" + }, + "Data Attributes": { + "id": "Data Attributes", + "description": "Everything about your Data Attributes" + }, + "Data Events": { + "id": "Data Events", + "description": "Everything about your Data Events" + }, + "Data Export": { + "id": "Data Export", + "description": "Everything about your Data Exports" + }, + "Help Center": { + "id": "Help Center", + "description": "Everything about your Help Center" + }, + "Messages": { + "id": "Messages", + "description": "Everything about your messages" + }, + "News": { + "id": "News", + "description": "Everything about your News" + }, + "Notes": { + "id": "Notes", + "description": "Everything about your Notes" + }, + "Segments": { + "id": "Segments", + "description": "Everything about your Segments" + }, + "Subscription Types": { + "id": "Subscription Types", + "description": "Everything about subscription types" + }, + "Switch": { + "id": "Switch", + "description": "Everything about Switch" + }, + "Tags": { + "id": "Tags", + "description": "Everything about tags" + }, + "Teams": { + "id": "Teams", + "description": "Everything about your Teams" + }, + "Ticket Type Attributes": { + "id": "Ticket Type Attributes", + "description": "Everything about your ticket type attributes" + }, + "Ticket Types": { + "id": "Ticket Types", + "description": "Everything about your ticket types" + }, + "Tickets": { + "id": "Tickets", + "description": "Everything about your tickets" + }, + "Visitors": { + "id": "Visitors", + "description": "Everything about your Visitors" + } + }, + "orderedTagIds": [ + "Admins", + "Articles", + "Companies", + "Contacts", + "Conversations", + "Data Attributes", + "Data Events", + "Data Export", + "Help Center", + "Messages", + "News", + "Notes", + "Segments", + "Subscription Types", + "Switch", + "Tags", + "Teams", + "Ticket Type Attributes", + "Ticket Types", + "Tickets", + "Visitors" + ] + }, + "hasEndpointsMarkedInternal": false, + "endpoints": [ + { + "summary": "Identify an admin", + "audiences": [], + "operationId": "identifyAdmin", + "tags": [ + "Admins" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "IdentifyAdminRequestIntercomVersion", + "value": { + "generatedName": "IdentifyAdminRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "IdentifyAdminRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "IdentifyAdminResponse", + "schema": "admin_with_app", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "admin", + "id": "991267390", + "email": "admin1@email.com", + "name": "Ciaran1 Lee", + "email_verified": true, + "app": { + "type": "app", + "id_code": "this_is_an_id1_that_should_be_at_least_40", + "name": "MyApp 1", + "created_at": 1719492696, + "secure": false, + "identity_verification": false, + "timezone": "America/Los_Angeles", + "region": "US" + }, + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png" + }, + "has_inbox_seat": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "\nYou can view the currently authorised admin along with the embedded app object (a \"workspace\" in legacy terminology).\n\n> 🚧 Single Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.\n", + "authed": true, + "method": "GET", + "path": "/me", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267390", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran1 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin1@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://static.intercomassets.com/assets/default-avatars/admins/128.png", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "email_verified": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "app": { + "properties": { + "type": { + "value": { + "value": "app", + "type": "string" + }, + "type": "primitive" + }, + "id_code": { + "value": { + "value": "this_is_an_id1_that_should_be_at_least_40", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "MyApp 1", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "US", + "type": "string" + }, + "type": "primitive" + }, + "timezone": { + "value": { + "value": "America/Los_Angeles", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492696, + "type": "int" + }, + "type": "primitive" + }, + "identity_verification": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Set an admin to away", + "audiences": [], + "operationId": "setAwayAdmin", + "tags": [ + "Admins" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given admin", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "SetAwayAdminRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "SetAwayAdminRequestIntercomVersion", + "value": { + "generatedName": "SetAwayAdminRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "SetAwayAdminRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "setAwayAdminRequestAwayModeEnabled", + "key": "away_mode_enabled", + "schema": { + "description": "Set to \"true\" to change the status of the admin to away.", + "schema": { + "default": true, + "example": true, + "type": "boolean" + }, + "generatedName": "SetAwayAdminRequestAwayModeEnabled", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "setAwayAdminRequestAwayModeReassign", + "key": "away_mode_reassign", + "schema": { + "description": "Set to \"true\" to assign any new conversation replies to your default inbox.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "SetAwayAdminRequestAwayModeReassign", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "SetAwayAdminRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful response", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + { + "name": "Admin not found", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + }, + { + "name": "Unauthorized", + "value": { + "away_mode_enabled": true, + "away_mode_reassign": true + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful response", + "schema": { + "generatedName": "SetAwayAdminResponse", + "schema": "admin", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "admin", + "id": "991267391", + "name": "Ciaran2 Lee", + "email": "admin2@email.com", + "away_mode_enabled": true, + "away_mode_reassign": true, + "has_inbox_seat": true, + "team_ids": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "18722269-a019-46c4-87d7-50d0f6f8a990", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Admin not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Admin not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9818bd03-9cc6-4ab8-8e7c-20a45ac58e97", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "admin_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Admin for admin_id not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can set an Admin as away for the Inbox.", + "authed": true, + "method": "PUT", + "path": "/admins/{id}/away", + "examples": [ + { + "name": "Successful response", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267391", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran2 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin2@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267391", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran2 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin2@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Unauthorized", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267391", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran2 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin2@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all activity logs", + "audiences": [], + "operationId": "listActivityLogs", + "tags": [ + "Admins" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "The start date that you request data for. It must be formatted as a UNIX timestamp.", + "name": "created_at_after", + "schema": { + "schema": { + "example": "1677253093", + "type": "string" + }, + "generatedName": "ListActivityLogsRequestCreatedAtAfter", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The end date that you request data for. It must be formatted as a UNIX timestamp.", + "name": "created_at_before", + "schema": { + "generatedName": "ListActivityLogsRequestCreatedAtBefore", + "value": { + "schema": { + "example": "1677861493", + "type": "string" + }, + "generatedName": "ListActivityLogsRequestCreatedAtBefore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListActivityLogsRequestIntercomVersion", + "value": { + "generatedName": "ListActivityLogsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListActivityLogsRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "ListActivityLogsResponse", + "schema": "activity_log_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "activity_log.list", + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "activity_logs": [ + { + "id": "ddee3a18-0032-4061-b9b9-26230c3dd5f7", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "message": { + "id": 123, + "title": "Initial message title" + }, + "before": "Initial message title", + "after": "Eventual message title" + }, + "created_at": 1719492702, + "activity_type": "message_state_change", + "activity_description": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title." + }, + { + "id": "5eec951b-db7a-4b5b-add5-95ffc90969b6", + "performed_by": { + "type": "admin", + "id": "991267395", + "email": "admin5@email.com", + "ip": "127.0.0.1" + }, + "metadata": { + "before": "before", + "after": "after" + }, + "created_at": 1719492702, + "activity_type": "app_name_change", + "activity_description": "Ciaran5 Lee changed your app name from before to after." + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "06d9eefd-2b3a-48f7-938a-5a10383a4ebf", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can get a log of activities by all admins in an app.", + "authed": true, + "method": "GET", + "path": "/admins/activity_logs", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [ + { + "name": "created_at_after", + "value": { + "value": { + "value": "1677253093", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "created_at_before", + "value": { + "value": { + "value": "1677861493", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "activity_log.list", + "type": "string" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 20, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "activity_logs": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "ddee3a18-0032-4061-b9b9-26230c3dd5f7", + "type": "string" + }, + "type": "primitive" + }, + "performed_by": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267395", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin5@email.com", + "type": "string" + }, + "type": "primitive" + }, + "ip": { + "value": { + "value": "127.0.0.1", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "created_at": { + "value": { + "value": 1719492702, + "type": "int" + }, + "type": "primitive" + }, + "activity_type": { + "value": "message_state_change", + "type": "enum" + }, + "activity_description": { + "value": { + "value": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title.", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "id": { + "value": { + "value": "5eec951b-db7a-4b5b-add5-95ffc90969b6", + "type": "string" + }, + "type": "primitive" + }, + "performed_by": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267395", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin5@email.com", + "type": "string" + }, + "type": "primitive" + }, + "ip": { + "value": { + "value": "127.0.0.1", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "created_at": { + "value": { + "value": 1719492702, + "type": "int" + }, + "type": "primitive" + }, + "activity_type": { + "value": "app_name_change", + "type": "enum" + }, + "activity_description": { + "value": { + "value": "Ciaran5 Lee changed your app name from before to after.", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all admins", + "audiences": [], + "operationId": "listAdmins", + "tags": [ + "Admins" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListAdminsRequestIntercomVersion", + "value": { + "generatedName": "ListAdminsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListAdminsRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "ListAdminsResponse", + "schema": "admin_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "admin.list", + "admins": [ + { + "type": "admin", + "email": "admin7@email.com", + "id": "991267397", + "name": "Ciaran7 Lee", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "4ba8121e-4a4a-4668-adb2-363c561f3c52", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of admins for a given workspace.", + "authed": true, + "method": "GET", + "path": "/admins", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "admins": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267397", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran7 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin7@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve an admin", + "audiences": [], + "operationId": "retrieveAdmin", + "tags": [ + "Admins" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given admin", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveAdminRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveAdminRequestIntercomVersion", + "value": { + "generatedName": "RetrieveAdminRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveAdminRequest", + "response": { + "description": "Admin found", + "schema": { + "generatedName": "RetrieveAdminResponse", + "schema": "admin", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Admin found", + "value": { + "type": "admin", + "id": "991267399", + "name": "Ciaran9 Lee", + "email": "admin9@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false, + "has_inbox_seat": true, + "team_ids": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "83978032-1473-4696-b755-b497d46a23cf", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Admin not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Admin not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "989bdb0b-1e8c-46cc-8953-9733dad40562", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "admin_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Admin not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can retrieve the details of a single admin.", + "authed": true, + "method": "GET", + "path": "/admins/{id}", + "examples": [ + { + "name": "Admin found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267399", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran9 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin9@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all articles", + "audiences": [], + "operationId": "listArticles", + "tags": [ + "Articles" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListArticlesRequestIntercomVersion", + "value": { + "generatedName": "ListArticlesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListArticlesRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListArticlesResponse", + "schema": "article_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 25, + "total_pages": 1 + }, + "total_count": 1, + "data": [ + { + "id": "39", + "type": "article", + "workspace_id": "this_is_an_id33_that_should_be_at_least_4", + "parent_id": 143, + "parent_type": "collection", + "parent_ids": [], + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267402, + "state": "published", + "created_at": 1719492707, + "updated_at": 1719492707, + "url": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "86d69044-5966-428e-9a40-2b39fba3f823", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.\n\n> 📘 How are the articles sorted and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.\n", + "authed": true, + "method": "GET", + "path": "/articles", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 25, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "39", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id33_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "This is the article title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267402, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492707, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492707, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 143, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create an article", + "audiences": [], + "operationId": "createArticle", + "tags": [ + "Articles" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateArticleRequestIntercomVersion", + "value": { + "generatedName": "CreateArticleRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateArticleRequest", + "request": { + "schema": { + "generatedName": "CreateArticleRequestBody", + "schema": "create_article_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "article created", + "value": { + "title": "Thanks for everything", + "description": "Description of the Article", + "body": "Body of the Article", + "author_id": 991267407, + "state": "published", + "parent_id": 145, + "parent_type": "collection", + "translated_content": { + "fr": { + "title": "Merci pour tout", + "description": "Description de l'article", + "body": "Corps de l'article", + "author_id": 991267407, + "state": "published" + } + } + } + }, + { + "name": "Bad Request", + "value": { + "title": "Thanks for everything", + "description": "Description of the Article", + "body": "Body of the Article", + "state": "published" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "article created", + "schema": { + "generatedName": "CreateArticleResponse", + "schema": "article", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "article created", + "value": { + "id": "42", + "type": "article", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + "parent_id": 145, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Thanks for everything", + "description": "Description of the Article", + "body": "

Body of the Article

", + "author_id": 991267407, + "state": "published", + "created_at": 1719492710, + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Bad Request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Bad Request", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "author_id must be in the main body or default locale translated_content object", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f223a1d9-5377-4337-92bb-00fb39157f11", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "authed": true, + "method": "POST", + "path": "/articles", + "examples": [ + { + "name": "article created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Description of the Article", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Body of the Article", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267407, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "parent_id": { + "value": { + "value": 145, + "type": "int" + }, + "type": "primitive" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "fr": { + "properties": { + "title": { + "value": { + "value": "Merci pour tout", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Description de l'article", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Corps de l'article", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267407, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "42", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id37_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Description of the Article", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Body of the Article

", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267407, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492710, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492710, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 145, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "article_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "article_statistics", + "type": "string" + }, + "type": "literal" + }, + "views": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "conversions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "happy_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "neutral_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "sad_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Bad Request", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Description of the Article", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Body of the Article", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1295, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "42", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id37_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Description of the Article", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Body of the Article

", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267407, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492710, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492710, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 145, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "article_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "article_statistics", + "type": "string" + }, + "type": "literal" + }, + "views": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "conversions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "happy_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "neutral_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "sad_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve an article", + "audiences": [], + "operationId": "retrieveArticle", + "tags": [ + "Articles" + ], + "pathParameters": [ + { + "description": "The unique identifier for the article which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveArticleRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveArticleRequestIntercomVersion", + "value": { + "generatedName": "RetrieveArticleRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveArticleRequest", + "response": { + "description": "Article found", + "schema": { + "generatedName": "RetrieveArticleResponse", + "schema": "article", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Article found", + "value": { + "id": "45", + "type": "article", + "workspace_id": "this_is_an_id43_that_should_be_at_least_4", + "parent_id": 148, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "This is the article title", + "description": "", + "body": "", + "author_id": 991267412, + "state": "published", + "created_at": 1719492712, + "updated_at": 1719492712, + "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "62ab4791-7e4d-4400-a56b-b06a0ce3ba1a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Article not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Article not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "99c73902-e8ea-4872-b412-1d55ce4582fb", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "authed": true, + "method": "GET", + "path": "/articles/{id}", + "examples": [ + { + "name": "Article found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "45", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id43_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "This is the article title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267412, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492712, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492712, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 148, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "article_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "article_statistics", + "type": "string" + }, + "type": "literal" + }, + "views": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "conversions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "happy_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "neutral_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "sad_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update an article", + "audiences": [], + "operationId": "updateArticle", + "tags": [ + "Articles" + ], + "pathParameters": [ + { + "description": "The unique identifier for the article which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "UpdateArticleRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateArticleRequestIntercomVersion", + "value": { + "generatedName": "UpdateArticleRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateArticleRequest", + "request": { + "schema": { + "generatedName": "UpdateArticleRequestBody", + "schema": "update_article_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

" + } + }, + { + "name": "Article Not Found", + "value": { + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "UpdateArticleResponse", + "schema": "article", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "48", + "type": "article", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + "parent_id": 151, + "parent_type": "collection", + "parent_ids": [], + "statistics": { + "type": "article_statistics", + "views": 0, + "conversations": 0, + "reactions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "sad_reaction_percentage": 0 + }, + "title": "Christmas is here!", + "description": "", + "body": "

New gifts in store for the jolly season

", + "author_id": 991267418, + "state": "published", + "created_at": 1719492714, + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "15b4f214-c670-43d7-ad8f-648791fddf9b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Article Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Article Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "891b6ff4-181f-4b98-861b-d34ef16bfc4b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "authed": true, + "method": "PUT", + "path": "/articles/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "48", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id49_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267418, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492714, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492714, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 151, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "article_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "article_statistics", + "type": "string" + }, + "type": "literal" + }, + "views": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "conversions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "happy_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "neutral_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "sad_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Article Not Found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "48", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id49_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267418, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492714, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492714, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": 151, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "parent_type": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "article_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "article_content", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "How to create a new article", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "This article will show you how to create a new article.", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "This is the body of the article.", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "published", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "article_statistics", + "type": "string" + }, + "type": "literal" + }, + "views": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "conversions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "happy_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "neutral_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + }, + "sad_reaction_percentage": { + "value": { + "value": 0, + "type": "float" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete an article", + "audiences": [], + "operationId": "deleteArticle", + "tags": [ + "Articles" + ], + "pathParameters": [ + { + "description": "The unique identifier for the article which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "DeleteArticleRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteArticleRequestIntercomVersion", + "value": { + "generatedName": "DeleteArticleRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteArticleRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "DeleteArticleResponse", + "schema": "deleted_article_object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "51", + "object": "article", + "deleted": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "85d43c53-f28f-4295-b937-9a43ea71d0c3", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Article Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Article Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "60da5f23-613c-4f84-84bd-e9dbd3d67187", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "authed": true, + "method": "DELETE", + "path": "/articles/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "51", + "type": "string" + }, + "type": "primitive" + }, + "object": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "deleted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Search for articles", + "audiences": [], + "operationId": "searchArticles", + "tags": [ + "Articles" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "The phrase within your articles to search for.", + "name": "phrase", + "schema": { + "generatedName": "SearchArticlesRequestPhrase", + "value": { + "schema": { + "example": "Getting started", + "type": "string" + }, + "generatedName": "SearchArticlesRequestPhrase", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The state of the Articles returned. One of `published`, `draft` or `all`.", + "name": "state", + "schema": { + "generatedName": "SearchArticlesRequestState", + "value": { + "schema": { + "example": "published", + "type": "string" + }, + "generatedName": "SearchArticlesRequestState", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The ID of the Help Center to search in.", + "name": "help_center_id", + "schema": { + "generatedName": "SearchArticlesRequestHelpCenterId", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "SearchArticlesRequestHelpCenterId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.", + "name": "highlight", + "schema": { + "generatedName": "SearchArticlesRequestHighlight", + "value": { + "schema": { + "type": "boolean" + }, + "generatedName": "SearchArticlesRequestHighlight", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "SearchArticlesRequestIntercomVersion", + "value": { + "generatedName": "SearchArticlesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "SearchArticlesRequest", + "response": { + "description": "Search successful", + "schema": { + "generatedName": "SearchArticlesResponse", + "schema": "article_search_response", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Search successful", + "value": { + "type": "list", + "total_count": 1, + "data": { + "articles": [ + { + "id": "55", + "type": "article", + "workspace_id": "this_is_an_id61_that_should_be_at_least_4", + "parent_id": null, + "parent_type": null, + "parent_ids": [], + "title": "Title 1", + "description": "", + "body": "", + "author_id": 991267431, + "state": "draft", + "created_at": 1719492719, + "updated_at": 1719492719, + "url": null + } + ], + "highlights": [] + }, + "pages": { + "type": "pages", + "page": 1, + "total_pages": 1, + "per_page": 10 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "626c6766-ee1a-489d-b87a-230d9b980c7d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "authed": true, + "method": "GET", + "path": "/articles/search", + "examples": [ + { + "name": "Search successful", + "pathParameters": [], + "queryParameters": [ + { + "name": "phrase", + "value": { + "value": { + "value": "Getting started", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "state", + "value": { + "value": { + "value": "published", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "properties": { + "articles": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "article", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "55", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id61_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Title 1", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "author_id": { + "value": { + "value": 991267431, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "draft", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492719, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492719, + "type": "int" + }, + "type": "primitive" + }, + "parent_ids": { + "value": [ + { + "value": { + "value": 18, + "type": "int" + }, + "type": "primitive" + }, + { + "value": { + "value": 19, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "highlights": { + "value": [ + { + "properties": { + "article_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 10, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all collections", + "audiences": [], + "operationId": "listAllCollections", + "tags": [ + "Help Center" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListAllCollectionsRequestIntercomVersion", + "value": { + "generatedName": "ListAllCollectionsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListAllCollectionsRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListAllCollectionsResponse", + "schema": "collection_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "id": "159", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-65/collection-17", + "order": 17, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 79 + }, + { + "id": "160", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + "name": "English section title", + "url": "http://help-center.test/myapp-65/section-1", + "order": 1, + "created_at": 1719492720, + "updated_at": 1719492720, + "description": null, + "icon": "bookmark", + "parent_id": "159", + "help_center_id": null + } + ], + "total_count": 2, + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "ccedcb48-7d08-4cc9-bcff-0622f70daf74", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.\n\nCollections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.\n", + "authed": true, + "method": "GET", + "path": "/help_center/collections", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 20, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "159", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id65_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "English collection title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "english collection description", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492720, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492720, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-65/collection-17", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "bookmark", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 17, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 79, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "id": { + "value": { + "value": "160", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id65_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "English section title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Default language description", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492720, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492720, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-65/section-1", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "bookmark", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "parent_id": { + "value": { + "value": "159", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a collection", + "audiences": [], + "operationId": "createCollection", + "tags": [ + "Help Center" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateCollectionRequestIntercomVersion", + "value": { + "generatedName": "CreateCollectionRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateCollectionRequest", + "request": { + "schema": { + "generatedName": "CreateCollectionRequestBody", + "schema": "create_collection_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "collection created", + "value": { + "name": "Thanks for everything" + } + }, + { + "name": "Bad Request", + "value": { + "description": "Missing required parameter" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "collection created", + "schema": { + "generatedName": "CreateCollectionResponse", + "schema": "collection", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "collection created", + "value": { + "id": "165", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + "name": "Thanks for everything", + "url": "http://help-center.test/myapp-69/", + "order": 1, + "created_at": 1719492721, + "updated_at": 1719492721, + "description": "", + "icon": "book-bookmark", + "parent_id": null, + "help_center_id": 81 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Bad Request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Bad Request", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1f4fd741-8681-4c21-911a-47d7bb39d080", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Name is a required parameter.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "authed": true, + "method": "POST", + "path": "/help_center/collections", + "examples": [ + { + "name": "collection created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "165", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id69_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492721, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492721, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-69/", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "book-bookmark", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "group_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 81, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Bad Request", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "collection 51", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Missing required parameter", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "165", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id69_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Thanks for everything", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492721, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492721, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-69/", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "book-bookmark", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "group_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 81, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a collection", + "audiences": [], + "operationId": "retrieveCollection", + "tags": [ + "Help Center" + ], + "pathParameters": [ + { + "description": "The unique identifier for the collection which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveCollectionRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveCollectionRequestIntercomVersion", + "value": { + "generatedName": "RetrieveCollectionRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveCollectionRequest", + "response": { + "description": "Collection found", + "schema": { + "generatedName": "RetrieveCollectionResponse", + "schema": "collection", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Collection found", + "value": { + "id": "170", + "workspace_id": "this_is_an_id75_that_should_be_at_least_4", + "name": "English collection title", + "url": "http://help-center.test/myapp-75/collection-22", + "order": 22, + "created_at": 1719492723, + "updated_at": 1719492723, + "description": "english collection description", + "icon": "bookmark", + "parent_id": null, + "help_center_id": 84 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "bf1acd76-8c6e-45f4-8dbe-54391843270a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Collection not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Collection not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2970f0f3-7020-4382-8892-eac24818ca88", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "authed": true, + "method": "GET", + "path": "/help_center/collections/{id}", + "examples": [ + { + "name": "Collection found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "170", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id75_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "English collection title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "english collection description", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492723, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492723, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-75/collection-22", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "bookmark", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 22, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "group_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 84, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a collection", + "audiences": [], + "operationId": "updateCollection", + "tags": [ + "Help Center" + ], + "pathParameters": [ + { + "description": "The unique identifier for the collection which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "UpdateCollectionRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateCollectionRequestIntercomVersion", + "value": { + "generatedName": "UpdateCollectionRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateCollectionRequest", + "request": { + "schema": { + "generatedName": "UpdateCollectionRequestBody", + "schema": "update_collection_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "name": "Update collection name" + } + }, + { + "name": "Collection Not Found", + "value": { + "name": "Update collection name" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "UpdateCollectionResponse", + "schema": "collection", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "176", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + "name": "Update collection name", + "url": "http://help-center.test/myapp-81/collection-25", + "order": 25, + "created_at": 1719492724, + "updated_at": 1719492724, + "description": "english collection description", + "icon": "folder", + "parent_id": null, + "help_center_id": 87 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "67002700-07f8-4a56-a9bc-464254c3a5bd", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Collection Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Collection Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "35e7f185-f547-4ae1-a23d-afc9027fc5a6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "authed": true, + "method": "PUT", + "path": "/help_center/collections/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Update collection name", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "176", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id81_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Update collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "english collection description", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492724, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492724, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-81/collection-25", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "folder", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 25, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "group_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 87, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Collection Not Found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Update collection name", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "176", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id81_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Update collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "english collection description", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492724, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492724, + "type": "int" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://help-center.test/myapp-81/collection-25", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "folder", + "type": "string" + }, + "type": "primitive" + }, + "order": { + "value": { + "value": 25, + "type": "int" + }, + "type": "primitive" + }, + "default_locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "translated_content": { + "properties": { + "type": { + "value": { + "value": "group_translated_content", + "type": "string" + }, + "type": "primitive" + }, + "ar": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bg": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "bs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ca": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "cs": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "da": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "de": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "el": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "en": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "es": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "et": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "fr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "he": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "hu": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "id": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "it": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ja": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ko": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "lv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "mn": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nb": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "nl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ro": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "ru": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sl": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sv": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tr": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "vi": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "pt-BR": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-CN": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "zh-TW": { + "properties": { + "type": { + "value": { + "value": "group_content", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Collection name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": " Collection description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "parent_id": { + "value": { + "value": "6871118", + "type": "string" + }, + "type": "primitive" + }, + "help_center_id": { + "value": { + "value": 87, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete a collection", + "audiences": [], + "operationId": "deleteCollection", + "tags": [ + "Help Center" + ], + "pathParameters": [ + { + "description": "The unique identifier for the collection which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "DeleteCollectionRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteCollectionRequestIntercomVersion", + "value": { + "generatedName": "DeleteCollectionRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteCollectionRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "DeleteCollectionResponse", + "schema": "deleted_collection_object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "182", + "object": "collection", + "deleted": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "collection Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "collection Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a35712b4-90b6-47fb-843d-757d9fdd81e6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "authed": true, + "method": "DELETE", + "path": "/help_center/collections/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "182", + "type": "string" + }, + "type": "primitive" + }, + "object": { + "value": { + "value": "collection", + "type": "string" + }, + "type": "literal" + }, + "deleted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a Help Center", + "audiences": [], + "operationId": "retrieveHelpCenter", + "tags": [ + "Help Center" + ], + "pathParameters": [ + { + "description": "The unique identifier for the collection which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveHelpCenterRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveHelpCenterRequestIntercomVersion", + "value": { + "generatedName": "RetrieveHelpCenterRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveHelpCenterRequest", + "response": { + "description": "Collection found", + "schema": { + "generatedName": "RetrieveHelpCenterResponse", + "schema": "help_center", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Collection found", + "value": { + "id": "93", + "workspace_id": "this_is_an_id93_that_should_be_at_least_4", + "created_at": 1719492727, + "updated_at": 1719492727, + "identifier": "help-center-1", + "website_turned_on": false, + "display_name": "Intercom Help Center" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "794a475b-0155-40b2-a288-ba0d48fdbd3f", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Collection not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Collection not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c6e7d3f6-8a46-460e-8264-e07c2e7302aa", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "authed": true, + "method": "GET", + "path": "/help_center/help_centers/{id}", + "examples": [ + { + "name": "Collection found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "93", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id93_that_should_be_at_least_4", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492727, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492727, + "type": "int" + }, + "type": "primitive" + }, + "identifier": { + "value": { + "value": "help-center-1", + "type": "string" + }, + "type": "primitive" + }, + "website_turned_on": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "display_name": { + "value": { + "value": "Intercom Help Center", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all Help Centers", + "audiences": [], + "operationId": "listHelpCenters", + "tags": [ + "Help Center" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListHelpCentersRequestIntercomVersion", + "value": { + "generatedName": "ListHelpCentersRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListHelpCentersRequest", + "response": { + "description": "Help Centers found", + "schema": { + "generatedName": "ListHelpCentersResponse", + "schema": "help_center_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Help Centers found", + "value": { + "type": "list", + "data": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c96a4779-a06d-45bb-aa39-eb96c587c2c7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "authed": true, + "method": "GET", + "path": "/help_center/help_centers", + "examples": [ + { + "name": "Help Centers found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "hfi1bx4l", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1672928359, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1672928610, + "type": "int" + }, + "type": "primitive" + }, + "identifier": { + "value": { + "value": "intercom", + "type": "string" + }, + "type": "primitive" + }, + "website_turned_on": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "display_name": { + "value": { + "value": "Intercom Help Center", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve companies", + "audiences": [], + "operationId": "retrieveCompany", + "tags": [ + "Companies" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "The `name` of the company to filter by.", + "name": "name", + "schema": { + "generatedName": "RetrieveCompanyRequestName", + "value": { + "schema": { + "example": "my company", + "type": "string" + }, + "generatedName": "RetrieveCompanyRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The `company_id` of the company to filter by.", + "name": "company_id", + "schema": { + "generatedName": "RetrieveCompanyRequestCompanyId", + "value": { + "schema": { + "example": "12345", + "type": "string" + }, + "generatedName": "RetrieveCompanyRequestCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The `tag_id` of the company to filter by.", + "name": "tag_id", + "schema": { + "generatedName": "RetrieveCompanyRequestTagId", + "value": { + "schema": { + "example": "678910", + "type": "string" + }, + "generatedName": "RetrieveCompanyRequestTagId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The `segment_id` of the company to filter by.", + "name": "segment_id", + "schema": { + "generatedName": "RetrieveCompanyRequestSegmentId", + "value": { + "schema": { + "example": "98765", + "type": "string" + }, + "generatedName": "RetrieveCompanyRequestSegmentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The page of results to fetch. Defaults to first page", + "name": "page", + "schema": { + "generatedName": "RetrieveCompanyRequestPage", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveCompanyRequestPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "How many results to display per page. Defaults to 15", + "name": "per_page", + "schema": { + "generatedName": "RetrieveCompanyRequestPerPage", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveCompanyRequestPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveCompanyRequestIntercomVersion", + "value": { + "generatedName": "RetrieveCompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveCompanyRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "RetrieveCompanyResponse", + "schema": "company_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d607e8a68186f43bafd26", + "app_id": "this_is_an_id122_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492734, + "created_at": 1719492734, + "updated_at": 1719492734, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c97dd75f-a434-4c83-a8e8-c4d1887d6c48", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a single company by passing in `company_id` or `name`.\n\n `https://api.intercom.io/companies?name={name}`\n\n `https://api.intercom.io/companies?company_id={company_id}`\n\nYou can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter.\n\n `https://api.intercom.io/companies?tag_id={tag_id}`\n\n `https://api.intercom.io/companies?segment_id={segment_id}`\n", + "authed": true, + "method": "GET", + "path": "/companies", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [ + { + "name": "name", + "value": { + "value": { + "value": "my company", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "company_id", + "value": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "tag_id", + "value": { + "value": { + "value": "678910", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "segment_id", + "value": { + "value": { + "value": "98765", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 15, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d607e8a68186f43bafd26", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "IntercomQATest1", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id122_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "remote_companies_scroll_2", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492734, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492734, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492734, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create or Update a company", + "audiences": [], + "operationId": "createOrUpdateCompany", + "tags": [ + "Companies" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateOrUpdateCompanyRequestIntercomVersion", + "value": { + "generatedName": "CreateOrUpdateCompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateOrUpdateCompanyRequest", + "request": { + "schema": { + "generatedName": "CreateOrUpdateCompanyRequestBody", + "schema": "create_or_update_company_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful", + "value": { + "company_id": "company_remote_id", + "name": "my company", + "remote_created_at": 1374138000 + } + }, + { + "name": "Bad Request", + "value": { + "test": "invalid" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful", + "schema": { + "generatedName": "CreateOrUpdateCompanyResponse", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "company", + "company_id": "company_remote_id", + "id": "667d607c8a68186f43bafd1e", + "app_id": "this_is_an_id116_that_should_be_at_least_", + "name": "my company", + "remote_created_at": 1374138000, + "created_at": 1719492732, + "updated_at": 1719492732, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": { + "creation_source": "api" + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Bad Request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Bad Request", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "bad_request", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "bad 'test' parameter", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9b0d6fb9-d2d7-4904-a13c-97557a802323", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create or update a company.\n\nCompanies will be only visible in Intercom when there is at least one associated user.\n\nCompanies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company.\n{% /admonition %}\n", + "authed": true, + "method": "POST", + "path": "/companies", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "my company", + "type": "string" + }, + "type": "primitive" + }, + "company_id": { + "value": { + "value": "company_remote_id", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1374138000, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d607c8a68186f43bafd1e", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "my company", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id116_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "company_remote_id", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1374138000, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492732, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492732, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "creation_source", + "type": "string" + }, + "value": { + "value": { + "value": "api", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a company by ID", + "audiences": [], + "operationId": "RetrieveACompanyById", + "tags": [ + "Companies" + ], + "pathParameters": [ + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "generatedName": "RetrieveACompanyByIdRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveACompanyByIdRequestIntercomVersion", + "value": { + "generatedName": "RetrieveACompanyByIdRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveACompanyByIdRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "RetrieveACompanyByIdResponse", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60808a68186f43bafd31", + "app_id": "this_is_an_id128_that_should_be_at_least_", + "name": "company1", + "remote_created_at": 1719492736, + "created_at": 1719492736, + "updated_at": 1719492736, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b49593ed-49a6-4497-8fb7-220ff74527f6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a single company.", + "authed": true, + "method": "GET", + "path": "/companies/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60808a68186f43bafd31", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company1", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id128_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492736, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492736, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492736, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a company", + "audiences": [], + "operationId": "UpdateCompany", + "tags": [ + "Companies" + ], + "pathParameters": [ + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "generatedName": "UpdateCompanyRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateCompanyRequestIntercomVersion", + "value": { + "generatedName": "UpdateCompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateCompanyRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "UpdateCompanyResponse", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60828a68186f43bafd3b", + "app_id": "this_is_an_id134_that_should_be_at_least_", + "name": "company2", + "remote_created_at": 1719492738, + "created_at": 1719492738, + "updated_at": 1719492738, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3f26a216-ddff-4782-9529-514f5bad56ea", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b1ce72df-630f-4925-b212-fca6e833eb8d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update a single company using the Intercom provisioned `id`.\n\n{% admonition type=\"attention\" name=\"Using `company_id`\" %}\n When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company.\n{% /admonition %}\n", + "authed": true, + "method": "PUT", + "path": "/companies/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60828a68186f43bafd3b", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company2", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id134_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492738, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492738, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492738, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete a company", + "audiences": [], + "operationId": "deleteCompany", + "tags": [ + "Companies" + ], + "pathParameters": [ + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "generatedName": "DeleteCompanyRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteCompanyRequestIntercomVersion", + "value": { + "generatedName": "DeleteCompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteCompanyRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "DeleteCompanyResponse", + "schema": "deleted_company_object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "id": "667d60848a68186f43bafd45", + "object": "company", + "deleted": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0a1a5065-69fe-47a4-9804-4cb2347671ef", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "35a9b551-331e-499e-a63f-20396bfd29f5", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete a single company.", + "authed": true, + "method": "DELETE", + "path": "/companies/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "667d60848a68186f43bafd45", + "type": "string" + }, + "type": "primitive" + }, + "object": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "deleted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List attached contacts", + "audiences": [], + "operationId": "ListAttachedContacts", + "tags": [ + "Companies", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "generatedName": "ListAttachedContactsRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListAttachedContactsRequestIntercomVersion", + "value": { + "generatedName": "ListAttachedContactsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListAttachedContactsRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListAttachedContactsResponse", + "schema": "company_attached_contacts", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 50, + "total_pages": 0 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fe20b681-f988-4154-bec9-a5087fe0842e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a6381081-a166-4e8e-952d-38bb2cd1c2b4", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all contacts that belong to a company.", + "authed": true, + "method": "GET", + "path": "/companies/{id}/contacts", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@example.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John Doe", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 50, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List attached segments for companies", + "audiences": [], + "operationId": "ListAttachedSegmentsForCompanies", + "tags": [ + "Companies" + ], + "pathParameters": [ + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "generatedName": "ListAttachedSegmentsForCompaniesRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListAttachedSegmentsForCompaniesRequestIntercomVersion", + "value": { + "generatedName": "ListAttachedSegmentsForCompaniesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListAttachedSegmentsForCompaniesRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListAttachedSegmentsForCompaniesResponse", + "schema": "company_attached_segments", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "66fcc654-48ed-4f53-824e-831b5c96c9dc", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "22add598-fd33-4c34-971f-cf215117aab3", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all segments that belong to a company.", + "authed": true, + "method": "GET", + "path": "/companies/{id}/segments", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + }, + "person_type": { + "value": "contact", + "type": "enum" + }, + "count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all companies", + "audiences": [], + "operationId": "listAllCompanies", + "tags": [ + "Companies" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "The page of results to fetch. Defaults to first page", + "name": "page", + "schema": { + "generatedName": "ListAllCompaniesRequestPage", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "ListAllCompaniesRequestPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "How many results to return per page. Defaults to 15", + "name": "per_page", + "schema": { + "generatedName": "ListAllCompaniesRequestPerPage", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "ListAllCompaniesRequestPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc", + "name": "order", + "schema": { + "generatedName": "ListAllCompaniesRequestOrder", + "value": { + "schema": { + "example": "desc", + "type": "string" + }, + "generatedName": "ListAllCompaniesRequestOrder", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListAllCompaniesRequestIntercomVersion", + "value": { + "generatedName": "ListAllCompaniesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListAllCompaniesRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListAllCompaniesResponse", + "schema": "company_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608a8a68186f43bafd61", + "app_id": "this_is_an_id158_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492746, + "created_at": 1719492746, + "updated_at": 1719492746, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 15, + "total_pages": 1 + }, + "total_count": 1 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6f8cb4ca-9a95-43bd-aee1-597b85d1d13f", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.\n\nNote that the API does not include companies who have no associated users in list responses.\n\nWhen using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "authed": true, + "method": "POST", + "path": "/companies/list", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [ + { + "name": "order", + "value": { + "value": { + "value": "desc", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 15, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d608a8a68186f43bafd61", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "IntercomQATest1", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id158_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "remote_companies_scroll_2", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492746, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492746, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492746, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Scroll over all companies", + "audiences": [], + "operationId": "scrollOverAllCompanies", + "tags": [ + "Companies" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "", + "name": "scroll_param", + "schema": { + "generatedName": "ScrollOverAllCompaniesRequestScrollParam", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "ScrollOverAllCompaniesRequestScrollParam", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ScrollOverAllCompaniesRequestIntercomVersion", + "value": { + "generatedName": "ScrollOverAllCompaniesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ScrollOverAllCompaniesRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ScrollOverAllCompaniesResponse", + "schema": "company_scroll", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "remote_companies_scroll_2", + "id": "667d608b8a68186f43bafd67", + "app_id": "this_is_an_id162_that_should_be_at_least_", + "name": "IntercomQATest1", + "remote_created_at": 1719492747, + "created_at": 1719492747, + "updated_at": 1719492747, + "monthly_spend": 0, + "session_count": 0, + "user_count": 4, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": null, + "total_count": null, + "scroll_param": "12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail\n- If the end of the scroll is reached, \"companies\" will be empty and the scroll parameter will expire\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n \"Request failed due to an internal network error. Please restart the scroll operation.\"\n If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n", + "authed": true, + "method": "GET", + "path": "/companies/scroll", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d608b8a68186f43bafd67", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "IntercomQATest1", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id162_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "remote_companies_scroll_2", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492747, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492747, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492747, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 13, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "scroll_param": { + "value": { + "value": "12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List attached companies for contact", + "audiences": [], + "operationId": "listCompaniesForAContact", + "tags": [ + "Contacts", + "Companies" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ListCompaniesForAContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListCompaniesForAContactRequestIntercomVersion", + "value": { + "generatedName": "ListCompaniesForAContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListCompaniesForAContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListCompaniesForAContactResponse", + "schema": "contact_attached_companies", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [ + { + "type": "company", + "company_id": "1", + "id": "667d60938a68186f43bafd91", + "app_id": "this_is_an_id182_that_should_be_at_least_", + "name": "company12", + "remote_created_at": 1719492755, + "created_at": 1719492755, + "updated_at": 1719492755, + "last_request_at": 1719319955, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + ], + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + }, + "total_count": 1 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d211ec8c-df9b-420c-86df-23c27ad54bc5", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b9d7374d-1780-4668-bb62-0e1ff9cdab45", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of companies that are associated to a contact.", + "authed": true, + "method": "GET", + "path": "/contacts/{id}/companies", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "companies": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "531ee472cce572a6ec000006", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Blue Sun", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "6", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "paid_subscriber", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "monthly_spend", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "team_mates", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "value": { + "value": "next", + "type": "string" + }, + "type": "primitive" + }, + "per_page": { + "value": { + "value": 50, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Attach a Contact to a Company", + "audiences": [], + "operationId": "attachContactToACompany", + "tags": [ + "Companies", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "AttachContactToACompanyRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachContactToACompanyRequestIntercomVersion", + "value": { + "generatedName": "AttachContactToACompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachContactToACompanyRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachContactToACompanyRequestId", + "key": "id", + "schema": { + "description": "The unique identifier for the company which is given by Intercom", + "schema": { + "example": "58a430d35458202d41b1e65b", + "type": "string" + }, + "generatedName": "AttachContactToACompanyRequestId", + "groupName": [], + "type": "primitive" + }, + "audiences": [], + "nameOverride": "companyId" + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachContactToACompanyRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful", + "value": { + "id": "667d608d8a68186f43bafd70" + } + }, + { + "name": "Bad Request", + "value": null + }, + { + "name": "Company Not Found", + "value": { + "id": "123" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful", + "schema": { + "generatedName": "AttachContactToACompanyResponse", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "company", + "company_id": "1", + "id": "667d608d8a68186f43bafd70", + "app_id": "this_is_an_id166_that_should_be_at_least_", + "name": "company6", + "remote_created_at": 1719492749, + "created_at": 1719492749, + "updated_at": 1719492749, + "monthly_spend": 0, + "session_count": 0, + "user_count": 1, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Bad Request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Bad Request", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9297dcfc-1896-43a3-a3f9-131238422ed2", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "company not specified", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "99739bbd-2dbe-4ce3-ae91-af23379b5cd7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Company Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "32d121d8-fcbf-4c59-9c60-204f7d602f36", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can attach a company to a single contact.", + "authed": true, + "method": "POST", + "path": "/contacts/{id}/companies", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "667d608d8a68186f43bafd70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d608d8a68186f43bafd70", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company6", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id166_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Bad Request", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "58a430d35458202d41b1e65b", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d608d8a68186f43bafd70", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company6", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id166_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Company Not Found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d608d8a68186f43bafd70", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company6", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id166_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492749, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Detach a contact from a company", + "audiences": [], + "operationId": "detachContactFromACompany", + "tags": [ + "Companies", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "58a430d35458202d41b1e65b", + "type": "string" + }, + "generatedName": "DetachContactFromACompanyRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The unique identifier for the company which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "58a430d35458202d41b1e65b", + "type": "string" + }, + "generatedName": "DetachContactFromACompanyRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachContactFromACompanyRequestIntercomVersion", + "value": { + "generatedName": "DetachContactFromACompanyRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachContactFromACompanyRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "DetachContactFromACompanyResponse", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "company", + "company_id": "1", + "id": "667d60918a68186f43bafd80", + "app_id": "this_is_an_id174_that_should_be_at_least_", + "name": "company8", + "remote_created_at": 1719492753, + "created_at": 1719492753, + "updated_at": 1719492753, + "monthly_spend": 0, + "session_count": 0, + "user_count": 0, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "plan": {}, + "custom_attributes": {} + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d8c1ab2d-4044-4c4f-98f0-176860747112", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "cd4f1648-724c-45f0-b6e1-72a1bc6479ee", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Contact Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d316defc-0a2f-49e7-b8ff-4cb6ccf46c90", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can detach a company from a single contact.", + "authed": true, + "method": "DELETE", + "path": "/contacts/{contact_id}/companies/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "58a430d35458202d41b1e65b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "58a430d35458202d41b1e65b", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "company", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60918a68186f43bafd80", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "company8", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "this_is_an_id174_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "plan": { + "properties": { + "type": { + "value": { + "value": "plan", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "269315", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Pro", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "company_id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719492753, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492753, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492753, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "56203d253cba154d39010062", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Active", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1394621988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1394622004, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all notes", + "audiences": [], + "operationId": "listNotes", + "tags": [ + "Notes", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier of a contact.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "ListNotesRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListNotesRequestIntercomVersion", + "value": { + "generatedName": "ListNotesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListNotesRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "ListNotesResponse", + "schema": "note_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "list", + "data": [ + { + "type": "note", + "id": "29", + "created_at": 1718887958, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "28", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + }, + { + "type": "note", + "id": "27", + "created_at": 1718801558, + "contact": { + "type": "contact", + "id": "667d60968a68186f43bafd9c" + }, + "author": { + "type": "admin", + "id": "991267491", + "name": "Ciaran101 Lee", + "email": "admin101@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + ], + "total_count": 3, + "pages": { + "type": "pages", + "next": null, + "page": 1, + "per_page": 50, + "total_pages": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e93f90a6-4c85-4dbf-b063-96b649318371", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of notes that are associated to a contact.", + "authed": true, + "method": "GET", + "path": "/contacts/{id}/notes", + "examples": [ + { + "name": "Successful response", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "29", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1718887958, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60968a68186f43bafd9c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267491", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran101 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin101@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

This is a note.

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1718801558, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60968a68186f43bafd9c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267491", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran101 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin101@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

This is a note.

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "27", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1718801558, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60968a68186f43bafd9c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267491", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran101 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin101@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

This is a note.

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 50, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a note", + "audiences": [], + "operationId": "createNote", + "tags": [ + "Notes", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given contact.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "CreateNoteRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateNoteRequestIntercomVersion", + "value": { + "generatedName": "CreateNoteRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateNoteRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createNoteRequestBody", + "key": "body", + "schema": { + "description": "The text of the note.", + "schema": { + "example": "New note", + "type": "string" + }, + "generatedName": "CreateNoteRequestBody", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createNoteRequestContactId", + "key": "contact_id", + "schema": { + "generatedName": "createNoteRequestContactId", + "value": { + "description": "The unique identifier of a given contact.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "CreateNoteRequestContactId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createNoteRequestAdminId", + "key": "admin_id", + "schema": { + "generatedName": "createNoteRequestAdminId", + "value": { + "description": "The unique identifier of a given admin.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "CreateNoteRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CreateNoteRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful response", + "value": { + "contact_id": "667d60978a68186f43bafd9e", + "admin_id": 991267493, + "body": "Hello" + } + }, + { + "name": "Admin not found", + "value": { + "contact_id": "667d60988a68186f43bafd9f", + "admin_id": 123, + "body": "Hello" + } + }, + { + "name": "Contact not found", + "value": { + "contact_id": 123, + "admin_id": 991267495, + "body": "Hello" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful response", + "schema": { + "generatedName": "CreateNoteResponse", + "schema": "note", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "note", + "id": "34", + "created_at": 1719492759, + "contact": { + "type": "contact", + "id": "667d60978a68186f43bafd9e" + }, + "author": { + "type": "admin", + "id": "991267493", + "name": "Ciaran103 Lee", + "email": "admin103@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

Hello

" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Admin not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d7c69ce6-3195-46be-b2cb-0dce355d2919", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can add a note to a single contact.", + "authed": true, + "method": "POST", + "path": "/contacts/{id}/notes", + "examples": [ + { + "name": "Successful response", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "body": { + "value": { + "value": "Hello", + "type": "string" + }, + "type": "primitive" + }, + "contact_id": { + "value": { + "value": "667d60978a68186f43bafd9e", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "34", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492759, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60978a68186f43bafd9e", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267493", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran103 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin103@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

Hello

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "body": { + "value": { + "value": "Hello", + "type": "string" + }, + "type": "primitive" + }, + "contact_id": { + "value": { + "value": "667d60988a68186f43bafd9f", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "34", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492759, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60978a68186f43bafd9e", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267493", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran103 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin103@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

Hello

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Contact not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "body": { + "value": { + "value": "Hello", + "type": "string" + }, + "type": "primitive" + }, + "contact_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "34", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492759, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60978a68186f43bafd9e", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267493", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran103 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin103@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

Hello

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List attached segments for contact", + "audiences": [], + "operationId": "listSegmentsForAContact", + "tags": [ + "Contacts", + "Segments" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ListSegmentsForAContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListSegmentsForAContactRequestIntercomVersion", + "value": { + "generatedName": "ListSegmentsForAContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListSegmentsForAContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListSegmentsForAContactResponse", + "schema": "contact_segments", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [ + { + "type": "segment", + "id": "667d60998a68186f43bafda1", + "name": "segment", + "created_at": 1719492761, + "updated_at": 1719492761, + "person_type": "user" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d2927c64-9c5a-4593-997b-381f8c2356ea", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of segments that are associated to a contact.", + "authed": true, + "method": "GET", + "path": "/contacts/{contact_id}/segments", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60998a68186f43bafda1", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492761, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492761, + "type": "int" + }, + "type": "primitive" + }, + "person_type": { + "value": "user", + "type": "enum" + }, + "count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List subscriptions for a contact", + "audiences": [], + "operationId": "listSubscriptionsForAContact", + "tags": [ + "Contacts", + "Subscription Types" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ListSubscriptionsForAContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListSubscriptionsForAContactRequestIntercomVersion", + "value": { + "generatedName": "ListSubscriptionsForAContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListSubscriptionsForAContactRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListSubscriptionsForAContactResponse", + "schema": "subscription_type_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "93", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + }, + { + "type": "subscription", + "id": "95", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "82a95655-569d-4e5d-b0d9-f8a6c7a379f3", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3f481052-cf49-4b95-a492-734223865981", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.\nThis will return a list of Subscription Type objects that the contact is associated with.\n\nThe data property will show a combined list of:\n\n 1.Opt-out subscription types that the user has opted-out from.\n 2.Opt-in subscription types that the user has opted-in to receiving.\n", + "authed": true, + "method": "GET", + "path": "/contacts/{contact_id}/subscriptions", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "93", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_out", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "email", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "95", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_in", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "sms_message", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Add subscription to a contact", + "audiences": [], + "operationId": "attachSubscriptionTypeToContact", + "tags": [ + "Subscription Types", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "AttachSubscriptionTypeToContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachSubscriptionTypeToContactRequestIntercomVersion", + "value": { + "generatedName": "AttachSubscriptionTypeToContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachSubscriptionTypeToContactRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachSubscriptionTypeToContactRequestId", + "key": "id", + "schema": { + "description": "The unique identifier for the subscription which is given by Intercom", + "schema": { + "example": "37846", + "type": "string" + }, + "generatedName": "AttachSubscriptionTypeToContactRequestId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachSubscriptionTypeToContactRequestConsentType", + "key": "consent_type", + "schema": { + "description": "The consent_type of a subscription, opt_out or opt_in.", + "schema": { + "example": "opt_in", + "type": "string" + }, + "generatedName": "AttachSubscriptionTypeToContactRequestConsentType", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachSubscriptionTypeToContactRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful", + "value": { + "id": 108, + "consent_type": "opt_in" + } + }, + { + "name": "Contact not found", + "value": { + "id": 112, + "consent_type": "opt_in" + } + }, + { + "name": "Resource not found", + "value": { + "id": "invalid_id", + "consent_type": "opt_in" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful", + "schema": { + "generatedName": "AttachSubscriptionTypeToContactResponse", + "schema": "subscription_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "subscription", + "id": "108", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "377d162e-82a5-4148-a26f-29c9c760dadc", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Resource not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "cf0f6fd6-7c5e-492b-909d-f60b35eea1c4", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Resource not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3f852f45-1a80-4ade-9bc6-72b377d2bbd8", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:\n\n 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.\n\n 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.\n\nThis will return a subscription type model for the subscription type that was added to the contact.\n", + "authed": true, + "method": "POST", + "path": "/contacts/{contact_id}/subscriptions", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "37846", + "type": "string" + }, + "type": "primitive" + }, + "consent_type": { + "value": { + "value": "opt_in", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_in", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "sms_message", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Contact not found", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "37846", + "type": "string" + }, + "type": "primitive" + }, + "consent_type": { + "value": { + "value": "opt_in", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_in", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "sms_message", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Resource not found", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "invalid_id", + "type": "string" + }, + "type": "primitive" + }, + "consent_type": { + "value": { + "value": "opt_in", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_in", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "sms_message", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Remove subscription from a contact", + "audiences": [], + "operationId": "detachSubscriptionTypeToContact", + "tags": [ + "Subscription Types", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "DetachSubscriptionTypeToContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The unique identifier for the subscription type which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "37846", + "type": "string" + }, + "generatedName": "DetachSubscriptionTypeToContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachSubscriptionTypeToContactRequestIntercomVersion", + "value": { + "generatedName": "DetachSubscriptionTypeToContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachSubscriptionTypeToContactRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "DetachSubscriptionTypeToContactResponse", + "schema": "subscription_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "subscription", + "id": "124", + "state": "live", + "consent_type": "opt_in", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "sms_message" + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "99fba0c6-2252-4658-abd2-1d2ff16a508b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Resource not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7bc429e4-e887-4f53-b69c-94e6e55d2125", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Resource not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "66ebc1f5-5e02-4584-8028-f2559a41e8df", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "authed": true, + "method": "DELETE", + "path": "/contacts/{contact_id}/subscriptions/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "37846", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "124", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_in", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "sms_message", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List tags attached to a contact", + "audiences": [], + "operationId": "listTagsForAContact", + "tags": [ + "Contacts", + "Tags" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ListTagsForAContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListTagsForAContactRequestIntercomVersion", + "value": { + "generatedName": "ListTagsForAContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListTagsForAContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListTagsForAContactResponse", + "schema": "tag_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "93", + "name": "Manual tag" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "97383559-0fb0-4084-8a9a-8e3407c46108", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2b513026-b78c-4c67-b073-da0266f62cc7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all tags that are attached to a specific contact.", + "authed": true, + "method": "GET", + "path": "/contacts/{contact_id}/tags", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "93", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Add tag to a contact", + "audiences": [], + "operationId": "attachTagToContact", + "tags": [ + "Tags", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "AttachTagToContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachTagToContactRequestIntercomVersion", + "value": { + "generatedName": "AttachTagToContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachTagToContactRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachTagToContactRequestId", + "key": "id", + "schema": { + "description": "The unique identifier for the tag which is given by Intercom", + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "AttachTagToContactRequestId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachTagToContactRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "id": 94 + } + }, + { + "name": "Contact not found", + "value": { + "id": 95 + } + }, + { + "name": "Tag not found", + "value": { + "id": "123" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "AttachTagToContactResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "94", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "63a2828f-107e-4d51-9398-a220b81a7bce", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1bbd7e4b-718e-46f4-b682-a429aea78f01", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Tag not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a1a28017-728a-423b-adc0-2705d375f533", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "authed": true, + "method": "POST", + "path": "/contacts/{contact_id}/tags", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "94", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Contact not found", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "94", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Tag not found", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "94", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Remove tag from a contact", + "audiences": [], + "operationId": "detachTagFromContact", + "tags": [ + "Tags", + "Contacts" + ], + "pathParameters": [ + { + "description": "The unique identifier for the contact which is given by Intercom", + "name": "contact_id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "DetachTagFromContactRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The unique identifier for the tag which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "DetachTagFromContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachTagFromContactRequestIntercomVersion", + "value": { + "generatedName": "DetachTagFromContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachTagFromContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "DetachTagFromContactResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "97", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e97d9f1b-8c9e-4caf-b473-3bce411c697e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6f735483-c309-4e94-b9ab-143aedc0c691", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Tag not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9e780671-29b3-4913-b4be-15234ea0bc6a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "authed": true, + "method": "DELETE", + "path": "/contacts/{contact_id}/tags/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "contact_id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "97", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Get a contact", + "audiences": [], + "operationId": "ShowContact", + "tags": [ + "Contacts" + ], + "pathParameters": [ + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ShowContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ShowContactRequestIntercomVersion", + "value": { + "generatedName": "ShowContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ShowContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ShowContactResponse", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "contact", + "id": "667d60a98a68186f43bafdb9", + "workspace_id": "this_is_an_id252_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492777, + "updated_at": 1719492777, + "signed_up_at": 1719492777, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a98a68186f43bafdb9/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f70085f1-f655-43ee-9585-d2061b260fcd", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single contact.", + "authed": true, + "method": "GET", + "path": "/contacts/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60a98a68186f43bafdb9", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id252_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492777, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492777, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719492777, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.org/128Wash.jpg", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60a98a68186f43bafdb9/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60a98a68186f43bafdb9/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/667d60a98a68186f43bafdb9/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "location": { + "properties": { + "type": { + "value": { + "value": "location", + "type": "string" + }, + "type": "primitive" + }, + "country": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "city": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "social_profiles": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "social_profile", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Facebook", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://twitter.com/th1sland", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a contact", + "audiences": [], + "operationId": "UpdateContact", + "tags": [ + "Contacts" + ], + "pathParameters": [ + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "UpdateContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateContactRequestIntercomVersion", + "value": { + "generatedName": "UpdateContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateContactRequest", + "request": { + "schema": { + "generatedName": "UpdateContactRequestBody", + "schema": "update_contact_request", + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "UpdateContactResponse", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "contact", + "id": "667d60a88a68186f43bafdb8", + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": "joe bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492776, + "updated_at": 1719492776, + "signed_up_at": 1719492776, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60a88a68186f43bafdb8/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b1b88e2d-938c-4a26-b65d-26ff65a0af36", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update an existing contact (ie. user or lead).", + "authed": true, + "method": "PUT", + "path": "/contacts/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "email": { + "value": { + "value": "joebloggs@intercom.io", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "joe bloggs", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60a88a68186f43bafdb8", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id248_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joebloggs@intercom.io", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "joe bloggs", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492776, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492776, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719492776, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.org/128Wash.jpg", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60a88a68186f43bafdb8/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60a88a68186f43bafdb8/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/667d60a88a68186f43bafdb8/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "location": { + "properties": { + "type": { + "value": { + "value": "location", + "type": "string" + }, + "type": "primitive" + }, + "country": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "city": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "social_profiles": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "social_profile", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Facebook", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://twitter.com/th1sland", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete a contact", + "audiences": [], + "operationId": "DeleteContact", + "tags": [ + "Contacts" + ], + "pathParameters": [ + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "DeleteContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteContactRequestIntercomVersion", + "value": { + "generatedName": "DeleteContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "DeleteContactResponse", + "schema": "contact_deleted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "667d60aa8a68186f43bafdba", + "external_id": "70", + "type": "contact", + "deleted": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0bce3945-d2ec-4b8e-a790-b16fd52d9f11", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete a single contact.", + "authed": true, + "method": "DELETE", + "path": "/contacts/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60aa8a68186f43bafdba", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "deleted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Merge a lead and a user", + "audiences": [], + "operationId": "MergeContact", + "tags": [ + "Contacts" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "MergeContactRequestIntercomVersion", + "value": { + "generatedName": "MergeContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "MergeContactRequest", + "request": { + "schema": { + "generatedName": "MergeContactRequestBody", + "schema": "merge_contacts_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "from": "667d60ac8a68186f43bafdbb", + "into": "667d60ac8a68186f43bafdbc" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "MergeContactResponse", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "contact", + "id": "667d60ac8a68186f43bafdbc", + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + "external_id": "70", + "role": "user", + "email": "joe@bloggs.com", + "phone": null, + "name": "Joe Bloggs", + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492780, + "updated_at": 1719492780, + "signed_up_at": 1719492780, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60ac8a68186f43bafdbc/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "57b64228-0e60-4e35-833d-39c4e4067dde", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "authed": true, + "method": "POST", + "path": "/contacts/merge", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "from": { + "value": { + "value": "667d60ac8a68186f43bafdbb", + "type": "string" + }, + "type": "primitive" + }, + "into": { + "value": { + "value": "667d60ac8a68186f43bafdbc", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60ac8a68186f43bafdbc", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id260_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492780, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492780, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719492780, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.org/128Wash.jpg", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60ac8a68186f43bafdbc/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60ac8a68186f43bafdbc/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/667d60ac8a68186f43bafdbc/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "location": { + "properties": { + "type": { + "value": { + "value": "location", + "type": "string" + }, + "type": "primitive" + }, + "country": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "city": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "social_profiles": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "social_profile", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Facebook", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://twitter.com/th1sland", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Search contacts", + "audiences": [], + "operationId": "SearchContacts", + "tags": [ + "Contacts" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "SearchContactsRequestIntercomVersion", + "value": { + "generatedName": "SearchContactsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "SearchContactsRequest", + "request": { + "schema": { + "generatedName": "SearchContactsRequestBody", + "schema": "search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154" + } + ] + }, + "pagination": { + "per_page": 5 + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "SearchContactsResponse", + "schema": "contact_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 0 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.\n\nTo search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for contacts.\n\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n### Contact Creation Delay\n\nIf a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters.\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n* There's a limit of max 2 nested filters\n* There's a limit of max 15 filters for each AND or OR group\n\n### Searching for Timestamp Fields\n\nAll timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.\nFor example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.\nIf you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).\nThis behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.\n\n### Accepted Fields\n\nMost key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| ---------------------------------- | ------------------------------ |\n| id | String |\n| role | String
Accepts user or lead |\n| name | String |\n| avatar | String |\n| owner_id | Integer |\n| email | String |\n| email_domain | String |\n| phone | String |\n| formatted_phone | String |\n| external_id | String |\n| created_at | Date (UNIX Timestamp) |\n| signed_up_at | Date (UNIX Timestamp) |\n| updated_at | Date (UNIX Timestamp) |\n| last_seen_at | Date (UNIX Timestamp) |\n| last_contacted_at | Date (UNIX Timestamp) |\n| last_replied_at | Date (UNIX Timestamp) |\n| last_email_opened_at | Date (UNIX Timestamp) |\n| last_email_clicked_at | Date (UNIX Timestamp) |\n| language_override | String |\n| browser | String |\n| browser_language | String |\n| os | String |\n| location.country | String |\n| location.region | String |\n| location.city | String |\n| unsubscribed_from_emails | Boolean |\n| marked_email_as_spam | Boolean |\n| has_hard_bounced | Boolean |\n| ios_last_seen_at | Date (UNIX Timestamp) |\n| ios_app_version | String |\n| ios_device | String |\n| ios_app_device | String |\n| ios_os_version | String |\n| ios_app_name | String |\n| ios_sdk_version | String |\n| android_last_seen_at | Date (UNIX Timestamp) |\n| android_app_version | String |\n| android_device | String |\n| android_app_name | String |\n| andoid_sdk_version | String |\n| segment_id | String |\n| tag_id | String |\n| custom_attributes.{attribute_name} | String |\n\n### Accepted Operators\n\n{% admonition type=\"attention\" name=\"Searching based on `created_at`\" %}\n You cannot use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :------------------------------- | :--------------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In
Shortcut for `OR` queries
Values must be in Array |\n| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array |\n| > | Integer
Date (UNIX Timestamp) | Greater than |\n| < | Integer
Date (UNIX Timestamp) | Lower than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "authed": true, + "method": "POST", + "path": "/contacts/search", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "query": { + "properties": { + "operator": { + "value": "AND", + "type": "enum" + }, + "value": { + "value": [ + { + "properties": { + "field": { + "value": { + "value": "created_at", + "type": "string" + }, + "type": "primitive" + }, + "operator": { + "value": ">", + "type": "enum" + }, + "value": { + "value": { + "value": "1306054154", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "pagination": { + "properties": { + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@example.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John Doe", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all contacts", + "audiences": [], + "operationId": "ListContacts", + "tags": [ + "Contacts" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListContactsRequestIntercomVersion", + "value": { + "generatedName": "ListContactsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListContactsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListContactsResponse", + "schema": "contact_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [], + "total_count": 0, + "pages": { + "type": "pages", + "page": 1, + "per_page": 10, + "total_pages": 0 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d5bac7ff-7961-4fe5-8aed-6f1b031b38af", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all contacts (ie. users or leads) in your workspace.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `50` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "authed": true, + "method": "GET", + "path": "/contacts", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@example.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John Doe", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 10, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create contact", + "audiences": [], + "operationId": "CreateContact", + "tags": [ + "Contacts" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateContactRequestIntercomVersion", + "value": { + "generatedName": "CreateContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateContactRequest", + "request": { + "schema": { + "generatedName": "CreateContactRequestBody", + "schema": "create_contact_request", + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "email": "joebloggs@intercom.io" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "CreateContactResponse", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "contact", + "id": "667d60b08a68186f43bafdbf", + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "joebloggs@intercom.io", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719492784, + "updated_at": 1719492784, + "signed_up_at": null, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d60b08a68186f43bafdbf/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c18ca0d4-ad2c-41e7-9a71-1df806f9c954", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new contact (ie. user or lead).", + "authed": true, + "method": "POST", + "path": "/contacts", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "email", + "type": "string" + }, + "value": { + "value": { + "value": "joebloggs@intercom.io", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60b08a68186f43bafdbf", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id272_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joebloggs@intercom.io", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John Doe", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492784, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492784, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.org/128Wash.jpg", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60b08a68186f43bafdbf/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d60b08a68186f43bafdbf/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/667d60b08a68186f43bafdbf/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "location": { + "properties": { + "type": { + "value": { + "value": "location", + "type": "string" + }, + "type": "primitive" + }, + "country": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "city": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "social_profiles": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "social_profile", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Facebook", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://twitter.com/th1sland", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Archive contact", + "audiences": [], + "operationId": "ArchiveContact", + "tags": [ + "Contacts" + ], + "pathParameters": [ + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "ArchiveContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ArchiveContactRequestIntercomVersion", + "value": { + "generatedName": "ArchiveContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ArchiveContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ArchiveContactResponse", + "schema": "contact_archived", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "667d60b18a68186f43bafdc0", + "external_id": "70", + "type": "contact", + "archived": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can archive a single contact.", + "authed": true, + "method": "POST", + "path": "/contacts/{id}/archive", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60b18a68186f43bafdc0", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Unarchive contact", + "audiences": [], + "operationId": "UnarchiveContact", + "tags": [ + "Contacts" + ], + "pathParameters": [ + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "example": "63a07ddf05a32042dffac965", + "type": "string" + }, + "generatedName": "UnarchiveContactRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UnarchiveContactRequestIntercomVersion", + "value": { + "generatedName": "UnarchiveContactRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UnarchiveContactRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "UnarchiveContactResponse", + "schema": "contact_unarchived", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "667d60b28a68186f43bafdc1", + "external_id": "70", + "type": "contact", + "archived": false + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can unarchive a single contact.", + "authed": true, + "method": "POST", + "path": "/contacts/{id}/unarchive", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "63a07ddf05a32042dffac965", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60b28a68186f43bafdc1", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Add tag to a conversation", + "audiences": [], + "operationId": "attachTagToConversation", + "tags": [ + "Tags", + "Conversations" + ], + "pathParameters": [ + { + "description": "conversation_id", + "name": "conversation_id", + "schema": { + "schema": { + "example": "64619700005694", + "type": "string" + }, + "generatedName": "AttachTagToConversationRequestConversationId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachTagToConversationRequestIntercomVersion", + "value": { + "generatedName": "AttachTagToConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachTagToConversationRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachTagToConversationRequestId", + "key": "id", + "schema": { + "description": "The unique identifier for the tag which is given by Intercom", + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "AttachTagToConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachTagToConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The unique identifier for the admin which is given by Intercom.", + "schema": { + "example": "780", + "type": "string" + }, + "generatedName": "AttachTagToConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachTagToConversationRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "id": 99, + "admin_id": 991267526 + } + }, + { + "name": "Conversation not found", + "value": { + "id": 100, + "admin_id": 991267528 + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "AttachTagToConversationResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "99", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "95cacea0-4744-4de8-a2bf-da4419f75732", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Conversation not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Conversation not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "840d35aa-2414-402a-b3c6-763a410e0d16", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Conversation not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "authed": true, + "method": "POST", + "path": "/conversations/{conversation_id}/tags", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "99", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Conversation not found", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "99", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Remove tag from a conversation", + "audiences": [], + "operationId": "detachTagFromConversation", + "tags": [ + "Tags", + "Conversations" + ], + "pathParameters": [ + { + "description": "conversation_id", + "name": "conversation_id", + "schema": { + "schema": { + "example": "64619700005694", + "type": "string" + }, + "generatedName": "DetachTagFromConversationRequestConversationId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "id", + "name": "id", + "schema": { + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "DetachTagFromConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachTagFromConversationRequestIntercomVersion", + "value": { + "generatedName": "DetachTagFromConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachTagFromConversationRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "detachTagFromConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The unique identifier for the admin which is given by Intercom.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "DetachTagFromConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "DetachTagFromConversationRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "admin_id": 991267530 + } + }, + { + "name": "Conversation not found", + "value": { + "admin_id": 991267532 + } + }, + { + "name": "Tag not found", + "value": { + "admin_id": 991267533 + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "DetachTagFromConversationResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "102", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f083d6b1-e9d2-43b3-86df-67539007fc3e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Conversation not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f78f63ba-911d-47b8-a389-b33e3ccbe77e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Conversation not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Tag not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0d00d069-2cf1-496f-b887-a4db74ee320d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "tag_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Tag not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "authed": true, + "method": "DELETE", + "path": "/conversations/{conversation_id}/tags/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "102", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Conversation not found", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "102", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Tag not found", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "102", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all conversations", + "audiences": [], + "operationId": "listConversations", + "tags": [ + "Conversations" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "How many results per page", + "name": "per_page", + "schema": { + "generatedName": "ListConversationsRequestPerPage", + "value": { + "schema": { + "default": 20, + "maximum": 150, + "type": "int" + }, + "generatedName": "ListConversationsRequestPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "String used to get the next page of conversations.", + "name": "starting_after", + "schema": { + "generatedName": "ListConversationsRequestStartingAfter", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "ListConversationsRequestStartingAfter", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListConversationsRequestIntercomVersion", + "value": { + "generatedName": "ListConversationsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListConversationsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListConversationsResponse", + "schema": "paginated_response", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 20, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "335", + "created_at": 1719492795, + "updated_at": 1719492795, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918241", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267536", + "name": "Ciaran143 Lee", + "email": "admin143@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60bb8a68186f43bafdc5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "18db64a8-7a08-4967-9ec6-0416178306f9", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a91eac55-8d70-454d-a01d-c6bb875aaa35", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all conversations.\n\nYou can optionally request the result page size and the cursor to start after to fetch the result.\n{% admonition type=\"warning\" name=\"Pagination\" %}\n You can use pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param.\n{% /admonition %}\n", + "authed": true, + "method": "GET", + "path": "/conversations", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": "conversation.list", + "type": "enum" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 20, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "12312", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "My Newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Creates a conversation", + "audiences": [], + "operationId": "createConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateConversationRequestIntercomVersion", + "value": { + "generatedName": "CreateConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateConversationRequest", + "request": { + "schema": { + "generatedName": "CreateConversationRequestBody", + "schema": "create_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "conversation created", + "value": { + "from": { + "type": "user", + "id": "667d60d18a68186f43bafddd" + }, + "body": "Hello there" + } + }, + { + "name": "Contact Not Found", + "value": { + "from": { + "type": "user", + "id": "123_doesnt_exist" + }, + "body": "Hello there" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "conversation created", + "schema": { + "generatedName": "CreateConversationResponse", + "schema": "message", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "conversation created", + "value": { + "type": "user_message", + "id": "403918251", + "created_at": 1719492819, + "body": "Hello there", + "message_type": "inapp", + "conversation_id": "363" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "af9757fc-4e1d-463c-ac9d-788503f04a95", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c7a35217-6720-48bd-a2ae-c2acb5adea30", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Contact Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "ed0ab0c5-57b8-4413-a7a9-bbc134b40876", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a conversation that has been initiated by a contact (ie. user or lead).\nThe conversation can be an in-app message only.\n\n{% admonition type=\"info\" name=\"Sending for visitors\" %}\nYou can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.\nThis visitor will be automatically converted to a contact with a lead role once the conversation is created.\n{% /admonition %}\n\nThis will return the Message model that has been created.\n\n", + "authed": true, + "method": "POST", + "path": "/conversations", + "examples": [ + { + "name": "conversation created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "from": { + "properties": { + "type": { + "value": "user", + "type": "enum" + }, + "id": { + "value": { + "value": "667d60d18a68186f43bafddd", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "Hello there", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918251", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492819, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Hello there", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "363", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Contact Not Found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "from": { + "properties": { + "type": { + "value": "user", + "type": "enum" + }, + "id": { + "value": { + "value": "123_doesnt_exist", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "Hello there", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918251", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492819, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Hello there", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "363", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a conversation", + "audiences": [], + "operationId": "retrieveConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The id of the conversation to target", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [ + { + "description": "Set to plaintext to retrieve conversation messages in plain text.", + "name": "display_as", + "schema": { + "generatedName": "RetrieveConversationRequestDisplayAs", + "value": { + "schema": { + "example": "plaintext", + "type": "string" + }, + "generatedName": "RetrieveConversationRequestDisplayAs", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveConversationRequestIntercomVersion", + "value": { + "generatedName": "RetrieveConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveConversationRequest", + "response": { + "description": "conversation found", + "schema": { + "generatedName": "RetrieveConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "conversation found", + "value": { + "type": "conversation", + "id": "367", + "created_at": 1719492825, + "updated_at": 1719492825, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918255", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267553", + "name": "Ciaran153 Lee", + "email": "admin153@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60d88a68186f43bafde1", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [], + "total_count": 0 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b1f6adfd-f7da-4880-8d11-d842235126ae", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c7b0a10f-d482-4352-8d7b-1ad26b902473", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "978c1e65-1eba-4995-9acb-ff8f33b283e3", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\nYou can fetch the details of a single conversation.\n\nThis will return a single Conversation model with all its conversation parts.\n\n{% admonition type=\"warning\" name=\"Hard limit of 500 parts\" %}\nThe maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.\n{% /admonition %}\n\nFor AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671).\n", + "authed": true, + "method": "GET", + "path": "/conversations/{id}", + "examples": [ + { + "name": "conversation found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [ + { + "name": "display_as", + "value": { + "value": { + "value": "plaintext", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "367", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492825, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492825, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918255", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267553", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran153 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin153@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60d88a68186f43bafde1", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a conversation", + "audiences": [], + "operationId": "updateConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The id of the conversation to target", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "UpdateConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [ + { + "description": "Set to plaintext to retrieve conversation messages in plain text.", + "name": "display_as", + "schema": { + "generatedName": "UpdateConversationRequestDisplayAs", + "value": { + "schema": { + "example": "plaintext", + "type": "string" + }, + "generatedName": "UpdateConversationRequestDisplayAs", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateConversationRequestIntercomVersion", + "value": { + "generatedName": "UpdateConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateConversationRequest", + "request": { + "schema": { + "generatedName": "UpdateConversationRequestBody", + "schema": "update_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "conversation found", + "value": { + "read": true, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + }, + { + "name": "Not found", + "value": { + "read": true, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "conversation found", + "schema": { + "generatedName": "UpdateConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "conversation found", + "value": { + "type": "conversation", + "id": "371", + "created_at": 1719492832, + "updated_at": 1719492834, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918259", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267561", + "name": "Ciaran157 Lee", + "email": "admin157@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60e08a68186f43bafde5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + }, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "96", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + }, + { + "type": "conversation_part", + "id": "97", + "part_type": "conversation_attribute_updated_by_admin", + "body": null, + "created_at": 1719492834, + "updated_at": 1719492834, + "notified_at": 1719492834, + "assigned_to": null, + "author": { + "id": "991267562", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 2 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "58e6b9ee-4a28-4597-9c20-faf34b6894dc", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "cf6fb162-88c9-45ec-9f97-c3fcad93b7c1", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e4c692dd-cccd-46bf-834a-cda7a3a9029c", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\nYou can update an existing conversation.\n\n{% admonition type=\"info\" name=\"Replying and other actions\" %}\nIf you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints.\n{% /admonition %}\n\n", + "authed": true, + "method": "PUT", + "path": "/conversations/{id}", + "examples": [ + { + "name": "conversation found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [ + { + "name": "display_as", + "value": { + "value": { + "value": "plaintext", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "request": { + "properties": { + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "371", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492832, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918259", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267561", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran157 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin157@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60e08a68186f43bafde5", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "96", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "conversation_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "bot", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267562", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "97", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "conversation_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "bot", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267562", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [ + { + "name": "display_as", + "value": { + "value": { + "value": "plaintext", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "request": { + "properties": { + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "371", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492832, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918259", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267561", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran157 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin157@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60e08a68186f43bafde5", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "96", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "conversation_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "bot", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267562", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "97", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "conversation_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492834, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "bot", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267562", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Search conversations", + "audiences": [], + "operationId": "searchConversations", + "tags": [ + "Conversations" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "SearchConversationsRequestIntercomVersion", + "value": { + "generatedName": "SearchConversationsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "SearchConversationsRequest", + "request": { + "schema": { + "generatedName": "SearchConversationsRequestBody", + "schema": "search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154" + } + ] + }, + "pagination": { + "per_page": 5 + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "SearchConversationsResponse", + "schema": "conversation_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "conversation.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "conversations": [ + { + "type": "conversation", + "id": "378", + "created_at": 1719492843, + "updated_at": 1719492843, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918266", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267591", + "name": "Ciaran180 Lee", + "email": "admin180@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ea8a68186f43bafdec", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`.\n\nThis will accept a query object in the body which will define your filters in order to search for conversations.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiple's there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foorbar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. |\n| source.id | String |\n| source.delivered_as | String |\n| source.subject | String |\n| source.body | String |\n| source.author.id | String |\n| source.author.type | String |\n| source.author.name | String |\n| source.author.email | String |\n| source.url | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| channel_initiated | String |\n| open | Boolean |\n| read | Boolean |\n| state | String |\n| waiting_since | Date (UNIX timestamp) |\n| snoozed_until | Date (UNIX timestamp) |\n| tag_ids | String |\n| priority | String |\n| statistics.time_to_assignment | Integer |\n| statistics.time_to_admin_reply | Integer |\n| statistics.time_to_first_close | Integer |\n| statistics.time_to_last_close | Integer |\n| statistics.median_time_to_reply | Integer |\n| statistics.first_contact_reply_at | Date (UNIX timestamp) |\n| statistics.first_assignment_at | Date (UNIX timestamp) |\n| statistics.first_admin_reply_at | Date (UNIX timestamp) |\n| statistics.first_close_at | Date (UNIX timestamp) |\n| statistics.last_assignment_at | Date (UNIX timestamp) |\n| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_contact_reply_at | Date (UNIX timestamp) |\n| statistics.last_admin_reply_at | Date (UNIX timestamp) |\n| statistics.last_close_at | Date (UNIX timestamp) |\n| statistics.last_closed_by_id | String |\n| statistics.count_reopens | Integer |\n| statistics.count_assignments | Integer |\n| statistics.count_conversation_parts | Integer |\n| conversation_rating.requested_at | Date (UNIX timestamp) |\n| conversation_rating.replied_at | Date (UNIX timestamp) |\n| conversation_rating.score | Integer |\n| conversation_rating.remark | String |\n| conversation_rating.contact_id | String |\n| conversation_rating.admin_d | String |\n| ai_agent_participated | Boolean |\n| ai_agent.resolution_state | String |\n| ai_agent.last_answer_type | String |\n| ai_agent.rating | Integer |\n| ai_agent.rating_remark | String |\n| ai_agent.source_type | String |\n| ai_agent.source_title | String |\n\n### Accepted Operators\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "authed": true, + "method": "POST", + "path": "/conversations/search", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "query": { + "properties": { + "operator": { + "value": "AND", + "type": "enum" + }, + "value": { + "value": [ + { + "properties": { + "field": { + "value": { + "value": "created_at", + "type": "string" + }, + "type": "primitive" + }, + "operator": { + "value": ">", + "type": "enum" + }, + "value": { + "value": { + "value": "1306054154", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "pagination": { + "properties": { + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation.list", + "type": "string" + }, + "type": "literal" + }, + "conversations": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "378", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492843, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492843, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918266", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267591", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran180 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin180@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60ea8a68186f43bafdec", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Reply to a conversation", + "audiences": [], + "operationId": "replyConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The Intercom provisioned identifier for the conversation or the string \"last\" to reply to the last part of the conversation", + "name": "id", + "schema": { + "schema": { + "example": "123 or \"last\"", + "type": "string" + }, + "generatedName": "ReplyConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ReplyConversationRequestIntercomVersion", + "value": { + "generatedName": "ReplyConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ReplyConversationRequest", + "request": { + "schema": { + "generatedName": "ReplyConversationRequestBody", + "schema": "reply_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "User reply", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d60f18a68186f43bafdf4", + "body": "Thanks again :)" + } + }, + { + "name": "Admin note reply", + "value": { + "message_type": "note", + "type": "admin", + "admin_id": 991267596, + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
" + } + }, + { + "name": "User last conversation reply", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d60f78a68186f43bafdf7", + "body": "Thanks again :)" + } + }, + { + "name": "Not found", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d60f98a68186f43bafdf8", + "body": "Thanks again :)" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "User last conversation reply", + "schema": { + "generatedName": "ReplyConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "User reply", + "value": { + "type": "conversation", + "id": "387", + "created_at": 1719492849, + "updated_at": 1719492850, + "waiting_since": 1719492850, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918269", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267594", + "name": "Ciaran182 Lee", + "email": "admin182@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f18a68186f43bafdf4", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "99", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492850, + "updated_at": 1719492850, + "notified_at": 1719492850, + "assigned_to": null, + "author": { + "id": "667d60f18a68186f43bafdf4", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + }, + { + "name": "Admin note reply", + "value": { + "type": "conversation", + "id": "388", + "created_at": 1719492852, + "updated_at": 1719492853, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918270", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267596", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f38a68186f43bafdf5", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "100", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "created_at": 1719492853, + "updated_at": 1719492853, + "notified_at": 1719492853, + "assigned_to": null, + "author": { + "id": "991267596", + "type": "admin", + "name": "Ciaran183 Lee", + "email": "admin183@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + }, + { + "name": "User last conversation reply", + "value": { + "type": "conversation", + "id": "390", + "created_at": 1719492855, + "updated_at": 1719492856, + "waiting_since": 1719492856, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918272", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267600", + "name": "Ciaran185 Lee", + "email": "admin185@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60f78a68186f43bafdf7", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492856, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "101", + "part_type": "open", + "body": "

Thanks again :)

", + "created_at": 1719492856, + "updated_at": 1719492856, + "notified_at": 1719492856, + "assigned_to": null, + "author": { + "id": "667d60f78a68186f43bafdf7", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7435aa28-13bd-40b1-ba99-66009e92a1ba", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9fe5809c-cf0b-4a0f-af80-9913d3beb1eb", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "8193a639-aba8-4b0e-9fdd-ee48807e3ee7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "authed": true, + "method": "POST", + "path": "/conversations/{id}/reply", + "examples": [ + { + "name": "User reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123 or \"last\"", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "literal" + }, + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "Thanks again :)", + "type": "string" + }, + "type": "primitive" + }, + "intercom_user_id": { + "value": { + "value": "667d60f18a68186f43bafdf4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "387", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492849, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918269", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267594", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran182 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin182@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60f18a68186f43bafdf4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "99", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Thanks again :)

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60f18a68186f43bafdf4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin note reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123 or \"last\"", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": "note", + "type": "enum" + }, + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "3156780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "388", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492852, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492853, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918270", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267596", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran183 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin183@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60f38a68186f43bafdf5", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "100", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492853, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492853, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492853, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267596", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran183 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin183@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "User last conversation reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123 or \"last\"", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "literal" + }, + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "Thanks again :)", + "type": "string" + }, + "type": "primitive" + }, + "intercom_user_id": { + "value": { + "value": "667d60f78a68186f43bafdf7", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "390", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492855, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918272", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267600", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran185 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin185@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60f78a68186f43bafdf7", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "101", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Thanks again :)

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492856, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60f78a68186f43bafdf7", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123 or \"last\"", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "literal" + }, + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "Thanks again :)", + "type": "string" + }, + "type": "primitive" + }, + "intercom_user_id": { + "value": { + "value": "667d60f98a68186f43bafdf8", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "387", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492849, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918269", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267594", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran182 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin182@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60f18a68186f43bafdf4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "99", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Thanks again :)

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492850, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d60f18a68186f43bafdf4", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Manage a conversation", + "audiences": [], + "operationId": "manageConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The identifier for the conversation as given by Intercom.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "ManageConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ManageConversationRequestIntercomVersion", + "value": { + "generatedName": "ManageConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ManageConversationRequest", + "request": { + "schema": { + "value": { + "commonProperties": [], + "discriminantProperty": "message_type", + "generatedName": "ManageConversationRequestBody", + "schemas": { + "close": { + "generatedName": "ComponentsSchemasCloseConversationRequest", + "schema": "close_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "snoozed": { + "generatedName": "ComponentsSchemasSnoozeConversationRequest", + "schema": "snooze_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "open": { + "generatedName": "ComponentsSchemasOpenConversationRequest", + "schema": "open_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "assignment": { + "generatedName": "ComponentsSchemasAssignConversationRequest", + "schema": "assign_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + }, + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Close a conversation", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267608, + "body": "Goodbye :)" + } + }, + { + "name": "Snooze a conversation", + "value": { + "message_type": "snoozed", + "admin_id": 991267610, + "snoozed_until": 1719496464 + } + }, + { + "name": "Open a conversation", + "value": { + "message_type": "open", + "admin_id": 991267612 + } + }, + { + "name": "Assign a conversation", + "value": { + "message_type": "assignment", + "type": "admin", + "admin_id": 991267615, + "assignee_id": 991267615 + } + }, + { + "name": "Not found", + "value": { + "message_type": "close", + "type": "admin", + "admin_id": 991267617, + "body": "Goodbye :)" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Assign a conversation", + "schema": { + "generatedName": "ManageConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Close a conversation", + "value": { + "type": "conversation", + "id": "394", + "created_at": 1719492862, + "updated_at": 1719492862, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918276", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267608", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60fd8a68186f43bafdfb", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "102", + "part_type": "close", + "body": "

Goodbye :)

", + "created_at": 1719492862, + "updated_at": 1719492862, + "notified_at": 1719492862, + "assigned_to": null, + "author": { + "id": "991267608", + "type": "admin", + "name": "Ciaran189 Lee", + "email": "admin189@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + }, + { + "name": "Snooze a conversation", + "value": { + "type": "conversation", + "id": "395", + "created_at": 1719492864, + "updated_at": 1719492864, + "waiting_since": null, + "snoozed_until": 1719496464, + "source": { + "type": "conversation", + "id": "403918277", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267610", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d60ff8a68186f43bafdfc", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "snoozed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "103", + "part_type": "snoozed", + "body": null, + "created_at": 1719492864, + "updated_at": 1719492864, + "notified_at": 1719492864, + "assigned_to": null, + "author": { + "id": "991267610", + "type": "admin", + "name": "Ciaran190 Lee", + "email": "admin190@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + }, + { + "name": "Open a conversation", + "value": { + "type": "conversation", + "id": "400", + "created_at": 1719492863, + "updated_at": 1719492873, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918278", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267612", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61038a68186f43bafe01", + "external_id": "74" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": "", + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "105", + "part_type": "open", + "body": null, + "created_at": 1719492873, + "updated_at": 1719492873, + "notified_at": 1719492873, + "assigned_to": null, + "author": { + "id": "991267612", + "type": "admin", + "name": "Ciaran191 Lee", + "email": "admin191@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + }, + { + "name": "Assign a conversation", + "value": { + "type": "conversation", + "id": "405", + "created_at": 1719492874, + "updated_at": 1719492875, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918281", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267615", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d610a8a68186f43bafe05", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": 991267615, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "106", + "part_type": "assign_and_reopen", + "body": null, + "created_at": 1719492875, + "updated_at": 1719492875, + "notified_at": 1719492875, + "assigned_to": { + "type": "admin", + "id": "991267615" + }, + "author": { + "id": "991267615", + "type": "admin", + "name": "Ciaran193 Lee", + "email": "admin193@email.com" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "ae0581d2-199e-437c-bf51-1eb9fe2e12fc", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a7e069bb-f013-45bc-8e0a-f58c3de4e034", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1bfc14e1-07ef-4999-9448-f029b112cf1b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "For managing conversations you can:\n- Close a conversation\n- Snooze a conversation to reopen on a future date\n- Open a conversation which is `snoozed` or `closed`\n- Assign a conversation to an admin and/or team.\n", + "authed": true, + "method": "POST", + "path": "/conversations/{id}/parts", + "examples": [ + { + "name": "Close a conversation", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "message_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "type": { + "value": "admin", + "type": "enum" + }, + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "4324241", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Goodbye :)", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "394", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918276", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267608", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran189 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin189@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60fd8a68186f43bafdfb", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "102", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "close", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Goodbye :)

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267608", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran189 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin189@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Snooze a conversation", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "message_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "type": { + "value": "admin", + "type": "enum" + }, + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "4324241", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Let me pass you over to one of my colleagues.", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "395", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492864, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492864, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1719496464, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "snoozed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918277", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267610", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran190 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin190@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60ff8a68186f43bafdfc", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "103", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "snoozed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492864, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492864, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492864, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267610", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran190 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin190@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Open a conversation", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "message_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "type": { + "value": "admin", + "type": "enum" + }, + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "4324241", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Let me pass you over to one of my colleagues.", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "400", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492863, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492873, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918278", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267612", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran191 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin191@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61038a68186f43bafe01", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "74", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "105", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492873, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492873, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492873, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267612", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran191 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin191@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Assign a conversation", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "message_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "type": { + "value": "admin", + "type": "enum" + }, + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "4324241", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Let me pass you over to one of my colleagues.", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "405", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492874, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492875, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 991267615, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918281", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267615", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran193 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin193@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d610a8a68186f43bafe05", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "106", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "assign_and_reopen", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492875, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492875, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492875, + "type": "int" + }, + "type": "primitive" + }, + "assigned_to": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267615", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267615", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran193 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin193@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "message_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "type": { + "value": "admin", + "type": "enum" + }, + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "4324241", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "Goodbye :)", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "394", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918276", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267608", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran189 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin189@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d60fd8a68186f43bafdfb", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "102", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "close", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Goodbye :)

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492862, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267608", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran189 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin189@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Run Assignment Rules on a conversation", + "audiences": [], + "operationId": "autoAssignConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The identifier for the conversation as given by Intercom.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "AutoAssignConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AutoAssignConversationRequestIntercomVersion", + "value": { + "generatedName": "AutoAssignConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AutoAssignConversationRequest", + "response": { + "description": "Assign a conversation using assignment rules", + "schema": { + "generatedName": "AutoAssignConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Assign a conversation using assignment rules", + "value": { + "type": "conversation", + "id": "409", + "created_at": 1719492880, + "updated_at": 1719492881, + "waiting_since": null, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918285", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267623", + "name": "Ciaran197 Lee", + "email": "admin197@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61108a68186f43bafe09", + "external_id": "70" + } + ] + }, + "first_contact_reply": null, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": false, + "state": "closed", + "read": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "107", + "part_type": "default_assignment", + "body": null, + "created_at": 1719492881, + "updated_at": 1719492881, + "notified_at": 1719492881, + "assigned_to": { + "type": "nobody_admin", + "id": null + }, + "author": { + "id": "991267624", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "external_id": null, + "redacted": false + } + ], + "total_count": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "037980c4-84cb-4d3a-ad64-66e4e563a275", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "9d88a5a7-6df9-42ff-b324-2387db7be984", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can let a conversation be automatically assigned following assignment rules.\n{% admonition type=\"attention\" name=\"When using workflows\" %}\nIt is not possible to use this endpoint with Workflows.\n{% /admonition %}\n", + "authed": true, + "method": "POST", + "path": "/conversations/{id}/run_assignment_rules", + "examples": [ + { + "name": "Assign a conversation using assignment rules", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "409", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492880, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492881, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "closed", + "type": "enum" + }, + "read": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918285", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267623", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran197 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin197@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61108a68186f43bafe09", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "107", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "default_assignment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492881, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492881, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492881, + "type": "int" + }, + "type": "primitive" + }, + "assigned_to": { + "properties": { + "type": { + "value": { + "value": "nobody_admin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "bot", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267624", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Attach a contact to a conversation", + "audiences": [], + "operationId": "attachContactToConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The identifier for the conversation as given by Intercom.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "AttachContactToConversationRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachContactToConversationRequestIntercomVersion", + "value": { + "generatedName": "AttachContactToConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachContactToConversationRequest", + "request": { + "schema": { + "generatedName": "AttachContactToConversationRequestBody", + "schema": "attach_contact_to_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Attach a contact to a conversation", + "value": { + "admin_id": 991267631, + "customer": { + "intercom_user_id": "667d61168a68186f43bafe0d" + } + } + }, + { + "name": "Not found", + "value": { + "admin_id": 991267633, + "customer": { + "intercom_user_id": "667d61188a68186f43bafe0e" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Attach a contact to a conversation", + "schema": { + "generatedName": "AttachContactToConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Attach a contact to a conversation", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61168a68186f43bafe0d" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "4f00c4c6-a8f7-436e-bf95-d1adfa315906", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3d1c3371-6ba4-4d5a-9368-ac983292136d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1fd64942-5bf0-4a51-a6cb-db4a778bb1f4", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "authed": true, + "method": "POST", + "path": "/conversations/{id}/customers", + "examples": [ + { + "name": "Attach a contact to a conversation", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "customer": { + "properties": { + "intercom_user_id": { + "value": { + "value": "667d61168a68186f43bafe0d", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "12345", + "type": "string" + }, + "type": "primitive" + }, + "customer": { + "properties": { + "intercom_user_id": { + "value": { + "value": "667d61188a68186f43bafe0e", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Detach a contact from a group conversation", + "audiences": [], + "operationId": "detachContactFromConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The identifier for the conversation as given by Intercom.", + "name": "conversation_id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "DetachContactFromConversationRequestConversationId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The identifier for the contact as given by Intercom.", + "name": "contact_id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "DetachContactFromConversationRequestContactId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachContactFromConversationRequestIntercomVersion", + "value": { + "generatedName": "DetachContactFromConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachContactFromConversationRequest", + "request": { + "schema": { + "generatedName": "DetachContactFromConversationRequestBody", + "schema": "detach_contact_from_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Detach a contact from a group conversation", + "value": { + "admin_id": 991267639, + "customer": { + "intercom_user_id": "667d611c8a68186f43bafe11" + } + } + }, + { + "name": "Conversation not found", + "value": { + "admin_id": 991267642, + "customer": { + "intercom_user_id": "667d61248a68186f43bafe1a" + } + } + }, + { + "name": "Contact not found", + "value": { + "admin_id": 991267645, + "customer": { + "intercom_user_id": "667d612b8a68186f43bafe22" + } + } + }, + { + "name": "Last customer", + "value": { + "admin_id": 991267648, + "customer": { + "intercom_user_id": "667d61338a68186f43bafe2a" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Detach a contact from a group conversation", + "schema": { + "generatedName": "DetachContactFromConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Detach a contact from a group conversation", + "value": { + "customers": [ + { + "type": "user", + "id": "667d61228a68186f43bafe19" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d35f1b37-765c-4afe-8738-81c0560710a6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d30f18d4-2e0a-4528-a66b-4590b733713c", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Contact not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Conversation not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "579f0f7a-d773-41d6-9d36-8cc0b3fbcc41", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Contact not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "44531412-2973-4b92-b14d-80abac5c1b4d", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "422": { + "generatedName": "UnprocessableEntityError", + "schema": { + "generatedName": "UnprocessableEntityErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Last customer", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Last customer", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Removing the last customer is not allowed", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.\n\n{% admonition type=\"attention\" name=\"Contacts without an email\" %}\nIf you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.\n{% /admonition %}\n\n", + "authed": true, + "method": "DELETE", + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "examples": [ + { + "name": "Detach a contact from a group conversation", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "contact_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "5017690", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Conversation not found", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "contact_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "5017690", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Contact not found", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "contact_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "5017690", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Last customer", + "pathParameters": [ + { + "name": "conversation_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "contact_id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "5017690", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "operator_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hey there!

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "274", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+abcd1234@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "3", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Redact a conversation part", + "audiences": [], + "operationId": "redactConversation", + "tags": [ + "Conversations" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RedactConversationRequestIntercomVersion", + "value": { + "generatedName": "RedactConversationRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RedactConversationRequest", + "request": { + "schema": { + "generatedName": "RedactConversationRequestBody", + "schema": "redact_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Redact a conversation part", + "value": { + "type": "conversation_part", + "conversation_id": 471, + "conversation_part_id": 115 + } + }, + { + "name": "Not found", + "value": { + "type": "conversation_part", + "conversation_id": "really_123_doesnt_exist", + "conversation_part_id": "really_123_doesnt_exist" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Redact a conversation part", + "schema": { + "generatedName": "RedactConversationResponse", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Redact a conversation part", + "value": { + "type": "conversation", + "id": "471", + "created_at": 1719492938, + "updated_at": 1719492940, + "waiting_since": 1719492939, + "snoozed_until": null, + "source": { + "type": "conversation", + "id": "403918311", + "delivered_as": "admin_initiated", + "subject": "", + "body": "

this is the message body

", + "author": { + "type": "admin", + "id": "991267657", + "name": "Ciaran217 Lee", + "email": "admin217@email.com" + }, + "attachments": [], + "url": null, + "redacted": false + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d614a8a68186f43bafe42", + "external_id": "70" + } + ] + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": null + }, + "admin_assignee_id": null, + "team_assignee_id": null, + "open": true, + "state": "open", + "read": true, + "tags": { + "type": "tag.list", + "tags": [] + }, + "priority": "not_priority", + "sla_applied": null, + "statistics": null, + "conversation_rating": null, + "teammates": null, + "title": null, + "custom_attributes": {}, + "topics": {}, + "ticket": null, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "ai_agent": null, + "ai_agent_participated": false, + "conversation_parts": { + "type": "conversation_part.list", + "conversation_parts": [ + { + "type": "conversation_part", + "id": "115", + "part_type": "open", + "body": "

This message was deleted

", + "created_at": 1719492939, + "updated_at": 1719492940, + "notified_at": 1719492939, + "assigned_to": null, + "author": { + "id": "667d614a8a68186f43bafe42", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "external_id": null, + "redacted": true + } + ], + "total_count": 1 + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1b830d07-a249-4ff8-a7bf-41bf83fd53b2", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0c016386-49f4-431f-92dc-7e739cbf98e1", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "conversation_part_or_message_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Conversation part or message not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can redact a conversation part or the source message of a conversation (as seen in the source object).\n\n{% admonition type=\"info\" name=\"Redacting parts and messages\" %}\nIf you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met.\n{% /admonition %}\n\n", + "authed": true, + "method": "POST", + "path": "/conversations/redact", + "examples": [ + { + "name": "Redact a conversation part", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "conversation_id": { + "value": { + "value": "19894788788", + "type": "string" + }, + "type": "primitive" + }, + "conversation_part_id": { + "value": { + "value": "19381789428", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "471", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492938, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492940, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918311", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267657", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran217 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin217@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d614a8a68186f43bafe42", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "115", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

This message was deleted

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492940, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d614a8a68186f43bafe42", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "conversation_id": { + "value": { + "value": "really_123_doesnt_exist", + "type": "string" + }, + "type": "primitive" + }, + "conversation_part_id": { + "value": { + "value": "really_123_doesnt_exist", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "471", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Conversation Title", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492938, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492940, + "type": "int" + }, + "type": "primitive" + }, + "waiting_since": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "state": { + "value": "open", + "type": "enum" + }, + "read": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "priority": { + "value": "not_priority", + "type": "enum" + }, + "admin_assignee_id": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "5017691", + "type": "string" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123456", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Test tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "conversation_rating": { + "properties": { + "rating": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "remark": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "teammate": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "source": { + "properties": { + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918311", + "type": "string" + }, + "type": "primitive" + }, + "delivered_as": { + "value": { + "value": "admin_initiated", + "type": "string" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

this is the message body

", + "type": "string" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267657", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran217 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin217@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "url", + "type": "string" + }, + "type": "primitive" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d614a8a68186f43bafe42", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "teammates": { + "properties": { + "type": { + "value": { + "value": "admin.list", + "type": "string" + }, + "type": "primitive" + }, + "teammates": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "first_contact_reply": { + "properties": { + "created_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "type": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://developers.intercom.com/", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "sla_applied": { + "properties": { + "type": { + "value": { + "value": "conversation_sla_summary", + "type": "string" + }, + "type": "primitive" + }, + "sla_name": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "sla_status": { + "value": "hit", + "type": "enum" + } + }, + "type": "object" + }, + "statistics": { + "properties": { + "type": { + "value": { + "value": "conversation_statistics", + "type": "string" + }, + "type": "primitive" + }, + "time_to_assignment": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_admin_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_first_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "time_to_last_close": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "median_time_to_reply": { + "value": { + "value": 2310, + "type": "int" + }, + "type": "primitive" + }, + "first_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "first_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_assignment_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_contact_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_admin_reply_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_close_at": { + "value": { + "value": 1663597233, + "type": "int" + }, + "type": "primitive" + }, + "last_closed_by_id": { + "value": { + "value": "c3po", + "type": "string" + }, + "type": "primitive" + }, + "count_reopens": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_assignments": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "count_conversation_parts": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "conversation_parts": { + "properties": { + "type": { + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "type": "literal" + }, + "conversation_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "conversation_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "115", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "open", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

This message was deleted

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492940, + "type": "int" + }, + "type": "primitive" + }, + "notified_at": { + "value": { + "value": 1719492939, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d614a8a68186f43bafe42", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ai_agent_participated": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ai_agent": { + "properties": { + "source_type": { + "value": "essentials_plan_setup", + "type": "enum" + }, + "source_title": { + "value": { + "value": "My AI Workflow", + "type": "string" + }, + "type": "primitive" + }, + "last_answer_type": { + "value": { + "value": "ai_answer", + "type": "string" + }, + "type": "primitive" + }, + "resolution_state": { + "value": { + "value": "assumed_resolution", + "type": "string" + }, + "type": "primitive" + }, + "rating": { + "value": { + "value": 4, + "type": "int" + }, + "type": "primitive" + }, + "rating_remark": { + "value": { + "value": "Very helpful!", + "type": "string" + }, + "type": "primitive" + }, + "content_sources": { + "properties": { + "type": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "content_sources": { + "value": [ + { + "properties": { + "url": { + "value": { + "value": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "My internal content snippet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Convert a conversation to a ticket", + "audiences": [], + "operationId": "convertConversationToTicket", + "tags": [ + "Conversations" + ], + "pathParameters": [ + { + "description": "The id of the conversation to target", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "ConvertConversationToTicketRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ConvertConversationToTicketRequestIntercomVersion", + "value": { + "generatedName": "ConvertConversationToTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ConvertConversationToTicketRequest", + "request": { + "schema": { + "generatedName": "ConvertConversationToTicketRequestBody", + "schema": "convert_conversation_to_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "ticket_type_id": "79" + } + }, + { + "name": "Bad request", + "value": { + "ticket_type_id": "80" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "ConvertConversationToTicketResponse", + "schema": "ticket", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "ticket", + "id": "474", + "ticket_id": "37", + "ticket_attributes": {}, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "79", + "name": "my-ticket-type-1", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + "archived": false, + "created_at": 1719492947, + "updated_at": 1719492947, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [] + }, + "category": "Customer" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61518a68186f43bafe45", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719492945, + "updated_at": 1719492947, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "117", + "part_type": "comment", + "body": "

Comment for message

", + "created_at": 1719492945, + "updated_at": 1719492945, + "author": { + "id": "667d61518a68186f43bafe45", + "type": "user", + "name": "Joe Bloggs", + "email": "joe@bloggs.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719492947, + "updated_at": 1719492947, + "author": { + "id": "991267667", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 2 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Customer", + "is_shared": true, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Bad request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Bad request", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "74656c1a-0a17-4c80-a7b9-66fa45c6d71b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Ticket type is not a customer ticket type", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can convert a conversation to a ticket.", + "authed": true, + "method": "POST", + "path": "/conversations/{id}/convert", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_type_id": { + "value": { + "value": "79", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "474", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "37", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "79", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-1", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id404_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61518a68186f43bafe45", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "117", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Comment for message

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "user", + "type": "enum" + }, + "id": { + "value": { + "value": "667d61518a68186f43bafe45", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267667", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Bad request", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_type_id": { + "value": { + "value": "80", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "474", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "37", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "79", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-1", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id404_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61518a68186f43bafe45", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "117", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Comment for message

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492945, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "user", + "type": "enum" + }, + "id": { + "value": { + "value": "667d61518a68186f43bafe45", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Joe Bloggs", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "joe@bloggs.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492947, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267667", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all data attributes", + "audiences": [], + "operationId": "lisDataAttributes", + "tags": [ + "Data Attributes" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "Specify the data attribute model to return.", + "name": "model", + "schema": { + "generatedName": "LisDataAttributesRequestModel", + "value": { + "generatedName": "LisDataAttributesRequestModel", + "values": [ + { + "generatedName": "contact", + "value": "contact", + "casing": {} + }, + { + "generatedName": "company", + "value": "company", + "casing": {} + }, + { + "generatedName": "conversation", + "value": "conversation", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "Include archived attributes in the list. By default we return only non archived data attributes.", + "name": "include_archived", + "schema": { + "generatedName": "LisDataAttributesRequestIncludeArchived", + "value": { + "schema": { + "type": "boolean" + }, + "generatedName": "LisDataAttributesRequestIncludeArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "LisDataAttributesRequestIntercomVersion", + "value": { + "generatedName": "LisDataAttributesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "LisDataAttributesRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "LisDataAttributesResponse", + "schema": "data_attribute_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "list", + "data": [ + { + "type": "data_attribute", + "name": "name", + "full_name": "name", + "label": "Company name", + "description": "The name of a company", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "company_id", + "full_name": "company_id", + "label": "Company ID", + "description": "A number identifying a company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "last_request_at", + "full_name": "last_request_at", + "label": "Company last seen", + "description": "The last day anyone from a company visited your site or app", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "remote_created_at", + "full_name": "remote_created_at", + "label": "Company created at", + "description": "The day a company was added to Intercom", + "data_type": "date", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "user_count", + "full_name": "user_count", + "label": "People", + "description": "The number of people in a company", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "session_count", + "full_name": "session_count", + "label": "Company web sessions", + "description": "All visits from anyone in a company to your product's site or app", + "data_type": "integer", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "name", + "full_name": "plan.name", + "label": "Plan", + "description": "A specific plan or level within your product that companies have signed up to", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "monthly_spend", + "full_name": "monthly_spend", + "label": "Monthly Spend", + "description": "The monthly revenue you receive from a company", + "data_type": "float", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "size", + "full_name": "size", + "label": "Company size", + "description": "The number of people employed in this company, expressed as a single number", + "data_type": "integer", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "industry", + "full_name": "industry", + "label": "Company industry", + "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "website", + "full_name": "website", + "label": "Company website", + "description": "The web address for the company's primary marketing site", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "id": 34, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267684", + "created_at": 1719492954, + "updated_at": 1719492954, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "id", + "label": "ID", + "description": "The Intercom defined id representing the company", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "created_at", + "full_name": "created_at", + "label": "Created at", + "description": "The time the company was added to Intercom", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "updated_at", + "full_name": "updated_at", + "label": "Updated at", + "description": "The last time the company was updated", + "data_type": "date", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "id", + "full_name": "plan.id", + "label": "Plan ID", + "description": "The Intercom defined id representing the plan", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + }, + { + "type": "data_attribute", + "name": "app_id", + "full_name": "app_id", + "label": "App ID", + "description": "The Intercom defined id representing the app", + "data_type": "string", + "api_writable": false, + "ui_writable": false, + "messenger_writable": true, + "custom": false, + "archived": false, + "model": "company" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6e76e914-a34d-4125-8310-62fdfc4e651e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "authed": true, + "method": "GET", + "path": "/data_attributes", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "name", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "name", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The name of a company", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "company_id", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "company_id", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company ID", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "A number identifying a company", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "last_request_at", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "last_request_at", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company last seen", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The last day anyone from a company visited your site or app", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "date", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "remote_created_at", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "remote_created_at", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company created at", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The day a company was added to Intercom", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "date", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "user_count", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "user_count", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "People", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The number of people in a company", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "integer", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "session_count", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "session_count", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company web sessions", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "All visits from anyone in a company to your product's site or app", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "integer", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "name", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "plan.name", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Plan", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "A specific plan or level within your product that companies have signed up to", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "monthly_spend", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "monthly_spend", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Monthly Spend", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The monthly revenue you receive from a company", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "float", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "size", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "size", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company size", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The number of people employed in this company, expressed as a single number", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "integer", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "industry", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "industry", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company industry", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "website", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "website", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Company website", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The web address for the company's primary marketing site", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 34, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492954, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492954, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267684", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "ID", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The Intercom defined id representing the company", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "created_at", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "created_at", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Created at", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The time the company was added to Intercom", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "date", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "updated_at", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "updated_at", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Updated at", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The last time the company was updated", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "date", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "plan.id", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Plan ID", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The Intercom defined id representing the plan", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 12878, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "app_id", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "app_id", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "App ID", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "The Intercom defined id representing the app", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1671028894, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "5712945", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a data attribute", + "audiences": [], + "operationId": "createDataAttribute", + "tags": [ + "Data Attributes" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateDataAttributeRequestIntercomVersion", + "value": { + "generatedName": "CreateDataAttributeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateDataAttributeRequest", + "request": { + "schema": { + "generatedName": "CreateDataAttributeRequestBody", + "schema": "create_data_attribute_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful", + "value": { + "name": "Mithril Shirt", + "model": "company", + "data_type": "string" + } + }, + { + "name": "Same name already exists", + "value": { + "name": "The One Ring", + "model": "contact", + "data_type": "integer" + } + }, + { + "name": "Invalid name", + "value": { + "name": "!nv@l!d n@me", + "model": "company", + "data_type": "string" + } + }, + { + "name": "Attribute already exists", + "value": { + "name": "The One Ring", + "model": "company", + "data_type": "string" + } + }, + { + "name": "Invalid Data Type", + "value": { + "name": "The Second Ring", + "model": "company", + "data_type": "mithril" + } + }, + { + "name": "Too few options for list", + "value": { + "description": "Just a plain old ring", + "options": [ + { + "value": "1-10" + } + ], + "archived": false + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful", + "schema": { + "generatedName": "CreateDataAttributeResponse", + "schema": "data_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "id": 37, + "type": "data_attribute", + "name": "Mithril Shirt", + "full_name": "custom_attributes.Mithril Shirt", + "label": "Mithril Shirt", + "data_type": "string", + "api_writable": true, + "ui_writable": false, + "messenger_writable": false, + "custom": true, + "archived": false, + "admin_id": "991267686", + "created_at": 1719492955, + "updated_at": 1719492955, + "model": "company" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Too few options for list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Same name already exists", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "bcd93885-3f01-4b92-9918-c96a3f4492e8", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Invalid name", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7420c5e3-22c3-46be-8a23-72fef8f8ec0e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Attribute already exists", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c844551a-05d3-4f8c-931a-32e96bf3a508", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Invalid Data Type", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b8c58b81-8445-473d-8fe3-7880c04f9547", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Data Type isn't an option", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Too few options for list", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "119e3822-3a45-48cf-b5ab-037f27a948c8", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "The Data Attribute model field must be either contact or company", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b74d8980-6e99-44db-a3d8-2a65a63fe590", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a data attributes for a `contact` or a `company`.", + "authed": true, + "method": "POST", + "path": "/data_attributes", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "data_type": { + "value": "string", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Same name already exists", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "contact", + "type": "enum" + }, + "data_type": { + "value": "integer", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Invalid name", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "!nv@l!d n@me", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "data_type": { + "value": "string", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Attribute already exists", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "data_type": { + "value": "string", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Invalid Data Type", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "The Second Ring", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "data_type": { + "value": "string", + "type": "enum" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Too few options for list", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "My Data Attribute", + "type": "string" + }, + "type": "primitive" + }, + "model": { + "value": "contact", + "type": "enum" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "options": { + "value": [ + { + "value": { + "value": "options", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 37, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "Mithril Shirt", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Whether the user is a paid subscriber.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "true", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "false", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492955, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267686", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a data attribute", + "audiences": [], + "operationId": "updateDataAttribute", + "tags": [ + "Data Attributes" + ], + "pathParameters": [ + { + "description": "The data attribute id", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "UpdateDataAttributeRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateDataAttributeRequestIntercomVersion", + "value": { + "generatedName": "UpdateDataAttributeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateDataAttributeRequest", + "request": { + "schema": { + "generatedName": "UpdateDataAttributeRequestBody", + "schema": "update_data_attribute_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful", + "value": { + "description": "Just a plain old ring", + "options": [ + { + "value": "1-10" + }, + { + "value": "11-20" + } + ], + "archived": false + } + }, + { + "name": "Too few options in list", + "value": { + "description": "Too few options", + "options": { + "value": "1-10" + }, + "archived": false + } + }, + { + "name": "Attribute Not Found", + "value": { + "description": "Just a plain old ring", + "options": [ + { + "value": "1-10" + }, + { + "value": "11-20" + } + ], + "archived": false + } + }, + { + "name": "Has Dependant Object", + "value": { + "description": "Trying to archieve", + "archived": true + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful", + "schema": { + "generatedName": "UpdateDataAttributeResponse", + "schema": "data_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "id": 44, + "type": "data_attribute", + "name": "The One Ring", + "full_name": "custom_attributes.The One Ring", + "label": "The One Ring", + "description": "Just a plain old ring", + "data_type": "string", + "options": [ + "1-10", + "11-20" + ], + "api_writable": true, + "ui_writable": false, + "messenger_writable": true, + "custom": true, + "archived": false, + "admin_id": "991267693", + "created_at": 1719492958, + "updated_at": 1719492959, + "model": "company" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Too few options in list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Too few options in list", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6615f20c-01df-443c-9ea1-c954ba6b09d6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Options isn't an array", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0cfc97c0-32be-4e68-aef2-f5744e4e85f7", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Attribute Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Attribute Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2680a225-4f79-4098-8438-8db993c639fe", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "field_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "We couldn't find that data attribute to update", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "422": { + "generatedName": "UnprocessableEntityError", + "schema": { + "generatedName": "UnprocessableEntityErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Has Dependant Object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Has Dependant Object", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fbc508f1-9cbf-4134-90ea-baa1065760d2", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "data_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "The Data Attribute you are trying to archive has a dependant object", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\nYou can update a data attribute.\n\n> 🚧 Updating the data type is not possible\n>\n> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.\n", + "authed": true, + "method": "PUT", + "path": "/data_attributes/{id}", + "examples": [ + { + "name": "Successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "options": { + "value": [ + { + "value": { + "value": "options", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "options", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 44, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "1-10", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "11-20", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492958, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492959, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267693", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Too few options in list", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Too few options", + "type": "string" + }, + "type": "primitive" + }, + "options": { + "value": [ + { + "value": { + "value": "option1", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "option2", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 44, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "1-10", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "11-20", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492958, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492959, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267693", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Attribute Not Found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "options": { + "value": [ + { + "value": { + "value": "options", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "options", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 44, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "1-10", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "11-20", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492958, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492959, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267693", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Has Dependant Object", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "archived": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Trying to archieve", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "data_attribute", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": 44, + "type": "int" + }, + "type": "primitive" + }, + "model": { + "value": "company", + "type": "enum" + }, + "name": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "full_name": { + "value": { + "value": "custom_attributes.The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "label": { + "value": { + "value": "The One Ring", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Just a plain old ring", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "options": { + "value": [ + { + "value": { + "value": "1-10", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "11-20", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "api_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "messenger_writable": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ui_writable": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "custom": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492958, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492959, + "type": "int" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "991267693", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all data events", + "audiences": [], + "operationId": "lisDataEvents", + "tags": [ + "Data Events" + ], + "pathParameters": [], + "queryParameters": [ + { + "name": "filter", + "schema": { + "value": { + "generatedName": "LisDataEventsRequestFilter", + "schemas": [ + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "lisDataEventsRequestFilterUserIdUserId", + "key": "user_id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "LisDataEventsRequestFilterUserIdUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "LisDataEventsRequestFilterUserId", + "title": "user_id query parameter", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "lisDataEventsRequestFilterIntercomUserIdIntercomUserId", + "key": "intercom_user_id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "LisDataEventsRequestFilterIntercomUserIdIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "LisDataEventsRequestFilterIntercomUserId", + "title": "intercom_user_id query parameter", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "lisDataEventsRequestFilterEmailEmail", + "key": "email", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "LisDataEventsRequestFilterEmailEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "LisDataEventsRequestFilterEmail", + "title": "email query parameter", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The value must be user", + "name": "type", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "LisDataEventsRequestType", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "summary flag", + "name": "summary", + "schema": { + "generatedName": "LisDataEventsRequestSummary", + "value": { + "schema": { + "type": "boolean" + }, + "generatedName": "LisDataEventsRequestSummary", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "LisDataEventsRequestIntercomVersion", + "value": { + "generatedName": "LisDataEventsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "LisDataEventsRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "LisDataEventsResponse", + "schema": "data_event_summary", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "event.summary", + "events": [], + "pages": { + "next": "http://api.intercom.test/events?next page" + }, + "email": "user26@email.com", + "intercom_user_id": "667d61648a68186f43bafe4b", + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "bfdcc6de-2dcb-4725-acc7-232c10838586", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\n> 🚧\n>\n> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days\n\nThe events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)\n\nThe `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou can optionally define the result page size as well with the `per_page` parameter.\n", + "authed": true, + "method": "GET", + "path": "/events", + "examples": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Submit a data event", + "audiences": [], + "operationId": "createDataEvent", + "tags": [ + "Data Events" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateDataEventRequestIntercomVersion", + "value": { + "generatedName": "CreateDataEventRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateDataEventRequest", + "request": { + "schema": { + "generatedName": "CreateDataEventRequestBody", + "schema": "create_data_event_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c6b3dcbd-33be-4a80-abb4-c5b3315250d0", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\nYou will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.\n\nWhen using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.\n\nWith the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).\n\n**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**\n\n| Type | Description | Example |\n| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |\n| String | The value is a JSON String | `\"source\":\"desktop\"` |\n| Number | The value is a JSON Number | `\"load\": 3.67` |\n| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `\"contact_date\": 1392036272` |\n| Link | The value is a HTTP or HTTPS URI. | `\"article\": \"https://example.org/ab1de.html\"` |\n| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `\"article\": {\"url\": \"https://example.org/ab1de.html\", \"value\":\"the dude abides\"}` |\n| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `\"price\": {\"amount\": 34999, \"currency\": \"eur\"}` |\n\n**Lead Events**\n\nWhen submitting events for Leads, you will need to specify the Lead's `id`.\n\n**Metadata behaviour**\n\n- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.\n- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.\n- There might be up to 24 hrs delay when you send a new metadata for an existing event.\n\n**Event de-duplication**\n\nThe API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.\n\nDuplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.\n\n### HTTP API Responses\n\n- Successful responses to submitted events return `202 Accepted` with an empty body.\n- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.\n- Events sent about users that cannot be found will return a `404 Not Found`.\n- Event lists containing duplicate events will have those duplicates ignored.\n- Server errors will return a `500` response code and may contain an error message in the body.\n\n", + "authed": true, + "method": "POST", + "path": "/events", + "examples": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create event summaries", + "audiences": [], + "operationId": "dataEventSummaries", + "tags": [ + "Data Events" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DataEventSummariesRequestIntercomVersion", + "value": { + "generatedName": "DataEventSummariesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DataEventSummariesRequest", + "request": { + "schema": { + "generatedName": "DataEventSummariesRequestBody", + "schema": "create_data_event_summaries_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "110801d1-2f7b-436f-8f03-2245545a1432", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.\n\n", + "authed": true, + "method": "POST", + "path": "/events/summaries", + "examples": [ + { + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": {}, + "type": "object" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create content data export", + "audiences": [], + "operationId": "createDataExport", + "tags": [ + "Data Export" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateDataExportRequestIntercomVersion", + "value": { + "generatedName": "CreateDataExportRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateDataExportRequest", + "request": { + "schema": { + "generatedName": "CreateDataExportRequestBody", + "schema": "create_data_exports_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "created_at_after": 1719474967, + "created_at_before": 1719492967 + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "CreateDataExportResponse", + "schema": "data_export", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "job_identifier": "bxe9awlish03jkq8", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe only parameters you need to provide are the range of dates that you want exported.\n\n>🚧 Limit of one active job\n>\n> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.\n\n>📘 Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.\n", + "authed": true, + "method": "POST", + "path": "/export/content/data", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "created_at_after": { + "value": { + "value": 1719474967, + "type": "int" + }, + "type": "primitive" + }, + "created_at_before": { + "value": { + "value": 1719492967, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "job_identfier": { + "value": { + "value": "orzzsbd7hk67xyu", + "type": "string" + }, + "type": "primitive" + }, + "status": { + "value": "pending", + "type": "enum" + }, + "download_expires_at": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "download_url": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Show content data export", + "audiences": [], + "operationId": "getDataExport", + "tags": [ + "Data Export" + ], + "pathParameters": [ + { + "description": "job_identifier", + "name": "job_identifier", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "GetDataExportRequestJobIdentifier", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "GetDataExportRequestIntercomVersion", + "value": { + "generatedName": "GetDataExportRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "GetDataExportRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "GetDataExportResponse", + "schema": "data_export", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "job_identifier": "b1ppo8h93fj386fk", + "status": "pending", + "download_url": "", + "download_expires_at": "" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can view the status of your job by sending a `GET` request to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.\n\n> 🚧 Jobs expire after two days\n> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.\n", + "authed": true, + "method": "GET", + "path": "/export/content/data/{job_identifier}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "job_identifier", + "value": { + "value": { + "value": "job_identifier", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "job_identfier": { + "value": { + "value": "orzzsbd7hk67xyu", + "type": "string" + }, + "type": "primitive" + }, + "status": { + "value": "pending", + "type": "enum" + }, + "download_expires_at": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "download_url": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Cancel content data export", + "audiences": [], + "operationId": "cancelDataExport", + "tags": [ + "Data Export" + ], + "pathParameters": [ + { + "description": "job_identifier", + "name": "job_identifier", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "CancelDataExportRequestJobIdentifier", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CancelDataExportRequestIntercomVersion", + "value": { + "generatedName": "CancelDataExportRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CancelDataExportRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "CancelDataExportResponse", + "schema": "data_export", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "job_identifier": "pwrbmmimhakvlfsh", + "status": "canceled", + "download_url": "", + "download_expires_at": "" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can cancel your job", + "authed": true, + "method": "POST", + "path": "/export/cancel/{job_identifier}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "job_identifier", + "value": { + "value": { + "value": "job_identifier", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "job_identfier": { + "value": { + "value": "orzzsbd7hk67xyu", + "type": "string" + }, + "type": "primitive" + }, + "status": { + "value": "canceled", + "type": "enum" + }, + "download_expires_at": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "download_url": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Download content data export", + "audiences": [], + "operationId": "downloadDataExport", + "tags": [ + "Data Export" + ], + "pathParameters": [ + { + "description": "job_identifier", + "name": "job_identifier", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "DownloadDataExportRequestJobIdentifier", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DownloadDataExportRequestIntercomVersion", + "value": { + "generatedName": "DownloadDataExportRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DownloadDataExportRequest", + "errors": {}, + "server": [], + "description": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message data will be streamed continuously back down to you in a gzipped CSV format.\n\n> 📘 Octet header required\n>\n> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.\n", + "authed": true, + "method": "GET", + "path": "/download/content/data/{job_identifier}", + "examples": [ + { + "pathParameters": [ + { + "name": "job_identifier", + "value": { + "value": { + "value": "job_identifier", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a message", + "audiences": [], + "operationId": "createMessage", + "tags": [ + "Messages" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateMessageRequestIntercomVersion", + "value": { + "generatedName": "CreateMessageRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateMessageRequest", + "request": { + "schema": { + "generatedName": "CreateMessageRequestBody", + "schema": "create_message_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "user message created", + "value": { + "from": { + "type": "user", + "id": "667d61698a68186f43bafe50" + }, + "body": "heyy", + "referer": "https://twitter.com/bob" + } + }, + { + "name": "lead message created", + "value": { + "from": { + "type": "lead", + "id": "667d616a8a68186f43bafe51" + }, + "body": "heyy", + "referer": "https://twitter.com/bob" + } + }, + { + "name": "admin message created", + "value": { + "from": { + "type": "admin", + "id": "991267716" + }, + "to": { + "type": "user", + "id": "667d616c8a68186f43bafe52" + }, + "message_type": "conversation", + "body": "heyy" + } + }, + { + "name": "No body supplied for message", + "value": { + "from": { + "type": "admin", + "id": "991267718" + }, + "to": { + "type": "user", + "id": "667d616d8a68186f43bafe53" + }, + "message_type": "inapp", + "body": null, + "subject": "heyy" + } + }, + { + "name": "No subject supplied for email message", + "value": { + "from": { + "type": "admin", + "id": "991267719" + }, + "to": { + "type": "user", + "user_id": "70" + }, + "message_type": "email", + "body": "hey there" + } + }, + { + "name": "No body supplied for email message", + "value": { + "from": { + "type": "admin", + "id": "991267720" + }, + "to": { + "type": "user", + "id": "667d616e8a68186f43bafe55" + }, + "message_type": "email", + "body": null, + "subject": "heyy" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "admin message created", + "schema": { + "generatedName": "CreateMessageResponse", + "schema": "message", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "user message created", + "value": { + "type": "user_message", + "id": "403918316", + "created_at": 1719492969, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "476" + } + }, + { + "name": "lead message created", + "value": { + "type": "user_message", + "id": "403918317", + "created_at": 1719492971, + "body": "heyy", + "message_type": "inapp", + "conversation_id": "477" + } + }, + { + "name": "admin message created", + "value": { + "type": "admin_message", + "id": "15", + "created_at": 1719492972, + "subject": "heyy", + "body": "heyy", + "message_type": "inapp", + "owner": { + "type": "admin", + "id": "991267716", + "name": "Ciaran269 Lee", + "email": "admin269@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + } + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "No body supplied for email message", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "No body supplied for message", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Body is required", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "No body supplied for email message", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7d54191b-c0fc-4860-a01c-9da6b4e45b7f", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Body is required", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "ee3ea56e-d0ce-47db-871a-57740e165e5c", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "403": { + "generatedName": "ForbiddenError", + "schema": { + "generatedName": "ForbiddenErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "API plan restricted", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "API plan restricted", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fab7034a-78bd-4413-a652-8f38783e7bf1", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "api_plan_restricted", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Active subscription needed.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "422": { + "generatedName": "UnprocessableEntityError", + "schema": { + "generatedName": "UnprocessableEntityErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "No subject supplied for email message", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "No subject supplied for email message", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f54ba906-3255-4fc6-a660-0dab0043ff2b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "No subject supplied for email message", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.\n\n> 🚧 Sending for visitors\n>\n> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.\n\nThis will return the Message model that has been created.\n\n> 🚧 Retrieving Associated Conversations\n>\n> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.\n", + "authed": true, + "method": "POST", + "path": "/messages", + "examples": [ + { + "name": "user message created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d61698a68186f43bafe50", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "body", + "type": "string" + }, + "value": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "referer", + "type": "string" + }, + "value": { + "value": { + "value": "https://twitter.com/bob", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918316", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492969, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "476", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "lead message created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "lead", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d616a8a68186f43bafe51", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "body", + "type": "string" + }, + "value": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "referer", + "type": "string" + }, + "value": { + "value": { + "value": "https://twitter.com/bob", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918317", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492971, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "477", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "admin message created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "991267716", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "to", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d616c8a68186f43bafe52", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "message_type", + "type": "string" + }, + "value": { + "value": { + "value": "conversation", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "body", + "type": "string" + }, + "value": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "admin_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "15", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492972, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "64619700005570", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "No body supplied for message", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "991267718", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "to", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d616d8a68186f43bafe53", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "message_type", + "type": "string" + }, + "value": { + "value": { + "value": "inapp", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "subject", + "type": "string" + }, + "value": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918316", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492969, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "476", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "No subject supplied for email message", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "991267719", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "to", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "user_id", + "type": "string" + }, + "value": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "message_type", + "type": "string" + }, + "value": { + "value": { + "value": "email", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "body", + "type": "string" + }, + "value": { + "value": { + "value": "hey there", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918316", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492969, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "476", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "No body supplied for email message", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "from", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "991267720", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "to", + "type": "string" + }, + "value": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d616e8a68186f43bafe55", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "key": { + "value": "message_type", + "type": "string" + }, + "value": { + "value": { + "value": "email", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "subject", + "type": "string" + }, + "value": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "user_message", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "403918316", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492969, + "type": "int" + }, + "type": "primitive" + }, + "subject": { + "value": { + "value": "Greetings", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "heyy", + "type": "string" + }, + "type": "primitive" + }, + "message_type": { + "value": "inapp", + "type": "enum" + }, + "conversation_id": { + "value": { + "value": "476", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all news items", + "audiences": [], + "operationId": "listNewsItems", + "tags": [ + "News" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListNewsItemsRequestIntercomVersion", + "value": { + "generatedName": "ListNewsItemsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListNewsItemsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListNewsItemsResponse", + "schema": "paginated_response", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "29", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267725, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + }, + { + "id": "30", + "type": "news-item", + "workspace_id": "this_is_an_id494_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267727, + "state": "draft", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492976, + "updated_at": 1719492976, + "newsfeed_assignments": [] + } + ], + "total_count": 2 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7b27151d-7bb0-402e-87fe-5780690d9f32", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all news items", + "authed": true, + "method": "GET", + "path": "/news/news_items", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": "list", + "type": "enum" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 10, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "29", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "My Newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492976, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492976, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "30", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "My Newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492976, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492976, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a news item", + "audiences": [], + "operationId": "createNewsItem", + "tags": [ + "News" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateNewsItemRequestIntercomVersion", + "value": { + "generatedName": "CreateNewsItemRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateNewsItemRequest", + "request": { + "schema": { + "generatedName": "CreateNewsItemRequestBody", + "schema": "news_item_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "labels": [ + "Product", + "Update", + "New" + ], + "sender_id": 991267734, + "deliver_silently": true, + "reactions": [ + "😆", + "😅" + ], + "state": "live", + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "CreateNewsItemResponse", + "schema": "news_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "33", + "type": "news-item", + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + "title": "Halloween is here!", + "body": "

New costumes in store for this spooky season

", + "sender_id": 991267734, + "state": "live", + "labels": [ + "New", + "Product", + "Update" + ], + "cover_image_url": null, + "reactions": [ + "😆", + "😅" + ], + "deliver_silently": true, + "created_at": 1719492978, + "updated_at": 1719492978, + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214 + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c36202f1-6bf3-4ea6-9442-192123f506b0", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a news item", + "authed": true, + "method": "POST", + "path": "/news/news_items", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Halloween is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New costumes in store for this spooky season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267734, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "deliver_silently": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "labels": { + "value": [ + { + "value": { + "value": "Product", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "Update", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "New", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😆", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😅", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "newsfeed_assignments": { + "value": [ + { + "properties": { + "newsfeed_id": { + "value": { + "value": 53, + "type": "int" + }, + "type": "primitive" + }, + "published_at": { + "value": { + "value": 1664638214, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "33", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id498_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Halloween is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New costumes in store for this spooky season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267734, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "newsfeed_assignments": { + "value": [ + { + "properties": { + "newsfeed_id": { + "value": { + "value": 53, + "type": "int" + }, + "type": "primitive" + }, + "published_at": { + "value": { + "value": 1664638214, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "labels": { + "value": [ + { + "value": { + "value": "New", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "Product", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "Update", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "cover_image_url": { + "value": { + "value": "https://example.com/cover.jpg", + "type": "string" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😆", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😅", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "deliver_silently": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492978, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492978, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a news item", + "audiences": [], + "operationId": "retrieveNewsItem", + "tags": [ + "News" + ], + "pathParameters": [ + { + "description": "The unique identifier for the news item which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveNewsItemRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveNewsItemRequestIntercomVersion", + "value": { + "generatedName": "RetrieveNewsItemRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveNewsItemRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "RetrieveNewsItemResponse", + "schema": "news_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "34", + "type": "news-item", + "workspace_id": "this_is_an_id502_that_should_be_at_least_", + "title": "We have news", + "body": "

Hello there,

", + "sender_id": 991267737, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + null, + null, + null, + null + ], + "deliver_silently": false, + "created_at": 1719492979, + "updated_at": 1719492979, + "newsfeed_assignments": [ + { + "newsfeed_id": 55, + "published_at": 1719492980 + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "cc6af01d-81e3-4a74-8a62-807a3239e1ad", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "News Item Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "News Item Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0f4b439e-9b57-4019-886e-15cc08582914", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single news item.", + "authed": true, + "method": "GET", + "path": "/news/news_items/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "34", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id502_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "We have news", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

Hello there,

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267737, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "newsfeed_assignments": { + "value": [ + { + "properties": { + "newsfeed_id": { + "value": { + "value": 55, + "type": "int" + }, + "type": "primitive" + }, + "published_at": { + "value": { + "value": 1719492980, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "labels": { + "value": [ + { + "value": { + "value": "Product Update", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "cover_image_url": { + "value": { + "value": "https://example.com/cover.jpg", + "type": "string" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "👍", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "👍", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "👍", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "👍", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "deliver_silently": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492979, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492979, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a news item", + "audiences": [], + "operationId": "updateNewsItem", + "tags": [ + "News" + ], + "pathParameters": [ + { + "description": "The unique identifier for the news item which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "UpdateNewsItemRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateNewsItemRequestIntercomVersion", + "value": { + "generatedName": "UpdateNewsItemRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateNewsItemRequest", + "request": { + "schema": { + "generatedName": "UpdateNewsItemRequestBody", + "schema": "news_item_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "reactions": [ + "😝", + "😂" + ] + } + }, + { + "name": "News Item Not Found", + "value": { + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267748, + "reactions": [ + "😝", + "😂" + ] + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "UpdateNewsItemResponse", + "schema": "news_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "37", + "type": "news-item", + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + "title": "Christmas is here!", + "body": "

New gifts in store for the jolly season

", + "sender_id": 991267745, + "state": "live", + "labels": [], + "cover_image_url": null, + "reactions": [ + "😝", + "😂" + ], + "deliver_silently": false, + "created_at": 1719492982, + "updated_at": 1719492982, + "newsfeed_assignments": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f780a591-4aa2-4382-80c4-e0f2d655bf2e", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "News Item Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "News Item Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fe6e217d-70bc-4090-b33a-b32ec0e6a391", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "authed": true, + "method": "PUT", + "path": "/news/news_items/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267745, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😝", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😂", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "37", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id508_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267745, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "newsfeed_assignments": { + "value": [ + { + "properties": { + "newsfeed_id": { + "value": { + "value": 198313, + "type": "int" + }, + "type": "primitive" + }, + "published_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "labels": { + "value": [ + { + "value": { + "value": "Product Update", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "cover_image_url": { + "value": { + "value": "https://example.com/cover.jpg", + "type": "string" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😝", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😂", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "deliver_silently": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492982, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492982, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "News Item Not Found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267748, + "type": "int" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😝", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😂", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "37", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id508_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "title": { + "value": { + "value": "Christmas is here!", + "type": "string" + }, + "type": "primitive" + }, + "body": { + "value": { + "value": "

New gifts in store for the jolly season

", + "type": "string" + }, + "type": "primitive" + }, + "sender_id": { + "value": { + "value": 991267745, + "type": "int" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "newsfeed_assignments": { + "value": [ + { + "properties": { + "newsfeed_id": { + "value": { + "value": 198313, + "type": "int" + }, + "type": "primitive" + }, + "published_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "labels": { + "value": [ + { + "value": { + "value": "Product Update", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "cover_image_url": { + "value": { + "value": "https://example.com/cover.jpg", + "type": "string" + }, + "type": "primitive" + }, + "reactions": { + "value": [ + { + "value": { + "value": "😝", + "type": "string" + }, + "type": "primitive" + }, + { + "value": { + "value": "😂", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "deliver_silently": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492982, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492982, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete a news item", + "audiences": [], + "operationId": "deleteNewsItem", + "tags": [ + "News" + ], + "pathParameters": [ + { + "description": "The unique identifier for the news item which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "DeleteNewsItemRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteNewsItemRequestIntercomVersion", + "value": { + "generatedName": "DeleteNewsItemRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteNewsItemRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "DeleteNewsItemResponse", + "schema": "deleted_object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "40", + "object": "news-item", + "deleted": true + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "News Item Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "News Item Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a191b999-6f71-4676-a8db-1a79ccc4f114", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete a single news item.", + "authed": true, + "method": "DELETE", + "path": "/news/news_items/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "40", + "type": "string" + }, + "type": "primitive" + }, + "object": { + "value": { + "value": "news-item", + "type": "string" + }, + "type": "literal" + }, + "deleted": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all live newsfeed items", + "audiences": [], + "operationId": "listLiveNewsfeedItems", + "tags": [ + "News" + ], + "pathParameters": [ + { + "description": "The unique identifier for the news feed item which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "ListLiveNewsfeedItemsRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListLiveNewsfeedItemsRequestIntercomVersion", + "value": { + "generatedName": "ListLiveNewsfeedItemsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListLiveNewsfeedItemsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListLiveNewsfeedItemsResponse", + "schema": "paginated_response", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 20, + "total_pages": 0, + "type": "pages" + }, + "data": [], + "total_count": 0 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all news items that are live on a given newsfeed", + "authed": true, + "method": "GET", + "path": "/news/newsfeeds/{id}/items", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": "list", + "type": "enum" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 20, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "12312", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "My Newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1674917488, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all newsfeeds", + "audiences": [], + "operationId": "listNewsfeeds", + "tags": [ + "News" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListNewsfeedsRequestIntercomVersion", + "value": { + "generatedName": "ListNewsfeedsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListNewsfeedsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListNewsfeedsResponse", + "schema": "paginated_response", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "pages": { + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages" + }, + "data": [ + { + "id": "68", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + }, + { + "id": "69", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492987, + "updated_at": 1719492987 + } + ], + "total_count": 2 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d00f8d67-1e7c-464b-b0b7-b2409d706076", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all newsfeeds", + "authed": true, + "method": "GET", + "path": "/news/newsfeeds", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": "list", + "type": "enum" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 10, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "total_count": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "68", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Visitor Feed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492987, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492987, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + { + "value": { + "value": { + "type": { + "value": { + "value": "newsfeed", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "69", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Visitor Feed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492987, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492987, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "discriminated" + }, + "type": "oneOf" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a newsfeed", + "audiences": [], + "operationId": "retrieveNewsfeed", + "tags": [ + "News" + ], + "pathParameters": [ + { + "description": "The unique identifier for the news feed item which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "RetrieveNewsfeedRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveNewsfeedRequestIntercomVersion", + "value": { + "generatedName": "RetrieveNewsfeedRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveNewsfeedRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "RetrieveNewsfeedResponse", + "schema": "newsfeed", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "72", + "type": "newsfeed", + "name": "Visitor Feed", + "created_at": 1719492988, + "updated_at": 1719492988 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "185ce494-34e2-4cda-85cb-c51ad7281292", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single newsfeed", + "authed": true, + "method": "GET", + "path": "/news/newsfeeds/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "id": { + "value": { + "value": "72", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Visitor Feed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492988, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492988, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a note", + "audiences": [], + "operationId": "retrieveNote", + "tags": [ + "Notes" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given note", + "name": "id", + "schema": { + "schema": { + "type": "int" + }, + "generatedName": "RetrieveNoteRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveNoteRequestIntercomVersion", + "value": { + "generatedName": "RetrieveNoteRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveNoteRequest", + "response": { + "description": "Note found", + "schema": { + "generatedName": "RetrieveNoteResponse", + "schema": "note", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Note found", + "value": { + "type": "note", + "id": "37", + "created_at": 1718801789, + "contact": { + "type": "contact", + "id": "667d617d8a68186f43bafe58" + }, + "author": { + "type": "admin", + "id": "991267764", + "name": "Ciaran316 Lee", + "email": "admin316@email.com", + "away_mode_enabled": false, + "away_mode_reassign": false + }, + "body": "

This is a note.

" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b29ebc05-ba35-4db8-aac6-d74617769643", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Note not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Note not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7e37eb4e-9f1e-47fa-a393-8d9b2c20983a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single note.", + "authed": true, + "method": "GET", + "path": "/notes/{id}", + "examples": [ + { + "name": "Note found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "37", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1718801789, + "type": "int" + }, + "type": "primitive" + }, + "contact": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d617d8a68186f43bafe58", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267764", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran316 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin316@email.com", + "type": "string" + }, + "type": "primitive" + }, + "job_title": { + "value": { + "value": "Philosopher", + "type": "string" + }, + "type": "primitive" + }, + "away_mode_enabled": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "away_mode_reassign": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_inbox_seat": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "avatar": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "team_priority_level": { + "properties": { + "primary_team_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_team_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "body": { + "value": { + "value": "

This is a note.

", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all segments", + "audiences": [], + "operationId": "listSegments", + "tags": [ + "Segments" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "It includes the count of contacts that belong to each segment.", + "name": "include_count", + "schema": { + "generatedName": "ListSegmentsRequestIncludeCount", + "value": { + "schema": { + "type": "boolean" + }, + "generatedName": "ListSegmentsRequestIncludeCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListSegmentsRequestIntercomVersion", + "value": { + "generatedName": "ListSegmentsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListSegmentsRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "ListSegmentsResponse", + "schema": "segment_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "segment.list", + "segments": [ + { + "type": "segment", + "id": "667d617f8a68186f43bafe5b", + "name": "John segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + }, + { + "type": "segment", + "id": "667d617f8a68186f43bafe5c", + "name": "Jane segment", + "created_at": 1719492991, + "updated_at": 1719492991, + "person_type": "user" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d70c184d-852a-4f67-8298-3cf9a327adb3", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all segments.", + "authed": true, + "method": "GET", + "path": "/segments", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d617f8a68186f43bafe5b", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John segment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492991, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492991, + "type": "int" + }, + "type": "primitive" + }, + "person_type": { + "value": "user", + "type": "enum" + }, + "count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d617f8a68186f43bafe5c", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Jane segment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492991, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492991, + "type": "int" + }, + "type": "primitive" + }, + "person_type": { + "value": "user", + "type": "enum" + }, + "count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "pages": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a segment", + "audiences": [], + "operationId": "retrieveSegment", + "tags": [ + "Segments" + ], + "pathParameters": [ + { + "description": "The unique identified of a given segment.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "RetrieveSegmentRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveSegmentRequestIntercomVersion", + "value": { + "generatedName": "RetrieveSegmentRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveSegmentRequest", + "response": { + "description": "Successful response", + "schema": { + "generatedName": "RetrieveSegmentResponse", + "schema": "segment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "segment", + "id": "667d61808a68186f43bafe5f", + "name": "John segment", + "created_at": 1719492992, + "updated_at": 1719492992, + "person_type": "user" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a9c190ff-16eb-43f9-94fc-7c22da2766af", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Segment not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Segment not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fe79fa5e-c8eb-40a6-be76-d618833c2840", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single segment.", + "authed": true, + "method": "GET", + "path": "/segments/{id}", + "examples": [ + { + "name": "Successful response", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "segment", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61808a68186f43bafe5f", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John segment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719492992, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719492992, + "type": "int" + }, + "type": "primitive" + }, + "person_type": { + "value": "user", + "type": "enum" + }, + "count": { + "value": { + "value": 3, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List subscription types", + "audiences": [], + "operationId": "listSubscriptionTypes", + "tags": [ + "Subscription Types" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListSubscriptionTypesRequestIntercomVersion", + "value": { + "generatedName": "ListSubscriptionTypesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListSubscriptionTypesRequest", + "response": { + "description": "Successful", + "schema": { + "generatedName": "ListSubscriptionTypesResponse", + "schema": "subscription_type_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful", + "value": { + "type": "list", + "data": [ + { + "type": "subscription", + "id": "137", + "state": "live", + "consent_type": "opt_out", + "default_translation": { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + }, + "translations": [ + { + "name": "Newsletters", + "description": "Lorem ipsum dolor sit amet", + "locale": "en" + } + ], + "content_types": [ + "email" + ] + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "5fb6b003-d6a6-4641-b71b-c5c468c87448", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can list all subscription types. A list of subscription type objects will be returned.", + "authed": true, + "method": "GET", + "path": "/subscription_types", + "examples": [ + { + "name": "Successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "subscription", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "137", + "type": "string" + }, + "type": "primitive" + }, + "state": { + "value": "live", + "type": "enum" + }, + "default_translation": { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "translations": { + "value": [ + { + "properties": { + "name": { + "value": { + "value": "Newsletters", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Lorem ipsum dolor sit amet", + "type": "string" + }, + "type": "primitive" + }, + "locale": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "consent_type": { + "value": "opt_out", + "type": "enum" + }, + "content_types": { + "value": [ + { + "value": "email", + "type": "enum" + } + ], + "type": "array" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a phone Switch", + "audiences": [], + "operationId": "createPhoneSwitch", + "tags": [ + "Switch" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreatePhoneSwitchRequestIntercomVersion", + "value": { + "generatedName": "CreatePhoneSwitchRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreatePhoneSwitchRequest", + "request": { + "schema": { + "generatedName": "CreatePhoneSwitchRequestBody", + "schema": "create_phone_switch_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "phone": "+353832345678", + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + }, + { + "name": "bad request - exception sending sms", + "value": { + "phone": "+353832345678", + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + }, + { + "name": "bad request - invalid number", + "value": { + "phone": "+353832345678", + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + }, + { + "name": "unprocessable entity", + "value": { + "phone": "+40241100100", + "custom_attributes": { + "issue_type": "Billing", + "priority": "High" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "CreatePhoneSwitchResponse", + "schema": "phone_switch", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "url": "http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12", + "type": "phone_call_redirect" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "type": "unknown" + }, + "description": "bad request - invalid number", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "bad request - exception sending sms", + "example": { + "value": [ + { + "key": { + "value": "error_key", + "type": "string" + }, + "value": { + "value": { + "value": "sms_failed", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "SMS was not sent due to an unknown error", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + { + "name": "bad request - invalid number", + "example": { + "value": [ + { + "key": { + "value": "error_key", + "type": "string" + }, + "value": { + "value": { + "value": "invalid_phone_number", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Invalid phone number", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "5da7a3e7-dcb0-4378-8575-0a0e9bae3862", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "422": { + "generatedName": "UnprocessableEntityError", + "schema": { + "generatedName": "UnprocessableEntityErrorBody", + "type": "unknown" + }, + "description": "unprocessable entity", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "unprocessable entity", + "example": { + "value": [ + { + "key": { + "value": "error_key", + "type": "string" + }, + "value": { + "value": { + "value": "some_error", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can use the API to deflect phone calls to the Intercom Messenger.\nCalling this endpoint will send an SMS with a link to the Messenger to the phone number specified.\n\nIf custom attributes are specified, they will be added to the user or lead's custom data attributes.\n", + "authed": true, + "method": "POST", + "path": "/phone_call_redirects", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "phone": { + "value": { + "value": "+353832345678", + "type": "string" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "phone_call_redirect", + "type": "string" + }, + "type": "literal" + }, + "phone": { + "value": { + "value": "+1 1234567890", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "bad request - exception sending sms", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "phone": { + "value": { + "value": "+353832345678", + "type": "string" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "phone_call_redirect", + "type": "string" + }, + "type": "literal" + }, + "phone": { + "value": { + "value": "+1 1234567890", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "bad request - invalid number", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "phone": { + "value": { + "value": "+353832345678", + "type": "string" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "phone_call_redirect", + "type": "string" + }, + "type": "literal" + }, + "phone": { + "value": { + "value": "+1 1234567890", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "unprocessable entity", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "phone": { + "value": { + "value": "+40241100100", + "type": "string" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "issue_type", + "type": "string" + }, + "value": { + "value": { + "value": "Billing", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "priority", + "type": "string" + }, + "value": { + "value": { + "value": "High", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "phone_call_redirect", + "type": "string" + }, + "type": "literal" + }, + "phone": { + "value": { + "value": "+1 1234567890", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all tags", + "audiences": [], + "operationId": "listTags", + "tags": [ + "Tags" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListTagsRequestIntercomVersion", + "value": { + "generatedName": "ListTagsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListTagsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListTagsResponse", + "schema": "tag_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [ + { + "type": "tag", + "id": "115", + "name": "Manual tag 1" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c83a3efe-433a-4555-a5e2-e393588be29f", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch a list of all tags for a given workspace.\n\n", + "authed": true, + "method": "GET", + "path": "/tags", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "115", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag 1", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create or update a tag, Tag or untag companies, Tag contacts", + "audiences": [], + "operationId": "createTag", + "tags": [ + "Tags" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateTagRequestIntercomVersion", + "value": { + "generatedName": "CreateTagRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateTagRequest", + "request": { + "schema": { + "value": { + "generatedName": "CreateTagRequestBody", + "schemas": [ + { + "generatedName": "CreateTagRequestBodyZero", + "schema": "create_or_update_tag_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "CreateTagRequestBodyOne", + "schema": "tag_company_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "CreateTagRequestBodyTwo", + "schema": "untag_company_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "CreateTagRequestBodyThree", + "schema": "tag_multiple_users_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Action successful", + "value": { + "name": "test" + } + }, + { + "name": "Invalid parameters", + "value": { + "test": "invalid" + } + }, + { + "name": "Company not found", + "value": { + "name": "test", + "companies": [ + { + "company_id": "123" + } + ] + } + }, + { + "name": "User not found", + "value": { + "name": "test", + "users": [ + { + "id": "123" + } + ] + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Action successful", + "schema": { + "generatedName": "CreateTagResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Action successful", + "value": { + "type": "tag", + "id": "118", + "name": "test" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Invalid parameters", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Invalid parameters", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a7afe3c5-be52-4b69-9268-50ef1d917a1b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_invalid", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "invalid tag parameters", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3609e8b1-a6aa-4c57-a994-3d95743f20a2", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "User not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Company not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "f0f84d9b-3c51-4904-9c21-34faba76ebf5", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "company_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Company Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "User not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "786848c6-5b9f-4e9b-aa78-2bdec45a09f5", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can use this endpoint to perform the following operations:\n\n **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in \"Create or Update Tag Request Payload\" described below.\n\n **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in \"Create or Update Tag Request Payload\" described below.\n\n **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in \"Tag Company Request Payload\" described below. Also, if the tag doesn't exist then a new one will be created automatically.\n\n **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in \"Untag Company Request Payload\" described below.\n\n **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in \"Tag Users Request Payload\" described below.\n\nEach operation will return a tag object.\n", + "authed": true, + "method": "POST", + "path": "/tags", + "examples": [ + { + "name": "Action successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Invalid parameters", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Independent", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Company not found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "companies": { + "value": [ + { + "properties": { + "company_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "User not found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "users": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "118", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "test", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Find a specific tag", + "audiences": [], + "operationId": "findTag", + "tags": [ + "Tags" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given tag", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "FindTagRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "FindTagRequestIntercomVersion", + "value": { + "generatedName": "FindTagRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "FindTagRequest", + "response": { + "description": "Tag found", + "schema": { + "generatedName": "FindTagResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Tag found", + "value": { + "type": "tag", + "id": "126", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "76a1d79d-3f0d-49bb-8d15-38d1ae6df738", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Tag not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "20b89fb6-f224-4f81-98ca-4cb4b36df959", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of tags that are on the workspace by their id.\nThis will return a tag object.\n", + "authed": true, + "method": "GET", + "path": "/tags/{id}", + "examples": [ + { + "name": "Tag found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "126", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Delete tag", + "audiences": [], + "operationId": "deleteTag", + "tags": [ + "Tags" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given tag", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "DeleteTagRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DeleteTagRequestIntercomVersion", + "value": { + "generatedName": "DeleteTagRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DeleteTagRequest", + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag has dependent objects", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Tag has dependent objects", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "41086388-9b3b-4e07-9633-502b9b10c926", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "tag_has_dependent_objects", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Unable to delete Tag with dependent objects. Segments: Seg 1.", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3dcedf54-ed30-4337-8992-94e36900e695", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Resource not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Resource not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "111586bb-ad78-43b9-b0a0-bf864d9a3744", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can delete the details of tags that are on the workspace by passing in the id.", + "authed": true, + "method": "DELETE", + "path": "/tags/{id}", + "examples": [ + { + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all teams", + "audiences": [], + "operationId": "listTeams", + "tags": [ + "Teams" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListTeamsRequestIntercomVersion", + "value": { + "generatedName": "ListTeamsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListTeamsRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListTeamsResponse", + "schema": "team_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "team.list", + "teams": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "006b2c8f-9a29-463e-be69-ad213576aee6", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "This will return a list of team objects for the App.", + "authed": true, + "method": "GET", + "path": "/teams", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "team.list", + "type": "string" + }, + "type": "literal" + }, + "teams": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "team", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "814865", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Example Team", + "type": "string" + }, + "type": "primitive" + }, + "admin_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a team", + "audiences": [], + "operationId": "retrieveTeam", + "tags": [ + "Teams" + ], + "pathParameters": [ + { + "description": "The unique identifier of a given team.", + "name": "id", + "schema": { + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "RetrieveTeamRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveTeamRequestIntercomVersion", + "value": { + "generatedName": "RetrieveTeamRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveTeamRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "RetrieveTeamResponse", + "schema": "team", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "team", + "id": "991267802", + "name": "team 1", + "admin_ids": [] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "110ad8e4-99ed-461a-bd93-92a5cdbaa6b2", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Team not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Team not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "4745dfce-7275-4864-abfd-44e0d84bf52a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "team_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Team not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "authed": true, + "method": "GET", + "path": "/teams/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "team", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267802", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "team 1", + "type": "string" + }, + "type": "primitive" + }, + "admin_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "admin_priority_level": { + "properties": { + "primary_admin_ids": { + "value": [ + { + "value": { + "value": 493881, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + }, + "secondary_admin_ids": { + "value": [ + { + "value": { + "value": 814865, + "type": "int" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a new attribute for a ticket type", + "audiences": [], + "operationId": "createTicketTypeAttribute", + "tags": [ + "Ticket Type Attributes" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket type which is given by Intercom.", + "name": "ticket_type_id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "CreateTicketTypeAttributeRequestTicketTypeId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateTicketTypeAttributeRequestIntercomVersion", + "value": { + "generatedName": "CreateTicketTypeAttributeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateTicketTypeAttributeRequest", + "request": { + "schema": { + "generatedName": "CreateTicketTypeAttributeRequestBody", + "schema": "create_ticket_type_attribute_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Ticket Type Attribute created", + "value": { + "name": "Attribute Title", + "description": "Attribute Description", + "data_type": "string", + "required_to_create": false + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Ticket Type Attribute created", + "schema": { + "generatedName": "CreateTicketTypeAttributeResponse", + "schema": "ticket_type_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket Type Attribute created", + "value": { + "type": "ticket_type_attribute", + "id": "210", + "workspace_id": "this_is_an_id600_that_should_be_at_least_", + "name": "Attribute Title", + "description": "Attribute Description", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 2, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": false, + "ticket_type_id": 81, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493013 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "3bc672fa-e051-4ede-b6e9-79f518231ba9", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new attribute for a ticket type.", + "authed": true, + "method": "POST", + "path": "/ticket_types/{ticket_type_id}/attributes", + "examples": [ + { + "name": "Ticket Type Attribute created", + "pathParameters": [ + { + "name": "ticket_type_id", + "value": { + "value": { + "value": "ticket_type_id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Attribute Title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Attribute Description", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": "string", + "type": "enum" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_type_attribute", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "210", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id600_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Attribute Title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Attribute Description", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": { + "value": "string", + "type": "string" + }, + "type": "primitive" + }, + "input_options": { + "value": [ + { + "key": { + "value": "multiline", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "order": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "required_to_create_for_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_on_create": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_to_contacts": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "default": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_type_id": { + "value": { + "value": 81, + "type": "int" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493013, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493013, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update an existing attribute for a ticket type", + "audiences": [], + "operationId": "updateTicketTypeAttribute", + "tags": [ + "Ticket Type Attributes" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket type which is given by Intercom.", + "name": "ticket_type_id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateTicketTypeAttributeRequestTicketTypeId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The unique identifier for the ticket type attribute which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateTicketTypeAttributeRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateTicketTypeAttributeRequestIntercomVersion", + "value": { + "generatedName": "UpdateTicketTypeAttributeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateTicketTypeAttributeRequest", + "request": { + "schema": { + "generatedName": "UpdateTicketTypeAttributeRequestBody", + "schema": "update_ticket_type_attribute_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Ticket Type Attribute updated", + "value": { + "description": "New Attribute Description" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Ticket Type Attribute updated", + "schema": { + "generatedName": "UpdateTicketTypeAttributeResponse", + "schema": "ticket_type_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket Type Attribute updated", + "value": { + "type": "ticket_type_attribute", + "id": "215", + "workspace_id": "this_is_an_id604_that_should_be_at_least_", + "name": "name", + "description": "New Attribute Description", + "data_type": "string", + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 83, + "archived": false, + "created_at": 1719493013, + "updated_at": 1719493014 + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "6e45414c-e627-4769-bdbd-d51f2c19e1e9", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update an existing attribute for a ticket type.", + "authed": true, + "method": "PUT", + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "examples": [ + { + "name": "Ticket Type Attribute updated", + "pathParameters": [ + { + "name": "ticket_type_id", + "value": { + "value": { + "value": "ticket_type_id", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "description": { + "value": { + "value": "New Attribute Description", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_type_attribute", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "215", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id604_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "name", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "New Attribute Description", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": { + "value": "string", + "type": "string" + }, + "type": "primitive" + }, + "input_options": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "order": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "required_to_create_for_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_on_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_to_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "default": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_type_id": { + "value": { + "value": 83, + "type": "int" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493013, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493014, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "List all ticket types", + "audiences": [], + "operationId": "listTicketTypes", + "tags": [ + "Ticket Types" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ListTicketTypesRequestIntercomVersion", + "value": { + "generatedName": "ListTicketTypesRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ListTicketTypesRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "ListTicketTypesResponse", + "schema": "ticket_type_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "list", + "data": [ + { + "type": "ticket_type", + "id": "85", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "218", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "220", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + }, + { + "type": "ticket_type_attribute", + "id": "219", + "workspace_id": "this_is_an_id608_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 85, + "archived": false, + "created_at": 1719493014, + "updated_at": 1719493014 + } + ] + }, + "category": "Customer" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "50823491-2ab1-4b84-9700-2d92c4f367fd", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can get a list of all ticket types for a workspace.", + "authed": true, + "method": "GET", + "path": "/ticket_types", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + }, + "ticket_types": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1295", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "Bug", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "A bug that has been reported.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🐞", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a ticket type", + "audiences": [], + "operationId": "createTicketType", + "tags": [ + "Ticket Types" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateTicketTypeRequestIntercomVersion", + "value": { + "generatedName": "CreateTicketTypeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateTicketTypeRequest", + "request": { + "schema": { + "generatedName": "CreateTicketTypeRequestBody", + "schema": "create_ticket_type_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Ticket type created", + "value": { + "name": "Customer Issue", + "description": "Customer Report Template", + "icon": "🎟️", + "category": "Customer" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Ticket type created", + "schema": { + "generatedName": "CreateTicketTypeResponse", + "schema": "ticket_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket type created", + "value": { + "type": "ticket_type", + "id": "88", + "name": "Customer Issue", + "description": "Customer Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "227", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + }, + { + "type": "ticket_type_attribute", + "id": "228", + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 88, + "archived": false, + "created_at": 1719493016, + "updated_at": 1719493016 + } + ] + }, + "category": "Customer" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7c4784fe-d3e4-4182-b9c4-918bdf253eef", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new ticket type.\n> 📘 Creating ticket types.\n>\n> Every ticket type will be created with two default attributes: _default_title_ and _default_description_.\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "authed": true, + "method": "POST", + "path": "/ticket_types", + "examples": [ + { + "name": "Ticket type created", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Customer Issue", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Customer Report Template", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "icon": { + "value": { + "value": "🎟️", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "88", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "Customer Issue", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Customer Report Template", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🎟️", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id612_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_type_attribute", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Bug title.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": { + "value": "string", + "type": "string" + }, + "type": "primitive" + }, + "input_options": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "required_to_create_for_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_on_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_to_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "default": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_type_id": { + "value": { + "value": 42, + "type": "int" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493016, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493016, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a ticket type", + "audiences": [], + "operationId": "getTicketType", + "tags": [ + "Ticket Types" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket type which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "GetTicketTypeRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "GetTicketTypeRequestIntercomVersion", + "value": { + "generatedName": "GetTicketTypeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "GetTicketTypeRequest", + "response": { + "description": "Ticket type found", + "schema": { + "generatedName": "GetTicketTypeResponse", + "schema": "ticket_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket type found", + "value": { + "type": "ticket_type", + "id": "90", + "name": "Bug Report", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "232", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "234", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + }, + { + "type": "ticket_type_attribute", + "id": "233", + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 90, + "archived": false, + "created_at": 1719493017, + "updated_at": 1719493017 + } + ] + }, + "category": "Customer" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b0100f38-119c-4e30-8560-a25561d97c66", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single ticket type.", + "authed": true, + "method": "GET", + "path": "/ticket_types/{id}", + "examples": [ + { + "name": "Ticket type found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "90", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "Bug Report", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Bug Report Template", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🎟️", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id616_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_type_attribute", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Bug title.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": { + "value": "string", + "type": "string" + }, + "type": "primitive" + }, + "input_options": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "required_to_create_for_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_on_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_to_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "default": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_type_id": { + "value": { + "value": 42, + "type": "int" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493017, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493017, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a ticket type", + "audiences": [], + "operationId": "updateTicketType", + "tags": [ + "Ticket Types" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket type which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateTicketTypeRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateTicketTypeRequestIntercomVersion", + "value": { + "generatedName": "UpdateTicketTypeRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateTicketTypeRequest", + "request": { + "schema": { + "generatedName": "UpdateTicketTypeRequestBody", + "schema": "update_ticket_type_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Ticket type updated", + "value": { + "name": "Bug Report 2" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Ticket type updated", + "schema": { + "generatedName": "UpdateTicketTypeResponse", + "schema": "ticket_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket type updated", + "value": { + "type": "ticket_type", + "id": "92", + "name": "Bug Report 2", + "description": "Bug Report Template", + "icon": "🎟️", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "238", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_title_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": false + }, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "240", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "name", + "description": "description", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": false, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + }, + { + "type": "ticket_type_attribute", + "id": "239", + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + "name": "_default_description_", + "description": "", + "data_type": "string", + "input_options": { + "multiline": true + }, + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": true, + "default": true, + "ticket_type_id": 92, + "archived": false, + "created_at": 1719493018, + "updated_at": 1719493018 + } + ] + }, + "category": "Customer" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "2b0554fe-ba10-41d4-ab7b-715c2b7b8e47", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "\nYou can update a ticket type.\n\n> 📘 Updating a ticket type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "authed": true, + "method": "PUT", + "path": "/ticket_types/{id}", + "examples": [ + { + "name": "Ticket type updated", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "name": { + "value": { + "value": "Bug Report 2", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "92", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Customer", + "type": "enum" + }, + "name": { + "value": { + "value": "Bug Report 2", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Bug Report Template", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🎟️", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id620_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_type_attribute", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Title", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "Bug title.", + "type": "string" + }, + "type": "primitive" + }, + "data_type": { + "value": { + "value": "string", + "type": "string" + }, + "type": "primitive" + }, + "input_options": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "order": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "required_to_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "required_to_create_for_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_on_create": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "visible_to_contacts": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "default": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_type_id": { + "value": { + "value": 42, + "type": "int" + }, + "type": "primitive" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493018, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493018, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Reply to a ticket", + "audiences": [], + "operationId": "replyTicket", + "tags": [ + "Tickets" + ], + "pathParameters": [ + { + "name": "id", + "schema": { + "description": "The id of the ticket to target.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "ReplyTicketRequestId", + "title": "Ticket ID", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ReplyTicketRequestIntercomVersion", + "value": { + "generatedName": "ReplyTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ReplyTicketRequest", + "request": { + "schema": { + "value": { + "generatedName": "ReplyTicketRequestBody", + "schemas": [ + { + "generatedName": "ReplyTicketRequestBodyZero", + "schema": "contact_reply_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ReplyTicketRequestBodyOne", + "schema": "admin_reply_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "User reply", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d619d8a68186f43bafe82", + "body": "Thanks again :)" + } + }, + { + "name": "Admin note reply", + "value": { + "message_type": "note", + "type": "admin", + "admin_id": 991267829, + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
" + } + }, + { + "name": "Admin quick_reply reply", + "value": { + "message_type": "quick_reply", + "type": "admin", + "admin_id": 991267834, + "reply_options": [ + { + "text": "Yes", + "uuid": "22d6d1f4-1a19-41d0-94c2-e54031f78aca" + }, + { + "text": "No", + "uuid": "fbc3dbe0-ec0c-4fb6-826d-e19127191906" + } + ] + } + }, + { + "name": "Not found", + "value": { + "message_type": "comment", + "type": "user", + "intercom_user_id": "667d61a68a68186f43bafe85", + "body": "Thanks again :)" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Admin quick_reply reply", + "schema": { + "generatedName": "ReplyTicketResponse", + "schema": "ticket_reply", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Admin note reply", + "value": { + "type": "ticket_part", + "id": "122", + "part_type": "note", + "body": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "created_at": 1719493024, + "updated_at": 1719493024, + "author": { + "id": "991267829", + "type": "admin", + "name": "Ciaran375 Lee", + "email": "admin375@email.com" + }, + "attachments": [], + "redacted": false + } + }, + { + "name": "Admin quick_reply reply", + "value": { + "type": "ticket_part", + "id": "124", + "part_type": "quick_reply", + "created_at": 1719493029, + "updated_at": 1719493029, + "author": { + "id": "991267834", + "type": "admin", + "name": "Ciaran379 Lee", + "email": "admin379@email.com" + }, + "attachments": [], + "redacted": false + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "400": { + "generatedName": "BadRequestError", + "schema": { + "generatedName": "BadRequestErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "User reply", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "User reply", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "b8b42c55-347c-4704-b4c1-92220c01f4ac", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "parameter_mismatch", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "User replies are not allowed on Backoffice tickets", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "bb012854-cca8-4fa7-972e-6c38204e8294", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "c23e8dab-6102-483c-bb1b-c62923be35ab", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Resource Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "authed": true, + "method": "POST", + "path": "/tickets/{id}/reply", + "examples": [ + { + "name": "User reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "literal" + }, + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "Thanks again :)", + "type": "string" + }, + "type": "primitive" + }, + "intercom_user_id": { + "value": { + "value": "667d619d8a68186f43bafe82", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "122", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": "note", + "type": "enum" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267829", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran375 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin375@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin note reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": "note", + "type": "enum" + }, + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "3156780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "122", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": "note", + "type": "enum" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267829", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran375 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin375@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin quick_reply reply", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": "quick_reply", + "type": "enum" + }, + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "literal" + }, + "admin_id": { + "value": { + "value": "3156780", + "type": "string" + }, + "type": "primitive" + }, + "reply_options": { + "value": [ + { + "properties": { + "text": { + "value": { + "value": "Yes", + "type": "string" + }, + "type": "primitive" + }, + "uuid": { + "value": { + "value": "22d6d1f4-1a19-41d0-94c2-e54031f78aca", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "text": { + "value": { + "value": "No", + "type": "string" + }, + "type": "primitive" + }, + "uuid": { + "value": { + "value": "fbc3dbe0-ec0c-4fb6-826d-e19127191906", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "124", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": "quick_reply", + "type": "enum" + }, + "body": { + "value": { + "value": "

Okay!

", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493029, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493029, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267834", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran379 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin379@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "message_type": { + "value": { + "value": "comment", + "type": "string" + }, + "type": "literal" + }, + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "literal" + }, + "body": { + "value": { + "value": "Thanks again :)", + "type": "string" + }, + "type": "primitive" + }, + "intercom_user_id": { + "value": { + "value": "667d61a68a68186f43bafe85", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "122", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": "note", + "type": "enum" + }, + "body": { + "value": { + "value": "

An Unordered HTML List

\n
    \n
  • Coffee
  • \n
  • Tea
  • \n
  • Milk
  • \n
\n

An Ordered HTML List

\n
    \n
  1. Coffee
  2. \n
  3. Tea
  4. \n
  5. Milk
  6. \n
", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493024, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267829", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran375 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin375@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Add tag to a ticket", + "audiences": [], + "operationId": "attachTagToTicket", + "tags": [ + "Tags", + "Tickets" + ], + "pathParameters": [ + { + "description": "ticket_id", + "name": "ticket_id", + "schema": { + "schema": { + "example": "64619700005694", + "type": "string" + }, + "generatedName": "AttachTagToTicketRequestTicketId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "AttachTagToTicketRequestIntercomVersion", + "value": { + "generatedName": "AttachTagToTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "AttachTagToTicketRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachTagToTicketRequestId", + "key": "id", + "schema": { + "description": "The unique identifier for the tag which is given by Intercom", + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "AttachTagToTicketRequestId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachTagToTicketRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The unique identifier for the admin which is given by Intercom.", + "schema": { + "example": "780", + "type": "string" + }, + "generatedName": "AttachTagToTicketRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachTagToTicketRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "id": 134, + "admin_id": 991267844 + } + }, + { + "name": "Ticket not found", + "value": { + "id": 135, + "admin_id": 991267847 + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "AttachTagToTicketResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "134", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "a502f48f-c80d-48fd-bea5-cafe7e24d9f9", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Ticket not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Ticket not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "ticket_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Ticket not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "authed": true, + "method": "POST", + "path": "/tickets/{ticket_id}/tags", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "ticket_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "134", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Ticket not found", + "pathParameters": [ + { + "name": "ticket_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "id": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + }, + "admin_id": { + "value": { + "value": "780", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "134", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Remove tag from a ticket", + "audiences": [], + "operationId": "detachTagFromTicket", + "tags": [ + "Tags", + "Tickets" + ], + "pathParameters": [ + { + "description": "ticket_id", + "name": "ticket_id", + "schema": { + "schema": { + "example": "64619700005694", + "type": "string" + }, + "generatedName": "DetachTagFromTicketRequestTicketId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "description": "The unique identifier for the tag which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "example": "7522907", + "type": "string" + }, + "generatedName": "DetachTagFromTicketRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "DetachTagFromTicketRequestIntercomVersion", + "value": { + "generatedName": "DetachTagFromTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "DetachTagFromTicketRequest", + "request": { + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "detachTagFromTicketRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The unique identifier for the admin which is given by Intercom.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "DetachTagFromTicketRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "DetachTagFromTicketRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "admin_id": 991267853 + } + }, + { + "name": "Ticket not found", + "value": { + "admin_id": 991267856 + } + }, + { + "name": "Tag not found", + "value": { + "admin_id": 991267859 + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "DetachTagFromTicketResponse", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "tag", + "id": "137", + "name": "Manual tag" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Tag not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Ticket not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "ffa08bb4-3994-4132-b9e3-14837e0723e8", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "ticket_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Ticket not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Tag not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "d2385995-502c-4c03-bf4b-93ef3d24037b", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "tag_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Tag not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "authed": true, + "method": "DELETE", + "path": "/tickets/{ticket_id}/tags/{id}", + "examples": [ + { + "name": "successful", + "pathParameters": [ + { + "name": "ticket_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "137", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Ticket not found", + "pathParameters": [ + { + "name": "ticket_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "137", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Tag not found", + "pathParameters": [ + { + "name": "ticket_id", + "value": { + "value": { + "value": "64619700005694", + "type": "string" + }, + "type": "primitive" + } + }, + { + "name": "id", + "value": { + "value": { + "value": "7522907", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "tag", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "137", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Manual tag", + "type": "string" + }, + "type": "primitive" + }, + "applied_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "applied_by": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "1a2b3c", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Create a ticket", + "audiences": [], + "operationId": "createTicket", + "tags": [ + "Tickets" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "CreateTicketRequestIntercomVersion", + "value": { + "generatedName": "CreateTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "CreateTicketRequest", + "request": { + "schema": { + "generatedName": "CreateTicketRequestBody", + "schema": "create_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful response", + "value": { + "ticket_type_id": 106, + "contacts": [ + { + "id": "667d61b78a68186f43bafe8d" + } + ], + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful response", + "schema": { + "generatedName": "CreateTicketResponse", + "schema": "ticket", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "ticket", + "id": "489", + "ticket_id": "48", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "106", + "name": "my-ticket-type-15", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "252", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + }, + { + "type": "ticket_type_attribute", + "id": "253", + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 106, + "archived": false, + "created_at": 1719493047, + "updated_at": 1719493047 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61b78a68186f43bafe8d", + "external_id": "70" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493048, + "updated_at": 1719493048, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "125", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493048, + "updated_at": 1719493048, + "author": { + "id": "991267871", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "745c921a-7c5a-40d4-ab28-6d28a8d2ed47", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can create a new ticket.", + "authed": true, + "method": "POST", + "path": "/tickets", + "examples": [ + { + "name": "Successful response", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_type_id": { + "value": { + "value": "1234", + "type": "string" + }, + "type": "primitive" + }, + "contacts": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "667d61b78a68186f43bafe8d", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "489", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "48", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "106", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-15", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id648_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493047, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493047, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61b78a68186f43bafe8d", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "70", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493048, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493048, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "125", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493048, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493048, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267871", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a ticket", + "audiences": [], + "operationId": "getTicket", + "tags": [ + "Tickets" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket which is given by Intercom.", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "GetTicketRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "GetTicketRequestIntercomVersion", + "value": { + "generatedName": "GetTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "GetTicketRequest", + "response": { + "description": "Ticket found", + "schema": { + "generatedName": "GetTicketResponse", + "schema": "ticket", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Ticket found", + "value": { + "type": "ticket", + "id": "493", + "ticket_id": "52", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "112", + "name": "my-ticket-type-21", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "268", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + }, + { + "type": "ticket_type_attribute", + "id": "269", + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 112, + "archived": false, + "created_at": 1719493060, + "updated_at": 1719493060 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c48a68186f43bafe91", + "external_id": "038050f6-d917-4b9d-89cb-539b1d371172" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493061, + "updated_at": 1719493061, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "134", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493061, + "updated_at": 1719493061, + "author": { + "id": "991267912", + "type": "admin", + "name": "Ciaran445 Lee", + "email": "admin445@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e7ba89f2-3bc8-4fc3-97bc-56f62f342680", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single ticket.", + "authed": true, + "method": "GET", + "path": "/tickets/{id}", + "examples": [ + { + "name": "Ticket found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "493", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "52", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "attribute_value", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "ticket_attributes", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "112", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-21", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id660_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493060, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493060, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61c48a68186f43bafe91", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "038050f6-d917-4b9d-89cb-539b1d371172", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493061, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493061, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "134", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493061, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493061, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267912", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran445 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin445@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a ticket", + "audiences": [], + "operationId": "updateTicket", + "tags": [ + "Tickets" + ], + "pathParameters": [ + { + "description": "The unique identifier for the ticket which is given by Intercom", + "name": "id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateTicketRequestId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateTicketRequestIntercomVersion", + "value": { + "generatedName": "UpdateTicketRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateTicketRequest", + "request": { + "schema": { + "generatedName": "UpdateTicketRequestBody", + "schema": "update_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "Successful response", + "value": { + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "state": "in_progress", + "assignment": { + "admin_id": "991267883", + "assignee_id": "991267885" + }, + "open": true, + "snoozed_until": 1673609604 + } + }, + { + "name": "Admin not found", + "value": { + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "state": "in_progress", + "assignment": { + "admin_id": "123", + "assignee_id": "991267893" + } + } + }, + { + "name": "Assignee not found", + "value": { + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "state": "in_progress", + "assignment": { + "admin_id": "991267899", + "assignee_id": "456" + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "Successful response", + "schema": { + "generatedName": "UpdateTicketResponse", + "schema": "ticket", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "Successful response", + "value": { + "type": "ticket", + "id": "490", + "ticket_id": "49", + "ticket_attributes": { + "_default_title_": "example", + "_default_description_": "there is a problem" + }, + "ticket_state": "in_progress", + "ticket_type": { + "type": "ticket_type", + "id": "108", + "name": "my-ticket-type-17", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "257", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + }, + { + "type": "ticket_type_attribute", + "id": "258", + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 108, + "archived": false, + "created_at": 1719493050, + "updated_at": 1719493050 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61bb8a68186f43bafe8e", + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08" + } + ] + }, + "admin_assignee_id": "991267885", + "team_assignee_id": "0", + "created_at": 1719493051, + "updated_at": 1719493054, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493051, + "updated_at": 1719493051, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "in_progress", + "previous_ticket_state": "submitted", + "created_at": 1719493053, + "updated_at": 1719493053, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "130", + "part_type": "assignment", + "created_at": 1719493054, + "updated_at": 1719493054, + "assigned_to": { + "type": "admin", + "id": "991267885" + }, + "author": { + "id": "991267883", + "type": "admin", + "name": "Ciaran419 Lee", + "email": "admin419@email.com" + }, + "attachments": [], + "redacted": false + }, + { + "type": "ticket_part", + "id": "131", + "part_type": "snoozed", + "created_at": 1719493054, + "updated_at": 1719493054, + "author": { + "id": "991267884", + "type": "bot", + "name": "Operator", + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 6 + }, + "open": true, + "snoozed_until": 1719590400, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "In progress", + "ticket_state_external_label": "In progress" + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "e5202025-e8f9-400a-9107-192ae8bfd50c", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "type": "unknown" + }, + "description": "Assignee not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Admin not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "809aceaa-c073-4e2a-96c3-a25e15576946", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "assignee_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Assignee not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + }, + { + "name": "Assignee not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "639b5b51-1eb9-4c06-8de4-d9b0e30fff05", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "assignee_not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Assignee not found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can update a ticket.", + "authed": true, + "method": "PUT", + "path": "/tickets/{id}", + "examples": [ + { + "name": "Successful response", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "state": { + "value": "in_progress", + "type": "enum" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1673609604, + "type": "int" + }, + "type": "primitive" + }, + "assignment": { + "properties": { + "admin_id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "490", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "49", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-17", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id652_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61bb8a68186f43bafe8e", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1719590400, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "126", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "127", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "128", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "129", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "130", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "assigned_to": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "131", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "snoozed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 6, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Admin not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "state": { + "value": "in_progress", + "type": "enum" + }, + "assignment": { + "properties": { + "admin_id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "991267893", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "490", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "49", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-17", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id652_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61bb8a68186f43bafe8e", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1719590400, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "126", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "127", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "128", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "129", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "130", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "assigned_to": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "131", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "snoozed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 6, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "Assignee not found", + "pathParameters": [ + { + "name": "id", + "value": { + "value": { + "value": "id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "state": { + "value": "in_progress", + "type": "enum" + }, + "assignment": { + "properties": { + "admin_id": { + "value": { + "value": "991267899", + "type": "string" + }, + "type": "primitive" + }, + "assignee_id": { + "value": { + "value": "456", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "490", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "49", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "example", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "_default_description_", + "type": "string" + }, + "value": { + "value": { + "value": "there is a problem", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "108", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-17", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id652_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493050, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61bb8a68186f43bafe8e", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1719590400, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "126", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493051, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "127", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "128", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_attribute_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "129", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "in_progress", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493053, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "130", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "assignment", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "assigned_to": { + "properties": { + "type": { + "value": { + "value": "admin", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "991267885", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267883", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran419 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin419@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "131", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "snoozed", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493054, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "bot", + "type": "enum" + }, + "id": { + "value": { + "value": "991267884", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Operator", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 6, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "In progress", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Search tickets", + "audiences": [], + "operationId": "searchTickets", + "tags": [ + "Tickets" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "SearchTicketsRequestIntercomVersion", + "value": { + "generatedName": "SearchTicketsRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "SearchTicketsRequest", + "request": { + "schema": { + "generatedName": "SearchTicketsRequestBody", + "schema": "search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154" + } + ] + }, + "pagination": { + "per_page": 5 + } + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "SearchTicketsResponse", + "schema": "ticket_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "ticket.list", + "pages": { + "type": "pages", + "page": 1, + "per_page": 5, + "total_pages": 1 + }, + "total_count": 1, + "tickets": [ + { + "type": "ticket", + "id": "494", + "ticket_id": "53", + "ticket_attributes": { + "_default_title_": "attribute_value", + "_default_description_": null + }, + "ticket_state": "submitted", + "ticket_type": { + "type": "ticket_type", + "id": "117", + "name": "my-ticket-type-26", + "description": "my ticket type description is awesome.", + "icon": "🦁", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065, + "is_internal": false, + "ticket_type_attributes": { + "type": "list", + "data": [ + { + "type": "ticket_type_attribute", + "id": "279", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_title_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + }, + { + "type": "ticket_type_attribute", + "id": "280", + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + "name": "_default_description_", + "description": "ola", + "data_type": "string", + "input_options": null, + "order": 0, + "required_to_create": true, + "required_to_create_for_contacts": false, + "visible_on_create": true, + "visible_to_contacts": false, + "default": false, + "ticket_type_id": 117, + "archived": false, + "created_at": 1719493065, + "updated_at": 1719493065 + } + ] + }, + "category": "Back-office" + }, + "contacts": { + "type": "contact.list", + "contacts": [ + { + "type": "contact", + "id": "667d61c98a68186f43bafe92", + "external_id": "6895b33e-2768-4611-908e-da6632dfc8ea" + } + ] + }, + "admin_assignee_id": "0", + "team_assignee_id": "0", + "created_at": 1719493065, + "updated_at": 1719493066, + "ticket_parts": { + "type": "ticket_part.list", + "ticket_parts": [ + { + "type": "ticket_part", + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "ticket_state": "submitted", + "previous_ticket_state": "submitted", + "created_at": 1719493066, + "updated_at": 1719493066, + "author": { + "id": "991267940", + "type": "admin", + "name": "Ciaran472 Lee", + "email": "admin472@email.com" + }, + "attachments": [], + "redacted": false + } + ], + "total_count": 1 + }, + "open": true, + "linked_objects": { + "type": "list", + "data": [], + "total_count": 0, + "has_more": false + }, + "category": "Back-office", + "is_shared": false, + "ticket_state_internal_label": "Submitted", + "ticket_state_external_label": "Submitted" + } + ] + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": {}, + "server": [], + "description": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want.\n\nTo search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`.\n\nThis will accept a query object in the body which will define your filters.\n{% admonition type=\"warning\" name=\"Optimizing search queries\" %}\n Search queries can be complex, so optimizing them can help the performance of your search.\n Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize\n pagination to limit the number of results returned. The default is `20` results per page.\n See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param.\n{% /admonition %}\n\n### Nesting & Limitations\n\nYou can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).\nThere are some limitations to the amount of multiples there can be:\n- There's a limit of max 2 nested filters\n- There's a limit of max 15 filters for each AND or OR group\n\n### Accepted Fields\n\nMost keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `\"foobar\"`).\n\n| Field | Type |\n| :---------------------------------------- | :--------------------------------------------------------------------------------------- |\n| id | String |\n| created_at | Date (UNIX timestamp) |\n| updated_at | Date (UNIX timestamp) |\n| _default_title_ | String |\n| _default_description_ | String |\n| category | String |\n| ticket_type_id | String |\n| contact_ids | String |\n| teammate_ids | String |\n| admin_assignee_id | String |\n| team_assignee_id | String |\n| open | Boolean |\n| state | String |\n| snoozed_until | Date (UNIX timestamp) |\n| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer |\n\n### Accepted Operators\n\n{% admonition type=\"info\" name=\"Searching based on `created_at`\" %}\n You may use the `<=` or `>=` operators to search by `created_at`.\n{% /admonition %}\n\nThe table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`\"=\"`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates).\n\n| Operator | Valid Types | Description |\n| :------- | :----------------------------- | :----------------------------------------------------------- |\n| = | All | Equals |\n| != | All | Doesn't Equal |\n| IN | All | In Shortcut for `OR` queries Values most be in Array |\n| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array |\n| > | Integer Date (UNIX Timestamp) | Greater (or equal) than |\n| < | Integer Date (UNIX Timestamp) | Lower (or equal) than |\n| ~ | String | Contains |\n| !~ | String | Doesn't Contain |\n| ^ | String | Starts With |\n| $ | String | Ends With |\n", + "authed": true, + "method": "POST", + "path": "/tickets/search", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "query": { + "properties": { + "operator": { + "value": "AND", + "type": "enum" + }, + "value": { + "value": [ + { + "properties": { + "field": { + "value": { + "value": "created_at", + "type": "string" + }, + "type": "primitive" + }, + "operator": { + "value": ">", + "type": "enum" + }, + "value": { + "value": { + "value": "1306054154", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "pagination": { + "properties": { + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "ticket.list", + "type": "string" + }, + "type": "literal" + }, + "tickets": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "494", + "type": "string" + }, + "type": "primitive" + }, + "ticket_id": { + "value": { + "value": "53", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "ticket_attributes": { + "value": [ + { + "key": { + "value": "_default_title_", + "type": "string" + }, + "value": { + "value": { + "value": "attribute_value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_type": { + "properties": { + "type": { + "value": { + "value": "ticket_type", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "117", + "type": "string" + }, + "type": "primitive" + }, + "category": { + "value": "Back-office", + "type": "enum" + }, + "name": { + "value": { + "value": "my-ticket-type-26", + "type": "string" + }, + "type": "primitive" + }, + "description": { + "value": { + "value": "my ticket type description is awesome.", + "type": "string" + }, + "type": "primitive" + }, + "icon": { + "value": { + "value": "🦁", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id667_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "ticket_type_attributes": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "archived": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493065, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493065, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "contacts": { + "properties": { + "type": { + "value": { + "value": "contact.list", + "type": "string" + }, + "type": "literal" + }, + "contacts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "literal" + }, + "id": { + "value": { + "value": "667d61c98a68186f43bafe92", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "6895b33e-2768-4611-908e-da6632dfc8ea", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "admin_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "team_assignee_id": { + "value": { + "value": "0", + "type": "string" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493065, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493066, + "type": "int" + }, + "type": "primitive" + }, + "open": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "snoozed_until": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "linked_objects": { + "properties": { + "type": { + "value": { + "value": "list", + "type": "string" + }, + "type": "literal" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "data": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "7583", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "ticket_parts": { + "properties": { + "type": { + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "type": "literal" + }, + "ticket_parts": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "ticket_part", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "135", + "type": "string" + }, + "type": "primitive" + }, + "part_type": { + "value": { + "value": "ticket_state_updated_by_admin", + "type": "string" + }, + "type": "primitive" + }, + "previous_ticket_state": { + "value": "submitted", + "type": "enum" + }, + "ticket_state": { + "value": "submitted", + "type": "enum" + }, + "created_at": { + "value": { + "value": 1719493066, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493066, + "type": "int" + }, + "type": "primitive" + }, + "author": { + "properties": { + "type": { + "value": "admin", + "type": "enum" + }, + "id": { + "value": { + "value": "991267940", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Ciaran472 Lee", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "admin472@email.com", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "attachments": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "upload", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "example.png", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "https://picsum.photos/200/300", + "type": "string" + }, + "type": "primitive" + }, + "content_type": { + "value": { + "value": "image/png", + "type": "string" + }, + "type": "primitive" + }, + "filesize": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "width": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "height": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "redacted": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "is_shared": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "ticket_state_internal_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + }, + "ticket_state_external_label": { + "value": { + "value": "Submitted", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "total_count": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "pages": { + "properties": { + "type": { + "value": { + "value": "pages", + "type": "string" + }, + "type": "literal" + }, + "page": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + }, + "next": { + "properties": { + "per_page": { + "value": { + "value": 2, + "type": "int" + }, + "type": "primitive" + }, + "starting_after": { + "value": { + "value": "your-cursor-from-response", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "per_page": { + "value": { + "value": 5, + "type": "int" + }, + "type": "primitive" + }, + "total_pages": { + "value": { + "value": 1, + "type": "int" + }, + "type": "primitive" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Retrieve a visitor with User ID", + "audiences": [], + "operationId": "retrieveVisitorWithUserId", + "tags": [ + "Visitors" + ], + "pathParameters": [], + "queryParameters": [ + { + "description": "The user_id of the Visitor you want to retrieve.", + "name": "user_id", + "schema": { + "schema": { + "type": "string" + }, + "generatedName": "RetrieveVisitorWithUserIdRequestUserId", + "groupName": [], + "type": "primitive" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "RetrieveVisitorWithUserIdRequestIntercomVersion", + "value": { + "generatedName": "RetrieveVisitorWithUserIdRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "RetrieveVisitorWithUserIdRequest", + "response": { + "description": "successful", + "schema": { + "generatedName": "RetrieveVisitorWithUserIdResponse", + "schema": "visitor", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "visitor", + "id": "667d61ce8a68186f43bafe9b", + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "anonymous": true, + "email": "", + "phone": null, + "name": null, + "pseudonym": null, + "avatar": { + "type": "avatar", + "image_url": null + }, + "app_id": "this_is_an_id677_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493070, + "remote_created_at": 1719493070, + "signed_up_at": 1719493070, + "updated_at": 1719493070, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "25dace4f-4916-492c-823b-f0cca227dff0", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Visitor not found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Visitor not found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "7359afef-98f5-4b22-9de7-902f7a214729", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Visitor Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can fetch the details of a single visitor.", + "authed": true, + "method": "GET", + "path": "/visitors", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [ + { + "name": "user_id", + "value": { + "value": { + "value": "user_id", + "type": "string" + }, + "type": "primitive" + } + } + ], + "headers": [], + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "visitor", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d61ce8a68186f43bafe9b", + "type": "string" + }, + "type": "primitive" + }, + "user_id": { + "value": { + "value": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "type": "string" + }, + "type": "primitive" + }, + "anonymous": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "555-555-5555", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Jane Doe", + "type": "string" + }, + "type": "primitive" + }, + "pseudonym": { + "value": { + "value": "Red Duck from Dublin", + "type": "string" + }, + "type": "primitive" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.com/avatar.png", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "app_id": { + "value": { + "value": "this_is_an_id677_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "companies": { + "properties": { + "type": { + "value": { + "value": "company.list", + "type": "string" + }, + "type": "literal" + }, + "companies": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "531ee472cce572a6ec000006", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Blue Sun", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "company_id": { + "value": { + "value": "6", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "paid_subscriber", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "monthly_spend", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "team_mates", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "location_data": { + "properties": { + "type": { + "value": { + "value": "location_data", + "type": "string" + }, + "type": "primitive" + }, + "city_name": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "continent_code": { + "value": { + "value": "EU", + "type": "string" + }, + "type": "primitive" + }, + "country_code": { + "value": { + "value": "IRL", + "type": "string" + }, + "type": "primitive" + }, + "country_name": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "postal_code": { + "value": { + "value": "D02 N960", + "type": "string" + }, + "type": "primitive" + }, + "region_name": { + "value": { + "value": "Leinster", + "type": "string" + }, + "type": "primitive" + }, + "timezone": { + "value": { + "value": "Europe/Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "las_request_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493070, + "type": "int" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719493070, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719493070, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493070, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "social_profiles": { + "properties": { + "type": { + "value": { + "value": "social_profile.list", + "type": "string" + }, + "type": "literal" + }, + "social_profiles": { + "value": [ + { + "value": { + "value": "social_profiles", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "owner_id": { + "value": { + "value": "5169261", + "type": "string" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "8482", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "tag_name", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "value": { + "value": "segments", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "referrer": { + "value": { + "value": "https://www.google.com/", + "type": "string" + }, + "type": "primitive" + }, + "utm_campaign": { + "value": { + "value": "intercom-link", + "type": "string" + }, + "type": "primitive" + }, + "utm_content": { + "value": { + "value": "banner", + "type": "string" + }, + "type": "primitive" + }, + "utm_medium": { + "value": { + "value": "email", + "type": "string" + }, + "type": "primitive" + }, + "utm_source": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "utm_term": { + "value": { + "value": "messenger", + "type": "string" + }, + "type": "primitive" + }, + "do_not_track": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Update a visitor", + "audiences": [], + "operationId": "updateVisitor", + "tags": [ + "Visitors" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "UpdateVisitorRequestIntercomVersion", + "value": { + "generatedName": "UpdateVisitorRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "UpdateVisitorRequest", + "request": { + "schema": { + "generatedName": "UpdateVisitorRequestBody", + "schema": "update_visitor_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "id": "667d61cc8a68186f43bafe95", + "name": "Gareth Bale" + } + }, + { + "name": "visitor Not Found", + "value": { + "user_id": "fail", + "name": "Christian Fail" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "UpdateVisitorResponse", + "schema": "visitor", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "visitor", + "id": "667d61cc8a68186f43bafe95", + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "anonymous": true, + "email": "", + "phone": null, + "name": "Gareth Bale", + "pseudonym": "Indigo Ghost", + "avatar": { + "type": "avatar", + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png" + }, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "companies": { + "type": "company.list", + "companies": [] + }, + "location_data": {}, + "last_request_at": null, + "created_at": 1719493068, + "remote_created_at": 1719493068, + "signed_up_at": 1719493068, + "updated_at": 1719493068, + "session_count": 0, + "social_profiles": { + "type": "social_profile.list", + "social_profiles": [] + }, + "owner_id": null, + "unsubscribed_from_emails": false, + "marked_email_as_spam": false, + "has_hard_bounced": false, + "tags": { + "type": "tag.list", + "tags": [] + }, + "segments": { + "type": "segment.list", + "segments": [] + }, + "custom_attributes": {}, + "referrer": null, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "do_not_track": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "82df3971-fb7c-410d-a919-e8bc1b3d991a", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + }, + "404": { + "generatedName": "NotFoundError", + "schema": { + "generatedName": "NotFoundErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "visitor Not Found", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "visitor Not Found", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "1f35dc86-17d2-4bfe-8cb1-9afa74adc24c", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "not_found", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Visitor Not Found", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor.\n\n**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.\n\n**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.\n", + "authed": true, + "method": "PUT", + "path": "/visitors", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "id", + "type": "string" + }, + "value": { + "value": { + "value": "667d61cc8a68186f43bafe95", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "name", + "type": "string" + }, + "value": { + "value": { + "value": "Gareth Bale", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "visitor", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d61cc8a68186f43bafe95", + "type": "string" + }, + "type": "primitive" + }, + "user_id": { + "value": { + "value": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "type": "string" + }, + "type": "primitive" + }, + "anonymous": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "555-555-5555", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Gareth Bale", + "type": "string" + }, + "type": "primitive" + }, + "pseudonym": { + "value": { + "value": "Indigo Ghost", + "type": "string" + }, + "type": "primitive" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "app_id": { + "value": { + "value": "this_is_an_id671_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "companies": { + "properties": { + "type": { + "value": { + "value": "company.list", + "type": "string" + }, + "type": "literal" + }, + "companies": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "531ee472cce572a6ec000006", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Blue Sun", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "company_id": { + "value": { + "value": "6", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "paid_subscriber", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "monthly_spend", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "team_mates", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "location_data": { + "properties": { + "type": { + "value": { + "value": "location_data", + "type": "string" + }, + "type": "primitive" + }, + "city_name": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "continent_code": { + "value": { + "value": "EU", + "type": "string" + }, + "type": "primitive" + }, + "country_code": { + "value": { + "value": "IRL", + "type": "string" + }, + "type": "primitive" + }, + "country_name": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "postal_code": { + "value": { + "value": "D02 N960", + "type": "string" + }, + "type": "primitive" + }, + "region_name": { + "value": { + "value": "Leinster", + "type": "string" + }, + "type": "primitive" + }, + "timezone": { + "value": { + "value": "Europe/Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "las_request_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "social_profiles": { + "properties": { + "type": { + "value": { + "value": "social_profile.list", + "type": "string" + }, + "type": "literal" + }, + "social_profiles": { + "value": [ + { + "value": { + "value": "social_profiles", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "owner_id": { + "value": { + "value": "5169261", + "type": "string" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "8482", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "tag_name", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "value": { + "value": "segments", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "referrer": { + "value": { + "value": "https://www.google.com/", + "type": "string" + }, + "type": "primitive" + }, + "utm_campaign": { + "value": { + "value": "intercom-link", + "type": "string" + }, + "type": "primitive" + }, + "utm_content": { + "value": { + "value": "banner", + "type": "string" + }, + "type": "primitive" + }, + "utm_medium": { + "value": { + "value": "email", + "type": "string" + }, + "type": "primitive" + }, + "utm_source": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "utm_term": { + "value": { + "value": "messenger", + "type": "string" + }, + "type": "primitive" + }, + "do_not_track": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + }, + { + "name": "visitor Not Found", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "value": { + "value": [ + { + "key": { + "value": "user_id", + "type": "string" + }, + "value": { + "value": { + "value": "fail", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "name", + "type": "string" + }, + "value": { + "value": { + "value": "Christian Fail", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "visitor", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d61cc8a68186f43bafe95", + "type": "string" + }, + "type": "primitive" + }, + "user_id": { + "value": { + "value": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "type": "string" + }, + "type": "primitive" + }, + "anonymous": { + "value": { + "value": true, + "type": "boolean" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "555-555-5555", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Gareth Bale", + "type": "string" + }, + "type": "primitive" + }, + "pseudonym": { + "value": { + "value": "Indigo Ghost", + "type": "string" + }, + "type": "primitive" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "app_id": { + "value": { + "value": "this_is_an_id671_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "companies": { + "properties": { + "type": { + "value": { + "value": "company.list", + "type": "string" + }, + "type": "literal" + }, + "companies": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "531ee472cce572a6ec000006", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Blue Sun", + "type": "string" + }, + "type": "primitive" + }, + "app_id": { + "value": { + "value": "ecahpwf5", + "type": "string" + }, + "type": "primitive" + }, + "company_id": { + "value": { + "value": "6", + "type": "string" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "last_request_at": { + "value": { + "value": 1663597223, + "type": "int" + }, + "type": "primitive" + }, + "size": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "website": { + "value": { + "value": "https://www.intercom.com", + "type": "string" + }, + "type": "primitive" + }, + "industry": { + "value": { + "value": "Software", + "type": "string" + }, + "type": "primitive" + }, + "monthly_spend": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "user_count": { + "value": { + "value": 100, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "paid_subscriber", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "monthly_spend", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "team_mates", + "type": "string" + }, + "value": { + "value": { + "value": "custom_attributes", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "location_data": { + "properties": { + "type": { + "value": { + "value": "location_data", + "type": "string" + }, + "type": "primitive" + }, + "city_name": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "continent_code": { + "value": { + "value": "EU", + "type": "string" + }, + "type": "primitive" + }, + "country_code": { + "value": { + "value": "IRL", + "type": "string" + }, + "type": "primitive" + }, + "country_name": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "postal_code": { + "value": { + "value": "D02 N960", + "type": "string" + }, + "type": "primitive" + }, + "region_name": { + "value": { + "value": "Leinster", + "type": "string" + }, + "type": "primitive" + }, + "timezone": { + "value": { + "value": "Europe/Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "las_request_at": { + "value": { + "value": 1663597260, + "type": "int" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "remote_created_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493068, + "type": "int" + }, + "type": "primitive" + }, + "session_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "social_profiles": { + "properties": { + "type": { + "value": { + "value": "social_profile.list", + "type": "string" + }, + "type": "literal" + }, + "social_profiles": { + "value": [ + { + "value": { + "value": "social_profiles", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "owner_id": { + "value": { + "value": "5169261", + "type": "string" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "tags": { + "properties": { + "type": { + "value": { + "value": "tag.list", + "type": "string" + }, + "type": "literal" + }, + "tags": { + "value": [ + { + "properties": { + "id": { + "value": { + "value": "8482", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "tag_name", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "segments": { + "properties": { + "type": { + "value": { + "value": "segment.list", + "type": "string" + }, + "type": "literal" + }, + "segments": { + "value": [ + { + "value": { + "value": "segments", + "type": "string" + }, + "type": "primitive" + } + ], + "type": "array" + } + }, + "type": "object" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "referrer": { + "value": { + "value": "https://www.google.com/", + "type": "string" + }, + "type": "primitive" + }, + "utm_campaign": { + "value": { + "value": "intercom-link", + "type": "string" + }, + "type": "primitive" + }, + "utm_content": { + "value": { + "value": "banner", + "type": "string" + }, + "type": "primitive" + }, + "utm_medium": { + "value": { + "value": "email", + "type": "string" + }, + "type": "primitive" + }, + "utm_source": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "utm_term": { + "value": { + "value": "messenger", + "type": "string" + }, + "type": "primitive" + }, + "do_not_track": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + }, + { + "summary": "Convert a visitor", + "audiences": [], + "operationId": "convertVisitor", + "tags": [ + "Visitors" + ], + "pathParameters": [], + "queryParameters": [], + "headers": [ + { + "name": "Intercom-Version", + "schema": { + "generatedName": "ConvertVisitorRequestIntercomVersion", + "value": { + "generatedName": "ConvertVisitorRequestIntercomVersion", + "schema": "intercom_version", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "type": "nullable" + }, + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "generatedRequestName": "ConvertVisitorRequest", + "request": { + "schema": { + "generatedName": "ConvertVisitorRequestBody", + "schema": "convert_visitor_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "contentType": "application/json", + "fullExamples": [ + { + "name": "successful", + "value": { + "visitor": { + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3" + }, + "user": { + "email": "foo@bar.com" + }, + "type": "user" + } + } + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "response": { + "description": "successful", + "schema": { + "generatedName": "ConvertVisitorResponse", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "fullExamples": [ + { + "name": "successful", + "value": { + "type": "contact", + "id": "667d61d08a68186f43bafea2", + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + "external_id": null, + "role": "user", + "email": "foo@bar.com", + "phone": null, + "name": null, + "avatar": null, + "owner_id": null, + "social_profiles": { + "type": "list", + "data": [] + }, + "has_hard_bounced": false, + "marked_email_as_spam": false, + "unsubscribed_from_emails": false, + "created_at": 1719493072, + "updated_at": 1719493072, + "signed_up_at": 1719493072, + "last_seen_at": null, + "last_replied_at": null, + "last_contacted_at": null, + "last_email_opened_at": null, + "last_email_clicked_at": null, + "language_override": null, + "browser": null, + "browser_version": null, + "browser_language": null, + "os": null, + "location": { + "type": "location", + "country": null, + "region": null, + "city": null, + "country_code": null, + "continent_code": null + }, + "android_app_name": null, + "android_app_version": null, + "android_device": null, + "android_os_version": null, + "android_sdk_version": null, + "android_last_seen_at": null, + "ios_app_name": null, + "ios_app_version": null, + "ios_device": null, + "ios_os_version": null, + "ios_sdk_version": null, + "ios_last_seen_at": null, + "custom_attributes": {}, + "tags": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/tags", + "total_count": 0, + "has_more": false + }, + "notes": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/notes", + "total_count": 0, + "has_more": false + }, + "companies": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/companies", + "total_count": 0, + "has_more": false + }, + "opted_out_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "opted_in_subscription_types": { + "type": "list", + "data": [], + "url": "/contacts/667d61d08a68186f43bafea2/subscriptions", + "total_count": 0, + "has_more": false + }, + "utm_campaign": null, + "utm_content": null, + "utm_medium": null, + "utm_source": null, + "utm_term": null, + "referrer": null + } + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "json" + }, + "errors": { + "401": { + "generatedName": "UnauthorizedError", + "schema": { + "generatedName": "UnauthorizedErrorBody", + "schema": "error", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "description": "Unauthorized", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "examples": [ + { + "name": "Unauthorized", + "example": { + "value": [ + { + "key": { + "value": "type", + "type": "string" + }, + "value": { + "value": { + "value": "error.list", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "request_id", + "type": "string" + }, + "value": { + "value": { + "value": "fe1a587a-e682-4a96-bd30-ea08b726e6fa", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "errors", + "type": "string" + }, + "value": { + "value": [ + { + "value": [ + { + "key": { + "value": "code", + "type": "string" + }, + "value": { + "value": { + "value": "unauthorized", + "type": "string" + }, + "type": "primitive" + } + }, + { + "key": { + "value": "message", + "type": "string" + }, + "value": { + "value": { + "value": "Access Token Invalid", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + } + ], + "type": "array" + } + } + ], + "type": "map" + } + } + ] + } + }, + "server": [], + "description": "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> 📘 What happens upon a visitor being converted?\n>\n> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.\n", + "authed": true, + "method": "POST", + "path": "/visitors/convert", + "examples": [ + { + "name": "successful", + "pathParameters": [], + "queryParameters": [], + "headers": [], + "request": { + "properties": { + "type": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "user": { + "value": { + "value": [ + { + "key": { + "value": "email", + "type": "string" + }, + "value": { + "value": { + "value": "foo@bar.com", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + }, + "visitor": { + "value": { + "value": [ + { + "key": { + "value": "user_id", + "type": "string" + }, + "value": { + "value": { + "value": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "type": "string" + }, + "type": "primitive" + } + } + ], + "type": "map" + }, + "type": "unknown" + } + }, + "type": "object" + }, + "response": { + "value": { + "properties": { + "type": { + "value": { + "value": "contact", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "667d61d08a68186f43bafea2", + "type": "string" + }, + "type": "primitive" + }, + "external_id": { + "value": { + "value": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "type": "primitive" + }, + "workspace_id": { + "value": { + "value": "this_is_an_id683_that_should_be_at_least_", + "type": "string" + }, + "type": "primitive" + }, + "role": { + "value": { + "value": "user", + "type": "string" + }, + "type": "primitive" + }, + "email": { + "value": { + "value": "foo@bar.com", + "type": "string" + }, + "type": "primitive" + }, + "email_domain": { + "value": { + "value": "example.com", + "type": "string" + }, + "type": "primitive" + }, + "phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "formatted_phone": { + "value": { + "value": "+1123456789", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "John Doe", + "type": "string" + }, + "type": "primitive" + }, + "owner_id": { + "value": { + "value": 123, + "type": "int" + }, + "type": "primitive" + }, + "has_hard_bounced": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "marked_email_as_spam": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "unsubscribed_from_emails": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + }, + "created_at": { + "value": { + "value": 1719493072, + "type": "int" + }, + "type": "primitive" + }, + "updated_at": { + "value": { + "value": 1719493072, + "type": "int" + }, + "type": "primitive" + }, + "signed_up_at": { + "value": { + "value": 1719493072, + "type": "int" + }, + "type": "primitive" + }, + "last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_replied_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_contacted_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_opened_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "last_email_clicked_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "language_override": { + "value": { + "value": "en", + "type": "string" + }, + "type": "primitive" + }, + "browser": { + "value": { + "value": "Chrome", + "type": "string" + }, + "type": "primitive" + }, + "browser_version": { + "value": { + "value": "80.0.3987.132", + "type": "string" + }, + "type": "primitive" + }, + "browser_language": { + "value": { + "value": "en-US", + "type": "string" + }, + "type": "primitive" + }, + "os": { + "value": { + "value": "Mac OS X", + "type": "string" + }, + "type": "primitive" + }, + "android_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "android_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "android_device": { + "value": { + "value": "Pixel 3", + "type": "string" + }, + "type": "primitive" + }, + "android_os_version": { + "value": { + "value": "10", + "type": "string" + }, + "type": "primitive" + }, + "android_sdk_version": { + "value": { + "value": "28", + "type": "string" + }, + "type": "primitive" + }, + "android_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "ios_app_name": { + "value": { + "value": "Intercom", + "type": "string" + }, + "type": "primitive" + }, + "ios_app_version": { + "value": { + "value": "5.0.0", + "type": "string" + }, + "type": "primitive" + }, + "ios_device": { + "value": { + "value": "iPhone 11", + "type": "string" + }, + "type": "primitive" + }, + "ios_os_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_sdk_version": { + "value": { + "value": "13.3.1", + "type": "string" + }, + "type": "primitive" + }, + "ios_last_seen_at": { + "value": { + "value": 1571672154, + "type": "int" + }, + "type": "primitive" + }, + "custom_attributes": { + "value": [ + { + "key": { + "value": "key", + "type": "string" + }, + "value": { + "value": { + "value": { + "value": "value", + "type": "string" + }, + "type": "primitive" + }, + "type": "unknown" + } + } + ], + "type": "map" + }, + "avatar": { + "properties": { + "type": { + "value": { + "value": "avatar", + "type": "string" + }, + "type": "primitive" + }, + "image_url": { + "value": { + "value": "https://example.org/128Wash.jpg", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "tags": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d61d08a68186f43bafea2/tags", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "notes": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "note", + "type": "string" + }, + "type": "primitive" + }, + "id": { + "value": { + "value": "123", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + }, + "url": { + "value": { + "value": "/contacts/667d61d08a68186f43bafea2/notes", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "companies": { + "properties": { + "url": { + "value": { + "value": "/contacts/667d61d08a68186f43bafea2/companies", + "type": "string" + }, + "type": "primitive" + }, + "total_count": { + "value": { + "value": 0, + "type": "int" + }, + "type": "primitive" + }, + "has_more": { + "value": { + "value": false, + "type": "boolean" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "location": { + "properties": { + "type": { + "value": { + "value": "location", + "type": "string" + }, + "type": "primitive" + }, + "country": { + "value": { + "value": "Ireland", + "type": "string" + }, + "type": "primitive" + }, + "region": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + }, + "city": { + "value": { + "value": "Dublin", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + }, + "social_profiles": { + "properties": { + "data": { + "value": [ + { + "properties": { + "type": { + "value": { + "value": "social_profile", + "type": "string" + }, + "type": "primitive" + }, + "name": { + "value": { + "value": "Facebook", + "type": "string" + }, + "type": "primitive" + }, + "url": { + "value": { + "value": "http://twitter.com/th1sland", + "type": "string" + }, + "type": "primitive" + } + }, + "type": "object" + } + ], + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "withoutStreaming" + }, + "codeSamples": [], + "type": "full" + } + ], + "source": { + "file": "../openapi.yml", + "type": "openapi" + } + } + ], + "webhooks": [], + "channel": [], + "groupedSchemas": { + "rootSchemas": { + "activity_log": { + "generatedName": "ActivityLog", + "title": "Activity Log", + "description": "Activities performed by Admins.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "activityLogId", + "key": "id", + "schema": { + "generatedName": "activityLogId", + "title": "Activity Log", + "value": { + "description": "The id representing the activity.", + "schema": { + "example": "6", + "type": "string" + }, + "generatedName": "ActivityLogId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogPerformedBy", + "key": "performed_by", + "schema": { + "generatedName": "activityLogPerformedBy", + "title": "Activity Log", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "activityLogPerformedByType", + "key": "type", + "schema": { + "generatedName": "activityLogPerformedByType", + "value": { + "description": "String representing the object's type. Always has the value `admin`.", + "schema": { + "example": "admin", + "type": "string" + }, + "generatedName": "ActivityLogPerformedByType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogPerformedById", + "key": "id", + "schema": { + "generatedName": "activityLogPerformedById", + "value": { + "description": "The id representing the admin.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "ActivityLogPerformedById", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogPerformedByEmail", + "key": "email", + "schema": { + "generatedName": "activityLogPerformedByEmail", + "value": { + "description": "The email of the admin.", + "schema": { + "example": "john@example.com", + "type": "string" + }, + "generatedName": "ActivityLogPerformedByEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogPerformedByIp", + "key": "ip", + "schema": { + "generatedName": "activityLogPerformedByIp", + "value": { + "description": "The IP address of the admin.", + "schema": { + "example": "198.51.100.255", + "type": "string" + }, + "generatedName": "ActivityLogPerformedByIp", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Details about the Admin involved in the activity.", + "generatedName": "ActivityLogPerformedBy", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadata", + "key": "metadata", + "schema": { + "generatedName": "activityLogMetadata", + "title": "Activity Log", + "value": { + "generatedName": "ActivityLogMetadata", + "schema": "activity_log_metadata", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "activityLogCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "activityLogCreatedAt", + "title": "Activity Log", + "value": { + "description": "The time the activity was created.", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "ActivityLogCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogActivityType", + "key": "activity_type", + "schema": { + "generatedName": "activityLogActivityType", + "title": "Activity Log", + "value": { + "generatedName": "ActivityLogActivityType", + "values": [ + { + "generatedName": "admin_assignment_limit_change", + "value": "admin_assignment_limit_change", + "casing": {} + }, + { + "generatedName": "admin_away_mode_change", + "value": "admin_away_mode_change", + "casing": {} + }, + { + "generatedName": "admin_deletion", + "value": "admin_deletion", + "casing": {} + }, + { + "generatedName": "admin_deprovisioned", + "value": "admin_deprovisioned", + "casing": {} + }, + { + "generatedName": "admin_impersonation_end", + "value": "admin_impersonation_end", + "casing": {} + }, + { + "generatedName": "admin_impersonation_start", + "value": "admin_impersonation_start", + "casing": {} + }, + { + "generatedName": "admin_invite_change", + "value": "admin_invite_change", + "casing": {} + }, + { + "generatedName": "admin_invite_creation", + "value": "admin_invite_creation", + "casing": {} + }, + { + "generatedName": "admin_invite_deletion", + "value": "admin_invite_deletion", + "casing": {} + }, + { + "generatedName": "admin_login_failure", + "value": "admin_login_failure", + "casing": {} + }, + { + "generatedName": "admin_login_success", + "value": "admin_login_success", + "casing": {} + }, + { + "generatedName": "admin_logout", + "value": "admin_logout", + "casing": {} + }, + { + "generatedName": "admin_password_reset_request", + "value": "admin_password_reset_request", + "casing": {} + }, + { + "generatedName": "admin_password_reset_success", + "value": "admin_password_reset_success", + "casing": {} + }, + { + "generatedName": "admin_permission_change", + "value": "admin_permission_change", + "casing": {} + }, + { + "generatedName": "admin_provisioned", + "value": "admin_provisioned", + "casing": {} + }, + { + "generatedName": "admin_two_factor_auth_change", + "value": "admin_two_factor_auth_change", + "casing": {} + }, + { + "generatedName": "admin_unauthorized_sign_in_method", + "value": "admin_unauthorized_sign_in_method", + "casing": {} + }, + { + "generatedName": "app_admin_join", + "value": "app_admin_join", + "casing": {} + }, + { + "generatedName": "app_authentication_method_change", + "value": "app_authentication_method_change", + "casing": {} + }, + { + "generatedName": "app_data_deletion", + "value": "app_data_deletion", + "casing": {} + }, + { + "generatedName": "app_data_export", + "value": "app_data_export", + "casing": {} + }, + { + "generatedName": "app_google_sso_domain_change", + "value": "app_google_sso_domain_change", + "casing": {} + }, + { + "generatedName": "app_identity_verification_change", + "value": "app_identity_verification_change", + "casing": {} + }, + { + "generatedName": "app_name_change", + "value": "app_name_change", + "casing": {} + }, + { + "generatedName": "app_outbound_address_change", + "value": "app_outbound_address_change", + "casing": {} + }, + { + "generatedName": "app_package_installation", + "value": "app_package_installation", + "casing": {} + }, + { + "generatedName": "app_package_token_regeneration", + "value": "app_package_token_regeneration", + "casing": {} + }, + { + "generatedName": "app_package_uninstallation", + "value": "app_package_uninstallation", + "casing": {} + }, + { + "generatedName": "app_team_creation", + "value": "app_team_creation", + "casing": {} + }, + { + "generatedName": "app_team_deletion", + "value": "app_team_deletion", + "casing": {} + }, + { + "generatedName": "app_team_membership_modification", + "value": "app_team_membership_modification", + "casing": {} + }, + { + "generatedName": "app_timezone_change", + "value": "app_timezone_change", + "casing": {} + }, + { + "generatedName": "app_webhook_creation", + "value": "app_webhook_creation", + "casing": {} + }, + { + "generatedName": "app_webhook_deletion", + "value": "app_webhook_deletion", + "casing": {} + }, + { + "generatedName": "articles_in_messenger_enabled_change", + "value": "articles_in_messenger_enabled_change", + "casing": {} + }, + { + "generatedName": "bulk_delete", + "value": "bulk_delete", + "casing": {} + }, + { + "generatedName": "bulk_export", + "value": "bulk_export", + "casing": {} + }, + { + "generatedName": "campaign_deletion", + "value": "campaign_deletion", + "casing": {} + }, + { + "generatedName": "campaign_state_change", + "value": "campaign_state_change", + "casing": {} + }, + { + "generatedName": "conversation_part_deletion", + "value": "conversation_part_deletion", + "casing": {} + }, + { + "generatedName": "conversation_topic_change", + "value": "conversation_topic_change", + "casing": {} + }, + { + "generatedName": "conversation_topic_creation", + "value": "conversation_topic_creation", + "casing": {} + }, + { + "generatedName": "conversation_topic_deletion", + "value": "conversation_topic_deletion", + "casing": {} + }, + { + "generatedName": "help_center_settings_change", + "value": "help_center_settings_change", + "casing": {} + }, + { + "generatedName": "inbound_conversations_change", + "value": "inbound_conversations_change", + "casing": {} + }, + { + "generatedName": "inbox_access_change", + "value": "inbox_access_change", + "casing": {} + }, + { + "generatedName": "message_deletion", + "value": "message_deletion", + "casing": {} + }, + { + "generatedName": "message_state_change", + "value": "message_state_change", + "casing": {} + }, + { + "generatedName": "messenger_look_and_feel_change", + "value": "messenger_look_and_feel_change", + "casing": {} + }, + { + "generatedName": "messenger_search_required_change", + "value": "messenger_search_required_change", + "casing": {} + }, + { + "generatedName": "messenger_spaces_change", + "value": "messenger_spaces_change", + "casing": {} + }, + { + "generatedName": "office_hours_change", + "value": "office_hours_change", + "casing": {} + }, + { + "generatedName": "role_change", + "value": "role_change", + "casing": {} + }, + { + "generatedName": "role_creation", + "value": "role_creation", + "casing": {} + }, + { + "generatedName": "role_deletion", + "value": "role_deletion", + "casing": {} + }, + { + "generatedName": "ruleset_activation_title_preview", + "value": "ruleset_activation_title_preview", + "casing": {} + }, + { + "generatedName": "ruleset_creation", + "value": "ruleset_creation", + "casing": {} + }, + { + "generatedName": "ruleset_deletion", + "value": "ruleset_deletion", + "casing": {} + }, + { + "generatedName": "search_browse_enabled_change", + "value": "search_browse_enabled_change", + "casing": {} + }, + { + "generatedName": "search_browse_required_change", + "value": "search_browse_required_change", + "casing": {} + }, + { + "generatedName": "seat_change", + "value": "seat_change", + "casing": {} + }, + { + "generatedName": "seat_revoke", + "value": "seat_revoke", + "casing": {} + }, + { + "generatedName": "security_settings_change", + "value": "security_settings_change", + "casing": {} + }, + { + "generatedName": "temporary_expectation_change", + "value": "temporary_expectation_change", + "casing": {} + }, + { + "generatedName": "upfront_email_collection_change", + "value": "upfront_email_collection_change", + "casing": {} + }, + { + "generatedName": "welcome_message_change", + "value": "welcome_message_change", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogActivityDescription", + "key": "activity_description", + "schema": { + "generatedName": "activityLogActivityDescription", + "title": "Activity Log", + "value": { + "description": "A sentence or two describing the activity.", + "schema": { + "example": "Admin updated the app's name to \"My App\".", + "type": "string" + }, + "generatedName": "ActivityLogActivityDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Activities performed by Admins.", + "generatedName": "ActivityLog", + "title": "Activity Log", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "activity_log_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "activityLogListType", + "key": "type", + "schema": { + "generatedName": "activityLogListType", + "title": "Paginated Response", + "value": { + "description": "String representing the object's type. Always has the value `activity_log.list`.", + "schema": { + "example": "activity_log.list", + "type": "string" + }, + "generatedName": "ActivityLogListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogListPages", + "key": "pages", + "schema": { + "generatedName": "activityLogListPages", + "title": "Paginated Response", + "value": { + "generatedName": "ActivityLogListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "activityLogListActivityLogs", + "key": "activity_logs", + "schema": { + "generatedName": "activityLogListActivityLogs", + "title": "Paginated Response", + "value": { + "description": "An array of activity logs", + "value": { + "generatedName": "ActivityLogListActivityLogsItem", + "schema": "activity_log", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ActivityLogListActivityLogs", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A paginated list of activity logs.", + "generatedName": "ActivityLogList", + "title": "Paginated Response", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "activity_log_metadata": { + "generatedName": "ActivityLogMetadata", + "title": "Activity Log Metadata", + "description": "Additional data provided about Admin activity.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "activityLogMetadataSignInMethod", + "key": "sign_in_method", + "schema": { + "generatedName": "activityLogMetadataSignInMethod", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataSignInMethod", + "description": "The way the admin signed in.", + "value": { + "description": "The way the admin signed in.", + "schema": { + "example": "email_password", + "type": "string" + }, + "generatedName": "ActivityLogMetadataSignInMethod", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataExternalId", + "key": "external_id", + "schema": { + "generatedName": "activityLogMetadataExternalId", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ActivityLogMetadataExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataAwayMode", + "key": "away_mode", + "schema": { + "generatedName": "activityLogMetadataAwayMode", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataAwayMode", + "description": "The away mode status which is set to true when away and false when returned.", + "value": { + "description": "The away mode status which is set to true when away and false when returned.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ActivityLogMetadataAwayMode", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataAwayStatusReason", + "key": "away_status_reason", + "schema": { + "generatedName": "activityLogMetadataAwayStatusReason", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataAwayStatusReason", + "description": "The reason the Admin is away.", + "value": { + "description": "The reason the Admin is away.", + "schema": { + "example": "😌 On a break", + "type": "string" + }, + "generatedName": "ActivityLogMetadataAwayStatusReason", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataReassignConversations", + "key": "reassign_conversations", + "schema": { + "generatedName": "activityLogMetadataReassignConversations", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataReassignConversations", + "description": "Indicates if conversations should be reassigned while an Admin is away.", + "value": { + "description": "Indicates if conversations should be reassigned while an Admin is away.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "ActivityLogMetadataReassignConversations", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataSource", + "key": "source", + "schema": { + "generatedName": "activityLogMetadataSource", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataSource", + "description": "The action that initiated the status change.", + "value": { + "description": "The action that initiated the status change.", + "schema": { + "example": "admin update from web - Admin id: 93", + "type": "string" + }, + "generatedName": "ActivityLogMetadataSource", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataAutoChanged", + "key": "auto_changed", + "schema": { + "generatedName": "activityLogMetadataAutoChanged", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataAutoChanged", + "description": "Indicates if the status was changed automatically or manually.", + "value": { + "description": "Indicates if the status was changed automatically or manually.", + "schema": { + "type": "string" + }, + "generatedName": "ActivityLogMetadataAutoChanged", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataUpdateBy", + "key": "update_by", + "schema": { + "generatedName": "activityLogMetadataUpdateBy", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataUpdateBy", + "description": "The ID of the Admin who initiated the activity.", + "value": { + "description": "The ID of the Admin who initiated the activity.", + "schema": { + "example": 93, + "type": "int" + }, + "generatedName": "ActivityLogMetadataUpdateBy", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "activityLogMetadataUpdateByName", + "key": "update_by_name", + "schema": { + "generatedName": "activityLogMetadataUpdateByName", + "title": "Activity Log Metadata", + "value": { + "generatedName": "ActivityLogMetadataUpdateByName", + "description": "The name of the Admin who initiated the activity.", + "value": { + "description": "The name of the Admin who initiated the activity.", + "schema": { + "example": "Joe Bloggs", + "type": "string" + }, + "generatedName": "ActivityLogMetadataUpdateByName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Additional data provided about Admin activity.", + "generatedName": "ActivityLogMetadata", + "title": "Activity Log Metadata", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "addressable_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "addressableListType", + "key": "type", + "schema": { + "generatedName": "addressableListType", + "title": "Addressable List", + "value": { + "description": "The addressable object type", + "schema": { + "format": "uri", + "example": "note", + "type": "string" + }, + "generatedName": "AddressableListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "addressableListId", + "key": "id", + "schema": { + "generatedName": "addressableListId", + "title": "Addressable List", + "value": { + "description": "The id of the addressable object", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "AddressableListId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "addressableListUrl", + "key": "url", + "schema": { + "generatedName": "addressableListUrl", + "title": "Addressable List", + "value": { + "description": "Url to get more company resources for this contact", + "schema": { + "format": "uri", + "example": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "generatedName": "AddressableListUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list used to access other resources from a parent model.", + "generatedName": "AddressableList", + "title": "Addressable List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "admin": { + "generatedName": "Admin", + "nameOverride": "Admin", + "title": "Admin", + "description": "Admins are teammate accounts that have access to a workspace.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminType", + "key": "type", + "schema": { + "generatedName": "adminType", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "String representing the object's type. Always has the value `admin`.", + "schema": { + "example": "admin", + "type": "string" + }, + "generatedName": "AdminType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminId", + "key": "id", + "schema": { + "generatedName": "adminId", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The id representing the admin.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "AdminId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminName", + "key": "name", + "schema": { + "generatedName": "adminName", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The name of the admin.", + "schema": { + "example": "Hoban Washburne", + "type": "string" + }, + "generatedName": "AdminName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminEmail", + "key": "email", + "schema": { + "generatedName": "adminEmail", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The email of the admin.", + "schema": { + "example": "wash@serenity.io", + "type": "string" + }, + "generatedName": "AdminEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminJobTitle", + "key": "job_title", + "schema": { + "generatedName": "adminJobTitle", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The job title of the admin.", + "schema": { + "example": "Philosopher", + "type": "string" + }, + "generatedName": "AdminJobTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminAwayModeEnabled", + "key": "away_mode_enabled", + "schema": { + "generatedName": "adminAwayModeEnabled", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin is currently set in away mode.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "AdminAwayModeEnabled", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminAwayModeReassign", + "key": "away_mode_reassign", + "schema": { + "generatedName": "adminAwayModeReassign", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "AdminAwayModeReassign", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminHasInboxSeat", + "key": "has_inbox_seat", + "schema": { + "generatedName": "adminHasInboxSeat", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "AdminHasInboxSeat", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminTeamIds", + "key": "team_ids", + "schema": { + "generatedName": "adminTeamIds", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "This object represents the avatar associated with the admin.", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "AdminTeamIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminTeamIds", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminAvatar", + "key": "avatar", + "schema": { + "generatedName": "adminAvatar", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "generatedName": "AdminAvatar", + "description": "Image for the associated team or teammate", + "value": { + "description": "Image for the associated team or teammate", + "schema": { + "format": "uri", + "example": "https://picsum.photos/200/300", + "type": "string" + }, + "generatedName": "AdminAvatar", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminTeamPriorityLevel", + "key": "team_priority_level", + "schema": { + "generatedName": "adminTeamPriorityLevel", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "generatedName": "AdminTeamPriorityLevel", + "schema": "team_priority_level", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Admins" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Admins are teammate accounts that have access to a workspace.", + "generatedName": "Admin", + "nameOverride": "Admin", + "title": "Admin", + "groupName": [ + "Admins" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Admins" + ], + "type": "nullable" + }, + "admin_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminListType", + "key": "type", + "schema": { + "generatedName": "adminListType", + "nameOverride": "Admins", + "title": "Admins", + "value": { + "description": "String representing the object's type. Always has the value `admin.list`.", + "schema": { + "example": "admin.list", + "type": "string" + }, + "generatedName": "AdminListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminListAdmins", + "key": "admins", + "schema": { + "generatedName": "adminListAdmins", + "nameOverride": "Admins", + "title": "Admins", + "value": { + "description": "A list of admins associated with a given workspace.", + "value": { + "generatedName": "AdminListAdminsItem", + "schema": "admin", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "AdminListAdmins", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of admins associated with a given workspace.", + "generatedName": "AdminList", + "nameOverride": "Admins", + "title": "Admins", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "admin_priority_level": { + "generatedName": "AdminPriorityLevel", + "title": "Admin Priority Level", + "description": "Admin priority levels for the team", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminPriorityLevelPrimaryAdminIds", + "key": "primary_admin_ids", + "schema": { + "generatedName": "adminPriorityLevelPrimaryAdminIds", + "title": "Admin Priority Level", + "value": { + "generatedName": "AdminPriorityLevelPrimaryAdminIds", + "description": "The primary admin ids for the team", + "value": { + "description": "The primary admin ids for the team", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "AdminPriorityLevelPrimaryAdminIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminPriorityLevelPrimaryAdminIds", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminPriorityLevelSecondaryAdminIds", + "key": "secondary_admin_ids", + "schema": { + "generatedName": "adminPriorityLevelSecondaryAdminIds", + "title": "Admin Priority Level", + "value": { + "generatedName": "AdminPriorityLevelSecondaryAdminIds", + "description": "The secondary admin ids for the team", + "value": { + "description": "The secondary admin ids for the team", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "AdminPriorityLevelSecondaryAdminIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminPriorityLevelSecondaryAdminIds", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Admin priority levels for the team", + "generatedName": "AdminPriorityLevel", + "title": "Admin Priority Level", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "admin_reply_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestMessageType", + "key": "message_type", + "schema": { + "generatedName": "AdminReplyConversationRequestMessageType", + "values": [ + { + "generatedName": "comment", + "value": "comment", + "casing": {} + }, + { + "generatedName": "note", + "value": "note", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestType", + "key": "type", + "schema": { + "value": { + "value": "admin", + "type": "string" + }, + "generatedName": "AdminReplyConversationRequestType", + "groupName": [], + "type": "literal" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestBody", + "key": "body", + "schema": { + "generatedName": "adminReplyConversationRequestBody", + "title": "Admin Reply", + "value": { + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "schema": { + "example": "Hello there!", + "type": "string" + }, + "generatedName": "AdminReplyConversationRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is authoring the comment.", + "schema": { + "example": "3156780", + "type": "string" + }, + "generatedName": "AdminReplyConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "adminReplyConversationRequestCreatedAt", + "title": "Admin Reply", + "value": { + "description": "The time the reply was created. If not provided, the current time will be used.", + "schema": { + "example": 1590000000, + "type": "int" + }, + "generatedName": "AdminReplyConversationRequestCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestAttachmentUrls", + "key": "attachment_urls", + "schema": { + "generatedName": "adminReplyConversationRequestAttachmentUrls", + "title": "Admin Reply", + "value": { + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "value": { + "schema": { + "format": "uri", + "type": "string" + }, + "generatedName": "AdminReplyConversationRequestAttachmentUrlsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminReplyConversationRequestAttachmentUrls", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyConversationRequestAttachmentFiles", + "key": "attachment_files", + "schema": { + "generatedName": "adminReplyConversationRequestAttachmentFiles", + "title": "Admin Reply", + "value": { + "description": "A list of files that will be added as attachments. You can include up to 10 files", + "value": { + "generatedName": "AdminReplyConversationRequestAttachmentFilesItem", + "schema": "conversation_attachment_files", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "AdminReplyConversationRequestAttachmentFiles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of an admin", + "generatedName": "AdminReplyConversationRequest", + "title": "Admin Reply", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "admin_reply_ticket_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestMessageType", + "key": "message_type", + "schema": { + "generatedName": "AdminReplyTicketRequestMessageType", + "values": [ + { + "generatedName": "comment", + "value": "comment", + "casing": {} + }, + { + "generatedName": "note", + "value": "note", + "casing": {} + }, + { + "generatedName": "quick_reply", + "value": "quick_reply", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestType", + "key": "type", + "schema": { + "value": { + "value": "admin", + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestType", + "groupName": [], + "type": "literal" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestBody", + "key": "body", + "schema": { + "generatedName": "adminReplyTicketRequestBody", + "title": "Admin Reply on ticket", + "value": { + "description": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "schema": { + "example": "Hello there!", + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is authoring the comment.", + "schema": { + "example": "3156780", + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "adminReplyTicketRequestCreatedAt", + "title": "Admin Reply on ticket", + "value": { + "description": "The time the reply was created. If not provided, the current time will be used.", + "schema": { + "example": 1590000000, + "type": "int" + }, + "generatedName": "AdminReplyTicketRequestCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestReplyOptions", + "key": "reply_options", + "schema": { + "generatedName": "adminReplyTicketRequestReplyOptions", + "title": "Admin Reply on ticket", + "value": { + "description": "The quick reply options to display. Must be present for quick_reply message types.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestReplyOptionsItemText", + "key": "text", + "schema": { + "description": "The text to display in this quick reply option.", + "schema": { + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestReplyOptionsItemText", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestReplyOptionsItemUuid", + "key": "uuid", + "schema": { + "description": "A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option.", + "schema": { + "format": "uuid", + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestReplyOptionsItemUuid", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AdminReplyTicketRequestReplyOptionsItem", + "title": "Quick Reply Option", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "AdminReplyTicketRequestReplyOptions", + "title": "Quick Reply Options", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminReplyTicketRequestAttachmentUrls", + "key": "attachment_urls", + "schema": { + "generatedName": "adminReplyTicketRequestAttachmentUrls", + "title": "Admin Reply on ticket", + "value": { + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "value": { + "schema": { + "format": "uri", + "type": "string" + }, + "generatedName": "AdminReplyTicketRequestAttachmentUrlsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminReplyTicketRequestAttachmentUrls", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of an admin", + "generatedName": "AdminReplyTicketRequest", + "title": "Admin Reply on ticket", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "admin_with_app": { + "generatedName": "AdminWithApp", + "nameOverride": "Admin", + "title": "Admin", + "description": "Admins are the teammate accounts that have access to a workspace", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminWithAppType", + "key": "type", + "schema": { + "generatedName": "adminWithAppType", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "String representing the object's type. Always has the value `admin`.", + "schema": { + "example": "admin", + "type": "string" + }, + "generatedName": "AdminWithAppType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppId", + "key": "id", + "schema": { + "generatedName": "adminWithAppId", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The id representing the admin.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "AdminWithAppId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppName", + "key": "name", + "schema": { + "generatedName": "adminWithAppName", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The name of the admin.", + "schema": { + "example": "Hoban Washburne", + "type": "string" + }, + "generatedName": "AdminWithAppName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppEmail", + "key": "email", + "schema": { + "generatedName": "adminWithAppEmail", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The email of the admin.", + "schema": { + "example": "wash@serenity.io", + "type": "string" + }, + "generatedName": "AdminWithAppEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppJobTitle", + "key": "job_title", + "schema": { + "generatedName": "adminWithAppJobTitle", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "The job title of the admin.", + "schema": { + "example": "Philosopher", + "type": "string" + }, + "generatedName": "AdminWithAppJobTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppAwayModeEnabled", + "key": "away_mode_enabled", + "schema": { + "generatedName": "adminWithAppAwayModeEnabled", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin is currently set in away mode.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "AdminWithAppAwayModeEnabled", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppAwayModeReassign", + "key": "away_mode_reassign", + "schema": { + "generatedName": "adminWithAppAwayModeReassign", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "AdminWithAppAwayModeReassign", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppHasInboxSeat", + "key": "has_inbox_seat", + "schema": { + "generatedName": "adminWithAppHasInboxSeat", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "AdminWithAppHasInboxSeat", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppTeamIds", + "key": "team_ids", + "schema": { + "generatedName": "adminWithAppTeamIds", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "This is a list of ids of the teams that this admin is part of.", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "AdminWithAppTeamIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "AdminWithAppTeamIds", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppAvatar", + "key": "avatar", + "schema": { + "generatedName": "adminWithAppAvatar", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "adminWithAppAvatarType", + "key": "type", + "schema": { + "generatedName": "adminWithAppAvatarType", + "value": { + "description": "This is a string that identifies the type of the object. It will always have the value `avatar`.", + "schema": { + "default": "avatar", + "example": "avatar", + "type": "string" + }, + "generatedName": "AdminWithAppAvatarType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppAvatarImageUrl", + "key": "image_url", + "schema": { + "generatedName": "adminWithAppAvatarImageUrl", + "value": { + "generatedName": "AdminWithAppAvatarImageUrl", + "description": "This object represents the avatar associated with the admin.", + "value": { + "description": "This object represents the avatar associated with the admin.", + "schema": { + "format": "uri", + "example": "https://example.com/avatar.png", + "type": "string" + }, + "generatedName": "AdminWithAppAvatarImageUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This object represents the avatar associated with the admin.", + "generatedName": "AdminWithAppAvatar", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppEmailVerified", + "key": "email_verified", + "schema": { + "generatedName": "adminWithAppEmailVerified", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "generatedName": "AdminWithAppEmailVerified", + "description": "Identifies if this admin's email is verified.", + "value": { + "description": "Identifies if this admin's email is verified.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "AdminWithAppEmailVerified", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "adminWithAppApp", + "key": "app", + "schema": { + "generatedName": "adminWithAppApp", + "nameOverride": "Admin", + "title": "Admin", + "value": { + "description": "App that the admin belongs to.", + "generatedName": "AdminWithAppApp", + "schema": "app", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Admins are the teammate accounts that have access to a workspace", + "generatedName": "AdminWithApp", + "nameOverride": "Admin", + "title": "Admin", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "ai_agent": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "aiAgentSourceType", + "key": "source_type", + "schema": { + "generatedName": "aiAgentSourceType", + "title": "AI Agent", + "value": { + "description": "The type of the source that triggered AI Agent involvement in the conversation.", + "generatedName": "AiAgentSourceType", + "values": [ + { + "generatedName": "essentials_plan_setup", + "value": "essentials_plan_setup", + "casing": {} + }, + { + "generatedName": "profile", + "value": "profile", + "casing": {} + }, + { + "generatedName": "workflow", + "value": "workflow", + "casing": {} + }, + { + "generatedName": "workflow_preview", + "value": "workflow_preview", + "casing": {} + }, + { + "generatedName": "fin_preview", + "value": "fin_preview", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentSourceTitle", + "key": "source_title", + "schema": { + "generatedName": "aiAgentSourceTitle", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentSourceTitle", + "description": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.", + "value": { + "description": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.", + "schema": { + "example": "My AI Workflow", + "type": "string" + }, + "generatedName": "AiAgentSourceTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentLastAnswerType", + "key": "last_answer_type", + "schema": { + "generatedName": "aiAgentLastAnswerType", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentLastAnswerType", + "description": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`", + "value": { + "description": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`", + "schema": { + "example": "ai_answer", + "type": "string" + }, + "generatedName": "AiAgentLastAnswerType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentResolutionState", + "key": "resolution_state", + "schema": { + "generatedName": "aiAgentResolutionState", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentResolutionState", + "description": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.", + "value": { + "description": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.", + "schema": { + "example": "assumed_resolution", + "type": "string" + }, + "generatedName": "AiAgentResolutionState", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentRating", + "key": "rating", + "schema": { + "generatedName": "aiAgentRating", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentRating", + "description": "The customer satisfaction rating given to AI Agent, from 1-5.", + "value": { + "description": "The customer satisfaction rating given to AI Agent, from 1-5.", + "schema": { + "example": 4, + "type": "int" + }, + "generatedName": "AiAgentRating", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentRatingRemark", + "key": "rating_remark", + "schema": { + "generatedName": "aiAgentRatingRemark", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentRatingRemark", + "description": "The customer satisfaction rating remark given to AI Agent.", + "value": { + "description": "The customer satisfaction rating remark given to AI Agent.", + "schema": { + "example": "Very helpful!", + "type": "string" + }, + "generatedName": "AiAgentRatingRemark", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "aiAgentContentSources", + "key": "content_sources", + "schema": { + "generatedName": "aiAgentContentSources", + "title": "AI Agent", + "value": { + "generatedName": "AiAgentContentSources", + "schema": "content_sources_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Ai Agent" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Data related to AI Agent involvement in the conversation.", + "generatedName": "AiAgent", + "title": "AI Agent", + "groupName": [ + "Ai Agent" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "app": { + "generatedName": "App", + "nameOverride": "App", + "title": "App", + "description": "App is a workspace on Intercom", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "appType", + "key": "type", + "schema": { + "generatedName": "appType", + "nameOverride": "App", + "title": "App", + "value": { + "description": "", + "schema": { + "default": "app", + "example": "app", + "type": "string" + }, + "generatedName": "AppType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appIdCode", + "key": "id_code", + "schema": { + "generatedName": "appIdCode", + "nameOverride": "App", + "title": "App", + "value": { + "description": "The id of the app.", + "schema": { + "example": "xyz789", + "type": "string" + }, + "generatedName": "AppIdCode", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appName", + "key": "name", + "schema": { + "generatedName": "appName", + "nameOverride": "App", + "title": "App", + "value": { + "description": "The name of the app.", + "schema": { + "example": "ACME", + "type": "string" + }, + "generatedName": "AppName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appRegion", + "key": "region", + "schema": { + "generatedName": "appRegion", + "nameOverride": "App", + "title": "App", + "value": { + "description": "The Intercom region the app is located in.", + "schema": { + "example": "US", + "type": "string" + }, + "generatedName": "AppRegion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appTimezone", + "key": "timezone", + "schema": { + "generatedName": "appTimezone", + "nameOverride": "App", + "title": "App", + "value": { + "description": "The timezone of the region where the app is located.", + "schema": { + "example": "America/Los_Angeles", + "type": "string" + }, + "generatedName": "AppTimezone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "appCreatedAt", + "nameOverride": "App", + "title": "App", + "value": { + "description": "When the app was created.", + "schema": { + "example": 1671465577, + "type": "int" + }, + "generatedName": "AppCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "appIdentityVerification", + "key": "identity_verification", + "schema": { + "generatedName": "appIdentityVerification", + "nameOverride": "App", + "title": "App", + "value": { + "description": "Whether or not the app uses identity verification.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "AppIdentityVerification", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "App is a workspace on Intercom", + "generatedName": "App", + "nameOverride": "App", + "title": "App", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "article": { + "allOf": [ + { + "generatedName": "ArticleListItem", + "schema": "article_list_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "articleStatistics", + "key": "statistics", + "schema": { + "generatedName": "articleStatistics", + "nameOverride": "Article", + "title": "Article", + "value": { + "generatedName": "ArticleStatistics", + "schema": "article_statistics", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.", + "generatedName": "Article", + "nameOverride": "Article", + "title": "Article", + "groupName": [ + "Articles" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "article_content": { + "generatedName": "ArticleContent", + "title": "Article Content", + "description": "The Content of an Article.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleContentType", + "key": "type", + "schema": { + "generatedName": "articleContentType", + "title": "Article Content", + "value": { + "generatedName": "ArticleContentType", + "description": "The type of object - `article_content` .", + "value": { + "description": "The type of object - `article_content` .", + "schema": { + "example": "article_content", + "type": "string" + }, + "generatedName": "ArticleContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentTitle", + "key": "title", + "schema": { + "generatedName": "articleContentTitle", + "title": "Article Content", + "value": { + "description": "The title of the article.", + "schema": { + "example": "How to create a new article", + "type": "string" + }, + "generatedName": "ArticleContentTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentDescription", + "key": "description", + "schema": { + "generatedName": "articleContentDescription", + "title": "Article Content", + "value": { + "description": "The description of the article.", + "schema": { + "example": "This article will show you how to create a new article.", + "type": "string" + }, + "generatedName": "ArticleContentDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentBody", + "key": "body", + "schema": { + "generatedName": "articleContentBody", + "title": "Article Content", + "value": { + "description": "The body of the article.", + "schema": { + "example": "This is the body of the article.", + "type": "string" + }, + "generatedName": "ArticleContentBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentAuthorId", + "key": "author_id", + "schema": { + "generatedName": "articleContentAuthorId", + "title": "Article Content", + "value": { + "description": "The ID of the author of the article.", + "schema": { + "type": "int" + }, + "generatedName": "ArticleContentAuthorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentState", + "key": "state", + "schema": { + "generatedName": "articleContentState", + "title": "Article Content", + "value": { + "description": "Whether the article is `published` or is a `draft` .", + "generatedName": "ArticleContentState", + "values": [ + { + "generatedName": "published", + "value": "published", + "casing": {} + }, + { + "generatedName": "draft", + "value": "draft", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "articleContentCreatedAt", + "title": "Article Content", + "value": { + "description": "The time when the article was created (seconds).", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "ArticleContentCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "articleContentUpdatedAt", + "title": "Article Content", + "value": { + "description": "The time when the article was last updated (seconds).", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ArticleContentUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleContentUrl", + "key": "url", + "schema": { + "generatedName": "articleContentUrl", + "title": "Article Content", + "value": { + "description": "The URL of the article.", + "schema": { + "example": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "generatedName": "ArticleContentUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The Content of an Article.", + "generatedName": "ArticleContent", + "title": "Article Content", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "article_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleListType", + "key": "type", + "schema": { + "generatedName": "articleListType", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The type of the object - `list`.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "ArticleListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListPages", + "key": "pages", + "schema": { + "generatedName": "articleListPages", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "articleListTotalCount", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "A count of the total number of articles.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "ArticleListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListData", + "key": "data", + "schema": { + "generatedName": "articleListData", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "An array of Article objects", + "value": { + "generatedName": "ArticleListDataItem", + "schema": "article_list_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ArticleListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of articles for the App.", + "generatedName": "ArticleList", + "nameOverride": "Articles", + "title": "Articles", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "article_list_item": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleListItemType", + "key": "type", + "schema": { + "generatedName": "articleListItemType", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The type of object - `article`.", + "value": { + "value": "article", + "type": "string" + }, + "generatedName": "ArticleListItemType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemId", + "key": "id", + "schema": { + "generatedName": "articleListItemId", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The unique identifier for the article which is given by Intercom.", + "schema": { + "example": "6871119", + "type": "string" + }, + "generatedName": "ArticleListItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "articleListItemWorkspaceId", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The id of the workspace which the article belongs to.", + "schema": { + "example": "hfi1bx4l", + "type": "string" + }, + "generatedName": "ArticleListItemWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemTitle", + "key": "title", + "schema": { + "generatedName": "articleListItemTitle", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The title of the article. For multilingual articles, this will be the title of the default language's content.", + "schema": { + "example": "Default language title", + "type": "string" + }, + "generatedName": "ArticleListItemTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemDescription", + "key": "description", + "schema": { + "generatedName": "articleListItemDescription", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemDescription", + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "value": { + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "schema": { + "example": "Default language description", + "type": "string" + }, + "generatedName": "ArticleListItemDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemBody", + "key": "body", + "schema": { + "generatedName": "articleListItemBody", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemBody", + "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.", + "value": { + "description": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.", + "schema": { + "example": "Default language body in html", + "type": "string" + }, + "generatedName": "ArticleListItemBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemAuthorId", + "key": "author_id", + "schema": { + "generatedName": "articleListItemAuthorId", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "schema": { + "type": "int" + }, + "generatedName": "ArticleListItemAuthorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemState", + "key": "state", + "schema": { + "generatedName": "articleListItemState", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", + "generatedName": "ArticleListItemState", + "values": [ + { + "generatedName": "published", + "value": "published", + "casing": {} + }, + { + "generatedName": "draft", + "value": "draft", + "casing": {} + } + ], + "default": { + "generatedName": "draft", + "value": "draft", + "casing": {} + }, + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "articleListItemCreatedAt", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.", + "schema": { + "example": 1672928359, + "type": "int" + }, + "generatedName": "ArticleListItemCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "articleListItemUpdatedAt", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.", + "schema": { + "example": 1672928610, + "type": "int" + }, + "generatedName": "ArticleListItemUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemUrl", + "key": "url", + "schema": { + "generatedName": "articleListItemUrl", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemUrl", + "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content.", + "value": { + "description": "The URL of the article. For multilingual articles, this will be the URL of the default language's content.", + "schema": { + "example": "http://intercom.test/help/en/articles/3-default-language", + "type": "string" + }, + "generatedName": "ArticleListItemUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemParentId", + "key": "parent_id", + "schema": { + "generatedName": "articleListItemParentId", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemParentId", + "description": "The id of the article's parent collection or section. An article without this field stands alone.", + "value": { + "description": "The id of the article's parent collection or section. An article without this field stands alone.", + "schema": { + "type": "int" + }, + "generatedName": "ArticleListItemParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemParentIds", + "key": "parent_ids", + "schema": { + "generatedName": "articleListItemParentIds", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The ids of the article's parent collections or sections. An article without this field stands alone.", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "ArticleListItemParentIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "ArticleListItemParentIds", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemParentType", + "key": "parent_type", + "schema": { + "generatedName": "articleListItemParentType", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemParentType", + "description": "The type of parent, which can either be a `collection` or `section`.", + "value": { + "description": "The type of parent, which can either be a `collection` or `section`.", + "schema": { + "example": "collection", + "type": "string" + }, + "generatedName": "ArticleListItemParentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemDefaultLocale", + "key": "default_locale", + "schema": { + "generatedName": "articleListItemDefaultLocale", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "description": "The default locale of the help center. This field is only returned for multilingual help centers.", + "schema": { + "example": "en", + "type": "string" + }, + "generatedName": "ArticleListItemDefaultLocale", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleListItemTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "articleListItemTranslatedContent", + "nameOverride": "Articles", + "title": "Articles", + "value": { + "generatedName": "ArticleListItemTranslatedContent", + "schema": "article_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The data returned about your articles when you list them.", + "generatedName": "ArticleListItem", + "nameOverride": "Articles", + "title": "Articles", + "groupName": [ + "Articles" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "article_search_highlights": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleSearchHighlightsArticleId", + "key": "article_id", + "schema": { + "generatedName": "articleSearchHighlightsArticleId", + "title": "Article Search Highlights", + "value": { + "description": "The ID of the corresponding article.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "ArticleSearchHighlightsArticleId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedTitle", + "key": "highlighted_title", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedTitle", + "title": "Article Search Highlights", + "value": { + "description": "An Article title highlighted.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedTitleItemType", + "key": "type", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedTitleItemType", + "value": { + "description": "The type of text - `highlight` or `plain`.", + "generatedName": "ArticleSearchHighlightsHighlightedTitleItemType", + "values": [ + { + "generatedName": "highlight", + "value": "highlight", + "casing": {} + }, + { + "generatedName": "plain", + "value": "plain", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedTitleItemText", + "key": "text", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedTitleItemText", + "value": { + "description": "The text of the title.", + "schema": { + "example": "my query", + "type": "string" + }, + "generatedName": "ArticleSearchHighlightsHighlightedTitleItemText", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A highlighted article title.", + "generatedName": "ArticleSearchHighlightsHighlightedTitleItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "ArticleSearchHighlightsHighlightedTitle", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedSummary", + "key": "highlighted_summary", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedSummary", + "title": "Article Search Highlights", + "value": { + "description": "An Article description and body text highlighted.", + "value": { + "description": "An array containing the highlighted summary text split into chunks of plain and highlighted text.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedSummaryItemItemType", + "key": "type", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedSummaryItemItemType", + "value": { + "description": "The type of text - `highlight` or `plain`.", + "generatedName": "ArticleSearchHighlightsHighlightedSummaryItemItemType", + "values": [ + { + "generatedName": "highlight", + "value": "highlight", + "casing": {} + }, + { + "generatedName": "plain", + "value": "plain", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchHighlightsHighlightedSummaryItemItemText", + "key": "text", + "schema": { + "generatedName": "articleSearchHighlightsHighlightedSummaryItemItemText", + "value": { + "description": "The text of the title.", + "schema": { + "example": "my query", + "type": "string" + }, + "generatedName": "ArticleSearchHighlightsHighlightedSummaryItemItemText", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An instance of highlighted summary text.", + "generatedName": "ArticleSearchHighlightsHighlightedSummaryItemItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "ArticleSearchHighlightsHighlightedSummaryItem", + "groupName": [], + "type": "array" + }, + "generatedName": "ArticleSearchHighlightsHighlightedSummary", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The highlighted results of an Article search. In the examples provided my search query is always \"my query\".", + "generatedName": "ArticleSearchHighlights", + "title": "Article Search Highlights", + "groupName": [ + "Articles" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "article_search_response": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleSearchResponseType", + "key": "type", + "schema": { + "generatedName": "articleSearchResponseType", + "title": "Article Search Response", + "value": { + "description": "The type of the object - `list`.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "ArticleSearchResponseType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchResponseTotalCount", + "key": "total_count", + "schema": { + "generatedName": "articleSearchResponseTotalCount", + "title": "Article Search Response", + "value": { + "description": "The total number of Articles matching the search query", + "schema": { + "example": 5, + "type": "int" + }, + "generatedName": "ArticleSearchResponseTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchResponseData", + "key": "data", + "schema": { + "generatedName": "articleSearchResponseData", + "title": "Article Search Response", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleSearchResponseDataArticles", + "key": "articles", + "schema": { + "generatedName": "articleSearchResponseDataArticles", + "value": { + "description": "An array of Article objects", + "value": { + "generatedName": "ArticleSearchResponseDataArticlesItem", + "schema": "article", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ArticleSearchResponseDataArticles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchResponseDataHighlights", + "key": "highlights", + "schema": { + "generatedName": "articleSearchResponseDataHighlights", + "value": { + "description": "A corresponding array of highlighted Article content", + "value": { + "generatedName": "ArticleSearchResponseDataHighlightsItem", + "schema": "article_search_highlights", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ArticleSearchResponseDataHighlights", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing the results of the search.", + "generatedName": "ArticleSearchResponseData", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleSearchResponsePages", + "key": "pages", + "schema": { + "generatedName": "articleSearchResponsePages", + "title": "Article Search Response", + "value": { + "generatedName": "ArticleSearchResponsePages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Articles" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The results of an Article search", + "generatedName": "ArticleSearchResponse", + "title": "Article Search Response", + "groupName": [ + "Articles" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "article_statistics": { + "generatedName": "ArticleStatistics", + "title": "Article Statistics", + "description": "The statistics of an article.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleStatisticsType", + "key": "type", + "schema": { + "generatedName": "articleStatisticsType", + "title": "Article Statistics", + "value": { + "description": "The type of object - `article_statistics`.", + "value": { + "value": "article_statistics", + "type": "string" + }, + "generatedName": "ArticleStatisticsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsViews", + "key": "views", + "schema": { + "generatedName": "articleStatisticsViews", + "title": "Article Statistics", + "value": { + "description": "The number of total views the article has received.", + "schema": { + "example": 10, + "type": "int" + }, + "generatedName": "ArticleStatisticsViews", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsConversions", + "key": "conversions", + "schema": { + "generatedName": "articleStatisticsConversions", + "title": "Article Statistics", + "value": { + "description": "The number of conversations started from the article.", + "schema": { + "example": 0, + "type": "int" + }, + "generatedName": "ArticleStatisticsConversions", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsReactions", + "key": "reactions", + "schema": { + "generatedName": "articleStatisticsReactions", + "title": "Article Statistics", + "value": { + "description": "The number of total reactions the article has received.", + "schema": { + "example": 10, + "type": "int" + }, + "generatedName": "ArticleStatisticsReactions", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsHappyReactionPercentage", + "key": "happy_reaction_percentage", + "schema": { + "generatedName": "articleStatisticsHappyReactionPercentage", + "title": "Article Statistics", + "value": { + "description": "The percentage of happy reactions the article has received against other types of reaction.", + "schema": { + "type": "float" + }, + "generatedName": "ArticleStatisticsHappyReactionPercentage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsNeutralReactionPercentage", + "key": "neutral_reaction_percentage", + "schema": { + "generatedName": "articleStatisticsNeutralReactionPercentage", + "title": "Article Statistics", + "value": { + "description": "The percentage of neutral reactions the article has received against other types of reaction.", + "schema": { + "type": "float" + }, + "generatedName": "ArticleStatisticsNeutralReactionPercentage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleStatisticsSadReactionPercentage", + "key": "sad_reaction_percentage", + "schema": { + "generatedName": "articleStatisticsSadReactionPercentage", + "title": "Article Statistics", + "value": { + "description": "The percentage of sad reactions the article has received against other types of reaction.", + "schema": { + "type": "float" + }, + "generatedName": "ArticleStatisticsSadReactionPercentage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The statistics of an article.", + "generatedName": "ArticleStatistics", + "title": "Article Statistics", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "article_translated_content": { + "generatedName": "ArticleTranslatedContent", + "title": "Article Translated Content", + "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "articleTranslatedContentType", + "key": "type", + "schema": { + "generatedName": "articleTranslatedContentType", + "title": "Article Translated Content", + "value": { + "generatedName": "ArticleTranslatedContentType", + "description": "The type of object - article_translated_content.", + "value": { + "description": "The type of object - article_translated_content.", + "schema": { + "example": "article_translated_content", + "type": "string" + }, + "generatedName": "ArticleTranslatedContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentAr", + "key": "ar", + "schema": { + "generatedName": "articleTranslatedContentAr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Arabic", + "generatedName": "ArticleTranslatedContentAr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentBg", + "key": "bg", + "schema": { + "generatedName": "articleTranslatedContentBg", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Bulgarian", + "generatedName": "ArticleTranslatedContentBg", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentBs", + "key": "bs", + "schema": { + "generatedName": "articleTranslatedContentBs", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Bosnian", + "generatedName": "ArticleTranslatedContentBs", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentCa", + "key": "ca", + "schema": { + "generatedName": "articleTranslatedContentCa", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Catalan", + "generatedName": "ArticleTranslatedContentCa", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentCs", + "key": "cs", + "schema": { + "generatedName": "articleTranslatedContentCs", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Czech", + "generatedName": "ArticleTranslatedContentCs", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentDa", + "key": "da", + "schema": { + "generatedName": "articleTranslatedContentDa", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Danish", + "generatedName": "ArticleTranslatedContentDa", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentDe", + "key": "de", + "schema": { + "generatedName": "articleTranslatedContentDe", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in German", + "generatedName": "ArticleTranslatedContentDe", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentEl", + "key": "el", + "schema": { + "generatedName": "articleTranslatedContentEl", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Greek", + "generatedName": "ArticleTranslatedContentEl", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentEn", + "key": "en", + "schema": { + "generatedName": "articleTranslatedContentEn", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in English", + "generatedName": "ArticleTranslatedContentEn", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentEs", + "key": "es", + "schema": { + "generatedName": "articleTranslatedContentEs", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Spanish", + "generatedName": "ArticleTranslatedContentEs", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentEt", + "key": "et", + "schema": { + "generatedName": "articleTranslatedContentEt", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Estonian", + "generatedName": "ArticleTranslatedContentEt", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentFi", + "key": "fi", + "schema": { + "generatedName": "articleTranslatedContentFi", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Finnish", + "generatedName": "ArticleTranslatedContentFi", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentFr", + "key": "fr", + "schema": { + "generatedName": "articleTranslatedContentFr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in French", + "generatedName": "ArticleTranslatedContentFr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentHe", + "key": "he", + "schema": { + "generatedName": "articleTranslatedContentHe", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Hebrew", + "generatedName": "ArticleTranslatedContentHe", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentHr", + "key": "hr", + "schema": { + "generatedName": "articleTranslatedContentHr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Croatian", + "generatedName": "ArticleTranslatedContentHr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentHu", + "key": "hu", + "schema": { + "generatedName": "articleTranslatedContentHu", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Hungarian", + "generatedName": "ArticleTranslatedContentHu", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentId", + "key": "id", + "schema": { + "generatedName": "articleTranslatedContentId", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Indonesian", + "generatedName": "ArticleTranslatedContentId", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentIt", + "key": "it", + "schema": { + "generatedName": "articleTranslatedContentIt", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Italian", + "generatedName": "ArticleTranslatedContentIt", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentJa", + "key": "ja", + "schema": { + "generatedName": "articleTranslatedContentJa", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Japanese", + "generatedName": "ArticleTranslatedContentJa", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentKo", + "key": "ko", + "schema": { + "generatedName": "articleTranslatedContentKo", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Korean", + "generatedName": "ArticleTranslatedContentKo", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentLt", + "key": "lt", + "schema": { + "generatedName": "articleTranslatedContentLt", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Lithuanian", + "generatedName": "ArticleTranslatedContentLt", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentLv", + "key": "lv", + "schema": { + "generatedName": "articleTranslatedContentLv", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Latvian", + "generatedName": "ArticleTranslatedContentLv", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentMn", + "key": "mn", + "schema": { + "generatedName": "articleTranslatedContentMn", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Mongolian", + "generatedName": "ArticleTranslatedContentMn", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentNb", + "key": "nb", + "schema": { + "generatedName": "articleTranslatedContentNb", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Norwegian", + "generatedName": "ArticleTranslatedContentNb", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentNl", + "key": "nl", + "schema": { + "generatedName": "articleTranslatedContentNl", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Dutch", + "generatedName": "ArticleTranslatedContentNl", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentPl", + "key": "pl", + "schema": { + "generatedName": "articleTranslatedContentPl", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Polish", + "generatedName": "ArticleTranslatedContentPl", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentPt", + "key": "pt", + "schema": { + "generatedName": "articleTranslatedContentPt", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Portuguese (Portugal)", + "generatedName": "ArticleTranslatedContentPt", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentRo", + "key": "ro", + "schema": { + "generatedName": "articleTranslatedContentRo", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Romanian", + "generatedName": "ArticleTranslatedContentRo", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentRu", + "key": "ru", + "schema": { + "generatedName": "articleTranslatedContentRu", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Russian", + "generatedName": "ArticleTranslatedContentRu", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentSl", + "key": "sl", + "schema": { + "generatedName": "articleTranslatedContentSl", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Slovenian", + "generatedName": "ArticleTranslatedContentSl", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentSr", + "key": "sr", + "schema": { + "generatedName": "articleTranslatedContentSr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Serbian", + "generatedName": "ArticleTranslatedContentSr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentSv", + "key": "sv", + "schema": { + "generatedName": "articleTranslatedContentSv", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Swedish", + "generatedName": "ArticleTranslatedContentSv", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentTr", + "key": "tr", + "schema": { + "generatedName": "articleTranslatedContentTr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Turkish", + "generatedName": "ArticleTranslatedContentTr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentVi", + "key": "vi", + "schema": { + "generatedName": "articleTranslatedContentVi", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Vietnamese", + "generatedName": "ArticleTranslatedContentVi", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentPtBr", + "key": "pt-BR", + "schema": { + "generatedName": "articleTranslatedContentPtBr", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Portuguese (Brazil)", + "generatedName": "ArticleTranslatedContentPtBr", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentZhCn", + "key": "zh-CN", + "schema": { + "generatedName": "articleTranslatedContentZhCn", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Chinese (China)", + "generatedName": "ArticleTranslatedContentZhCn", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "articleTranslatedContentZhTw", + "key": "zh-TW", + "schema": { + "generatedName": "articleTranslatedContentZhTw", + "title": "Article Translated Content", + "value": { + "description": "The content of the article in Chinese (Taiwan)", + "generatedName": "ArticleTranslatedContentZhTw", + "schema": "article_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "generatedName": "ArticleTranslatedContent", + "title": "Article Translated Content", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "assign_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "assignConversationRequestType", + "key": "type", + "schema": { + "generatedName": "AssignConversationRequestType", + "values": [ + { + "generatedName": "admin", + "value": "admin", + "casing": {} + }, + { + "generatedName": "team", + "value": "team", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "assignConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is performing the action.", + "schema": { + "example": "12345", + "type": "string" + }, + "generatedName": "AssignConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "assignConversationRequestAssigneeId", + "key": "assignee_id", + "schema": { + "description": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\\nSet `0` if you want this assign to no admin or team (ie. Unassigned).", + "schema": { + "example": "4324241", + "type": "string" + }, + "generatedName": "AssignConversationRequestAssigneeId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "assignConversationRequestBody", + "key": "body", + "schema": { + "generatedName": "assignConversationRequestBody", + "title": "Assign Conversation Request", + "value": { + "description": "Optionally you can send a response in the conversation when it is assigned.", + "schema": { + "example": "Let me pass you over to one of my colleagues.", + "type": "string" + }, + "generatedName": "AssignConversationRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to assign a conversation", + "generatedName": "AssignConversationRequest", + "title": "Assign Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "attach_contact_to_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestAdminId", + "key": "admin_id", + "schema": { + "generatedName": "attachContactToConversationRequestAdminId", + "title": "Assign Conversation Request", + "value": { + "description": "The `id` of the admin who is adding the new participant.", + "schema": { + "example": "12345", + "type": "string" + }, + "generatedName": "AttachContactToConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomer", + "key": "customer", + "schema": { + "generatedName": "attachContactToConversationRequestCustomer", + "title": "Assign Conversation Request", + "value": { + "value": { + "generatedName": "AttachContactToConversationRequestCustomer", + "schemas": [ + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerIntercomUserIdIntercomUserId", + "key": "intercom_user_id", + "schema": { + "description": "The identifier for the contact as given by Intercom.", + "schema": { + "example": "6329bd9ffe4e2e91dac76188", + "type": "string" + }, + "generatedName": "AttachContactToConversationRequestCustomerIntercomUserIdIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerIntercomUserIdCustomer", + "key": "customer", + "schema": { + "generatedName": "attachContactToConversationRequestCustomerIntercomUserIdCustomer", + "title": "Intercom User ID", + "value": { + "generatedName": "AttachContactToConversationRequestCustomerIntercomUserIdCustomer", + "schema": "customer_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachContactToConversationRequestCustomerIntercomUserId", + "title": "Intercom User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerUserIdUserId", + "key": "user_id", + "schema": { + "description": "The external_id you have defined for the contact who is being added as a participant.", + "schema": { + "example": "6329bd9ffe4e2e91dac76188", + "type": "string" + }, + "generatedName": "AttachContactToConversationRequestCustomerUserIdUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerUserIdCustomer", + "key": "customer", + "schema": { + "generatedName": "attachContactToConversationRequestCustomerUserIdCustomer", + "title": "User ID", + "value": { + "generatedName": "AttachContactToConversationRequestCustomerUserIdCustomer", + "schema": "customer_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachContactToConversationRequestCustomerUserId", + "title": "User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerCustomerEmail", + "key": "email", + "schema": { + "description": "The email you have defined for the contact who is being added as a participant.", + "schema": { + "example": "winstonsmith@truth.org", + "type": "string" + }, + "generatedName": "AttachContactToConversationRequestCustomerCustomerEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "attachContactToConversationRequestCustomerCustomerCustomer", + "key": "customer", + "schema": { + "generatedName": "attachContactToConversationRequestCustomerCustomerCustomer", + "nameOverride": "Email", + "title": "Email", + "value": { + "generatedName": "AttachContactToConversationRequestCustomerCustomerCustomer", + "schema": "customer_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "generatedName": "AttachContactToConversationRequestCustomerCustomer", + "nameOverride": "Email", + "title": "Email", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to assign a conversation", + "generatedName": "AttachContactToConversationRequest", + "title": "Assign Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "close_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "closeConversationRequestType", + "key": "type", + "schema": { + "value": { + "value": "admin", + "type": "string" + }, + "generatedName": "CloseConversationRequestType", + "groupName": [], + "type": "literal" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "closeConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is performing the action.", + "schema": { + "example": "12345", + "type": "string" + }, + "generatedName": "CloseConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "closeConversationRequestBody", + "key": "body", + "schema": { + "generatedName": "closeConversationRequestBody", + "title": "Close Conversation Request", + "value": { + "description": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.", + "schema": { + "example": " This conversation is now closed!", + "type": "string" + }, + "generatedName": "CloseConversationRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to close a conversation", + "generatedName": "CloseConversationRequest", + "title": "Close Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "collection": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "collectionId", + "key": "id", + "schema": { + "generatedName": "collectionId", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The unique identifier for the collection which is given by Intercom.", + "schema": { + "example": "6871119", + "type": "string" + }, + "generatedName": "CollectionId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "collectionWorkspaceId", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The id of the workspace which the collection belongs to.", + "schema": { + "example": "hfi1bx4l", + "type": "string" + }, + "generatedName": "CollectionWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionName", + "key": "name", + "schema": { + "generatedName": "collectionName", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "schema": { + "example": "Default language name", + "type": "string" + }, + "generatedName": "CollectionName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionDescription", + "key": "description", + "schema": { + "generatedName": "collectionDescription", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionDescription", + "description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.", + "value": { + "description": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.", + "schema": { + "example": "Default language description", + "type": "string" + }, + "generatedName": "CollectionDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "collectionCreatedAt", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", + "schema": { + "example": 1672928359, + "type": "int" + }, + "generatedName": "CollectionCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "collectionUpdatedAt", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.", + "schema": { + "example": 1672928610, + "type": "int" + }, + "generatedName": "CollectionUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionUrl", + "key": "url", + "schema": { + "generatedName": "collectionUrl", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionUrl", + "description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.", + "value": { + "description": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.", + "schema": { + "example": "http://intercom.test/help/collection/name", + "type": "string" + }, + "generatedName": "CollectionUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionIcon", + "key": "icon", + "schema": { + "generatedName": "collectionIcon", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionIcon", + "description": "The icon of the collection.", + "value": { + "description": "The icon of the collection.", + "schema": { + "example": "book-bookmark", + "type": "string" + }, + "generatedName": "CollectionIcon", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionOrder", + "key": "order", + "schema": { + "generatedName": "collectionOrder", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.", + "schema": { + "type": "int" + }, + "generatedName": "CollectionOrder", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionDefaultLocale", + "key": "default_locale", + "schema": { + "generatedName": "collectionDefaultLocale", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "description": "The default locale of the help center. This field is only returned for multilingual help centers.", + "schema": { + "example": "en", + "type": "string" + }, + "generatedName": "CollectionDefaultLocale", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "collectionTranslatedContent", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionTranslatedContent", + "schema": "group_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "collectionParentId", + "key": "parent_id", + "schema": { + "generatedName": "collectionParentId", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionParentId", + "description": "The id of the parent collection. If `null` then it is the first level collection.", + "value": { + "description": "The id of the parent collection. If `null` then it is the first level collection.", + "schema": { + "example": "6871118", + "type": "string" + }, + "generatedName": "CollectionParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionHelpCenterId", + "key": "help_center_id", + "schema": { + "generatedName": "collectionHelpCenterId", + "nameOverride": "Collection", + "title": "Collection", + "value": { + "generatedName": "CollectionHelpCenterId", + "description": "The id of the help center the collection is in.", + "value": { + "description": "The id of the help center the collection is in.", + "schema": { + "type": "int" + }, + "generatedName": "CollectionHelpCenterId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Collections are top level containers for Articles within the Help Center.", + "generatedName": "Collection", + "nameOverride": "Collection", + "title": "Collection", + "groupName": [ + "Help Center" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "collection_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "collectionListType", + "key": "type", + "schema": { + "generatedName": "collectionListType", + "nameOverride": "Collections", + "title": "Collections", + "value": { + "description": "The type of the object - `list`.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "CollectionListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionListPages", + "key": "pages", + "schema": { + "generatedName": "collectionListPages", + "nameOverride": "Collections", + "title": "Collections", + "value": { + "generatedName": "CollectionListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "collectionListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "collectionListTotalCount", + "nameOverride": "Collections", + "title": "Collections", + "value": { + "description": "A count of the total number of collections.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "CollectionListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "collectionListData", + "key": "data", + "schema": { + "generatedName": "collectionListData", + "nameOverride": "Collections", + "title": "Collections", + "value": { + "description": "An array of collection objects", + "value": { + "generatedName": "CollectionListDataItem", + "schema": "collection", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CollectionListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of Collections for the App.", + "generatedName": "CollectionList", + "nameOverride": "Collections", + "title": "Collections", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "company": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyType", + "key": "type", + "schema": { + "generatedName": "companyType", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "Value is `company`", + "value": { + "value": "company", + "type": "string" + }, + "generatedName": "CompanyType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyId", + "key": "id", + "schema": { + "generatedName": "companyId", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The Intercom defined id representing the company.", + "schema": { + "example": "531ee472cce572a6ec000006", + "type": "string" + }, + "generatedName": "CompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyName", + "key": "name", + "schema": { + "generatedName": "companyName", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The name of the company.", + "schema": { + "example": "Blue Sun", + "type": "string" + }, + "generatedName": "CompanyName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyAppId", + "key": "app_id", + "schema": { + "generatedName": "companyAppId", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The Intercom defined code of the workspace the company is associated to.", + "schema": { + "example": "ecahpwf5", + "type": "string" + }, + "generatedName": "CompanyAppId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyPlan", + "key": "plan", + "schema": { + "generatedName": "companyPlan", + "nameOverride": "Company", + "title": "Company", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyPlanType", + "key": "type", + "schema": { + "generatedName": "companyPlanType", + "value": { + "description": "Value is always \"plan\"", + "schema": { + "example": "plan", + "type": "string" + }, + "generatedName": "CompanyPlanType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyPlanId", + "key": "id", + "schema": { + "generatedName": "companyPlanId", + "value": { + "description": "The id of the plan", + "schema": { + "example": "269315", + "type": "string" + }, + "generatedName": "CompanyPlanId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyPlanName", + "key": "name", + "schema": { + "generatedName": "companyPlanName", + "value": { + "description": "The name of the plan", + "schema": { + "example": "Pro", + "type": "string" + }, + "generatedName": "CompanyPlanName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CompanyPlan", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyCompanyId", + "key": "company_id", + "schema": { + "generatedName": "companyCompanyId", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The company id you have defined for the company.", + "schema": { + "example": "6", + "type": "string" + }, + "generatedName": "CompanyCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyRemoteCreatedAt", + "key": "remote_created_at", + "schema": { + "generatedName": "companyRemoteCreatedAt", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The time the company was created by you.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "CompanyRemoteCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "companyCreatedAt", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The time the company was added in Intercom.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "CompanyCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "companyUpdatedAt", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The last time the company was updated.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "CompanyUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyLastRequestAt", + "key": "last_request_at", + "schema": { + "generatedName": "companyLastRequestAt", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The time the company last recorded making a request.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "CompanyLastRequestAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companySize", + "key": "size", + "schema": { + "generatedName": "companySize", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The number of employees in the company.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanySize", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyWebsite", + "key": "website", + "schema": { + "generatedName": "companyWebsite", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The URL for the company website.", + "schema": { + "example": "https://www.intercom.com", + "type": "string" + }, + "generatedName": "CompanyWebsite", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyIndustry", + "key": "industry", + "schema": { + "generatedName": "companyIndustry", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The industry that the company operates in.", + "schema": { + "example": "Software", + "type": "string" + }, + "generatedName": "CompanyIndustry", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyMonthlySpend", + "key": "monthly_spend", + "schema": { + "generatedName": "companyMonthlySpend", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "How much revenue the company generates for your business.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanyMonthlySpend", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companySessionCount", + "key": "session_count", + "schema": { + "generatedName": "companySessionCount", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "How many sessions the company has recorded.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanySessionCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyUserCount", + "key": "user_count", + "schema": { + "generatedName": "companyUserCount", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The number of users in the company.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanyUserCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "companyCustomAttributes", + "nameOverride": "Company", + "title": "Company", + "value": { + "description": "The custom attributes you have set on the company.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "CompanyCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "schema": { + "type": "string" + }, + "generatedName": "CompanyCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "generatedName": "CompanyCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyTags", + "key": "tags", + "schema": { + "generatedName": "companyTags", + "nameOverride": "Company", + "title": "Company", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyTagsType", + "key": "type", + "schema": { + "generatedName": "companyTagsType", + "value": { + "description": "The type of the object", + "value": { + "value": "tag.list", + "type": "string" + }, + "generatedName": "CompanyTagsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyTagsTags", + "key": "tags", + "schema": { + "generatedName": "companyTagsTags", + "value": { + "value": { + "generatedName": "CompanyTagsTagsItem", + "type": "unknown" + }, + "generatedName": "CompanyTagsTags", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The list of tags associated with the company", + "generatedName": "CompanyTags", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companySegments", + "key": "segments", + "schema": { + "generatedName": "companySegments", + "nameOverride": "Company", + "title": "Company", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companySegmentsType", + "key": "type", + "schema": { + "generatedName": "companySegmentsType", + "value": { + "description": "The type of the object", + "value": { + "value": "segment.list", + "type": "string" + }, + "generatedName": "CompanySegmentsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companySegmentsSegments", + "key": "segments", + "schema": { + "generatedName": "companySegmentsSegments", + "value": { + "value": { + "generatedName": "CompanySegmentsSegmentsItem", + "schema": "segment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CompanySegmentsSegments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The list of segments associated with the company", + "generatedName": "CompanySegments", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Companies" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "generatedName": "Company", + "nameOverride": "Company", + "title": "Company", + "groupName": [ + "Companies" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "company_attached_contacts": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyAttachedContactsType", + "key": "type", + "schema": { + "generatedName": "companyAttachedContactsType", + "title": "Company Attached Contacts", + "value": { + "description": "The type of object - `list`", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "CompanyAttachedContactsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyAttachedContactsData", + "key": "data", + "schema": { + "generatedName": "companyAttachedContactsData", + "title": "Company Attached Contacts", + "value": { + "description": "An array containing Contact Objects", + "value": { + "generatedName": "CompanyAttachedContactsDataItem", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CompanyAttachedContactsData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyAttachedContactsTotalCount", + "key": "total_count", + "schema": { + "generatedName": "companyAttachedContactsTotalCount", + "title": "Company Attached Contacts", + "value": { + "description": "The total number of contacts", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanyAttachedContactsTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyAttachedContactsPages", + "key": "pages", + "schema": { + "generatedName": "companyAttachedContactsPages", + "title": "Company Attached Contacts", + "value": { + "generatedName": "CompanyAttachedContactsPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Contact Objects", + "generatedName": "CompanyAttachedContacts", + "title": "Company Attached Contacts", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "company_attached_segments": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyAttachedSegmentsType", + "key": "type", + "schema": { + "generatedName": "companyAttachedSegmentsType", + "title": "Company Attached Segments", + "value": { + "description": "The type of object - `list`", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "CompanyAttachedSegmentsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyAttachedSegmentsData", + "key": "data", + "schema": { + "generatedName": "companyAttachedSegmentsData", + "title": "Company Attached Segments", + "value": { + "description": "An array containing Segment Objects", + "value": { + "generatedName": "CompanyAttachedSegmentsDataItem", + "schema": "segment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CompanyAttachedSegmentsData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Segment Objects", + "generatedName": "CompanyAttachedSegments", + "title": "Company Attached Segments", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "company_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyListType", + "key": "type", + "schema": { + "generatedName": "companyListType", + "nameOverride": "Companies", + "title": "Companies", + "value": { + "description": "The type of object - `list`.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "CompanyListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyListPages", + "key": "pages", + "schema": { + "generatedName": "companyListPages", + "nameOverride": "Companies", + "title": "Companies", + "value": { + "generatedName": "CompanyListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "companyListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "companyListTotalCount", + "nameOverride": "Companies", + "title": "Companies", + "value": { + "description": "The total number of companies.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanyListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyListData", + "key": "data", + "schema": { + "generatedName": "companyListData", + "nameOverride": "Companies", + "title": "Companies", + "value": { + "description": "An array containing Company Objects.", + "value": { + "generatedName": "CompanyListDataItem", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CompanyListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of companies for the App.", + "generatedName": "CompanyList", + "nameOverride": "Companies", + "title": "Companies", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "company_scroll": { + "generatedName": "CompanyScroll", + "title": "Company Scroll", + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "companyScrollType", + "key": "type", + "schema": { + "generatedName": "companyScrollType", + "title": "Company Scroll", + "value": { + "description": "The type of object - `list`", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "CompanyScrollType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyScrollData", + "key": "data", + "schema": { + "generatedName": "companyScrollData", + "title": "Company Scroll", + "value": { + "value": { + "generatedName": "CompanyScrollDataItem", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "CompanyScrollData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyScrollPages", + "key": "pages", + "schema": { + "generatedName": "companyScrollPages", + "title": "Company Scroll", + "value": { + "generatedName": "CompanyScrollPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "companyScrollTotalCount", + "key": "total_count", + "schema": { + "generatedName": "companyScrollTotalCount", + "title": "Company Scroll", + "value": { + "generatedName": "CompanyScrollTotalCount", + "description": "The total number of companies", + "value": { + "description": "The total number of companies", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "CompanyScrollTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "companyScrollScrollParam", + "key": "scroll_param", + "schema": { + "generatedName": "companyScrollScrollParam", + "title": "Company Scroll", + "value": { + "description": "The scroll parameter to use in the next request to fetch the next page of results.", + "schema": { + "example": "25b649f7-4d33-4ef6-88f5-60e5b8244309", + "type": "string" + }, + "generatedName": "CompanyScrollScrollParam", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "generatedName": "CompanyScroll", + "title": "Company Scroll", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "contact": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactType", + "key": "type", + "schema": { + "generatedName": "contactType", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The type of object.", + "schema": { + "example": "contact", + "type": "string" + }, + "generatedName": "ContactType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactId", + "key": "id", + "schema": { + "generatedName": "contactId", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The unique identifier for the contact which is given by Intercom.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "ContactId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactExternalId", + "key": "external_id", + "schema": { + "generatedName": "contactExternalId", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ContactExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "contactWorkspaceId", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The id of the workspace which the contact belongs to.", + "schema": { + "example": "ecahpwf5", + "type": "string" + }, + "generatedName": "ContactWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactRole", + "key": "role", + "schema": { + "generatedName": "contactRole", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The role of the contact.", + "schema": { + "example": "user", + "type": "string" + }, + "generatedName": "ContactRole", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactEmail", + "key": "email", + "schema": { + "generatedName": "contactEmail", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The contact's email.", + "schema": { + "example": "joe@example.com", + "type": "string" + }, + "generatedName": "ContactEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactEmailDomain", + "key": "email_domain", + "schema": { + "generatedName": "contactEmailDomain", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The contact's email domain.", + "schema": { + "example": "example.com", + "type": "string" + }, + "generatedName": "ContactEmailDomain", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactPhone", + "key": "phone", + "schema": { + "generatedName": "contactPhone", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactPhone", + "description": "The contacts phone.", + "value": { + "description": "The contacts phone.", + "schema": { + "example": "+1123456789", + "type": "string" + }, + "generatedName": "ContactPhone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactFormattedPhone", + "key": "formatted_phone", + "schema": { + "generatedName": "contactFormattedPhone", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactFormattedPhone", + "description": "The contacts phone number normalized to the E164 format", + "value": { + "description": "The contacts phone number normalized to the E164 format", + "schema": { + "example": "+1123456789", + "type": "string" + }, + "generatedName": "ContactFormattedPhone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactName", + "key": "name", + "schema": { + "generatedName": "contactName", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactName", + "description": "The contacts name.", + "value": { + "description": "The contacts name.", + "schema": { + "example": "John Doe", + "type": "string" + }, + "generatedName": "ContactName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactOwnerId", + "key": "owner_id", + "schema": { + "generatedName": "contactOwnerId", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactOwnerId", + "description": "The id of an admin that has been assigned account ownership of the contact.", + "value": { + "description": "The id of an admin that has been assigned account ownership of the contact.", + "schema": { + "example": 123, + "type": "int" + }, + "generatedName": "ContactOwnerId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactHasHardBounced", + "key": "has_hard_bounced", + "schema": { + "generatedName": "contactHasHardBounced", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "Whether the contact has had an email sent to them hard bounce.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactHasHardBounced", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactMarkedEmailAsSpam", + "key": "marked_email_as_spam", + "schema": { + "generatedName": "contactMarkedEmailAsSpam", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "Whether the contact has marked an email sent to them as spam.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactMarkedEmailAsSpam", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactUnsubscribedFromEmails", + "key": "unsubscribed_from_emails", + "schema": { + "generatedName": "contactUnsubscribedFromEmails", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "Whether the contact is unsubscribed from emails.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactUnsubscribedFromEmails", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "contactCreatedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "(UNIX timestamp) The time when the contact was created.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "contactUpdatedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "(UNIX timestamp) The time when the contact was last updated.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactSignedUpAt", + "key": "signed_up_at", + "schema": { + "generatedName": "contactSignedUpAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactSignedUpAt", + "description": "(UNIX timestamp) The time specified for when a contact signed up.", + "value": { + "description": "(UNIX timestamp) The time specified for when a contact signed up.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactSignedUpAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLastSeenAt", + "key": "last_seen_at", + "schema": { + "generatedName": "contactLastSeenAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLastSeenAt", + "description": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).", + "value": { + "description": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactLastSeenAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLastRepliedAt", + "key": "last_replied_at", + "schema": { + "generatedName": "contactLastRepliedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLastRepliedAt", + "description": "(UNIX timestamp) The time when the contact last messaged in.", + "value": { + "description": "(UNIX timestamp) The time when the contact last messaged in.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactLastRepliedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLastContactedAt", + "key": "last_contacted_at", + "schema": { + "generatedName": "contactLastContactedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLastContactedAt", + "description": "(UNIX timestamp) The time when the contact was last messaged.", + "value": { + "description": "(UNIX timestamp) The time when the contact was last messaged.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactLastContactedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLastEmailOpenedAt", + "key": "last_email_opened_at", + "schema": { + "generatedName": "contactLastEmailOpenedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLastEmailOpenedAt", + "description": "(UNIX timestamp) The time when the contact last opened an email.", + "value": { + "description": "(UNIX timestamp) The time when the contact last opened an email.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactLastEmailOpenedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLastEmailClickedAt", + "key": "last_email_clicked_at", + "schema": { + "generatedName": "contactLastEmailClickedAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLastEmailClickedAt", + "description": "(UNIX timestamp) The time when the contact last clicked a link in an email.", + "value": { + "description": "(UNIX timestamp) The time when the contact last clicked a link in an email.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactLastEmailClickedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLanguageOverride", + "key": "language_override", + "schema": { + "generatedName": "contactLanguageOverride", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLanguageOverride", + "description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.", + "value": { + "description": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.", + "schema": { + "example": "en", + "type": "string" + }, + "generatedName": "ContactLanguageOverride", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactBrowser", + "key": "browser", + "schema": { + "generatedName": "contactBrowser", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactBrowser", + "description": "The name of the browser which the contact is using.", + "value": { + "description": "The name of the browser which the contact is using.", + "schema": { + "example": "Chrome", + "type": "string" + }, + "generatedName": "ContactBrowser", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactBrowserVersion", + "key": "browser_version", + "schema": { + "generatedName": "contactBrowserVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactBrowserVersion", + "description": "The version of the browser which the contact is using.", + "value": { + "description": "The version of the browser which the contact is using.", + "schema": { + "example": "80.0.3987.132", + "type": "string" + }, + "generatedName": "ContactBrowserVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactBrowserLanguage", + "key": "browser_language", + "schema": { + "generatedName": "contactBrowserLanguage", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactBrowserLanguage", + "description": "The language set by the browser which the contact is using.", + "value": { + "description": "The language set by the browser which the contact is using.", + "schema": { + "example": "en-US", + "type": "string" + }, + "generatedName": "ContactBrowserLanguage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactOs", + "key": "os", + "schema": { + "generatedName": "contactOs", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactOs", + "description": "The operating system which the contact is using.", + "value": { + "description": "The operating system which the contact is using.", + "schema": { + "example": "Mac OS X", + "type": "string" + }, + "generatedName": "ContactOs", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidAppName", + "key": "android_app_name", + "schema": { + "generatedName": "contactAndroidAppName", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidAppName", + "description": "The name of the Android app which the contact is using.", + "value": { + "description": "The name of the Android app which the contact is using.", + "schema": { + "example": "Intercom", + "type": "string" + }, + "generatedName": "ContactAndroidAppName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidAppVersion", + "key": "android_app_version", + "schema": { + "generatedName": "contactAndroidAppVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidAppVersion", + "description": "The version of the Android app which the contact is using.", + "value": { + "description": "The version of the Android app which the contact is using.", + "schema": { + "example": "5.0.0", + "type": "string" + }, + "generatedName": "ContactAndroidAppVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidDevice", + "key": "android_device", + "schema": { + "generatedName": "contactAndroidDevice", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidDevice", + "description": "The Android device which the contact is using.", + "value": { + "description": "The Android device which the contact is using.", + "schema": { + "example": "Pixel 3", + "type": "string" + }, + "generatedName": "ContactAndroidDevice", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidOsVersion", + "key": "android_os_version", + "schema": { + "generatedName": "contactAndroidOsVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidOsVersion", + "description": "The version of the Android OS which the contact is using.", + "value": { + "description": "The version of the Android OS which the contact is using.", + "schema": { + "example": "10", + "type": "string" + }, + "generatedName": "ContactAndroidOsVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidSdkVersion", + "key": "android_sdk_version", + "schema": { + "generatedName": "contactAndroidSdkVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidSdkVersion", + "description": "The version of the Android SDK which the contact is using.", + "value": { + "description": "The version of the Android SDK which the contact is using.", + "schema": { + "example": "28", + "type": "string" + }, + "generatedName": "ContactAndroidSdkVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAndroidLastSeenAt", + "key": "android_last_seen_at", + "schema": { + "generatedName": "contactAndroidLastSeenAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAndroidLastSeenAt", + "description": "(UNIX timestamp) The time when the contact was last seen on an Android device.", + "value": { + "description": "(UNIX timestamp) The time when the contact was last seen on an Android device.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactAndroidLastSeenAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosAppName", + "key": "ios_app_name", + "schema": { + "generatedName": "contactIosAppName", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosAppName", + "description": "The name of the iOS app which the contact is using.", + "value": { + "description": "The name of the iOS app which the contact is using.", + "schema": { + "example": "Intercom", + "type": "string" + }, + "generatedName": "ContactIosAppName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosAppVersion", + "key": "ios_app_version", + "schema": { + "generatedName": "contactIosAppVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosAppVersion", + "description": "The version of the iOS app which the contact is using.", + "value": { + "description": "The version of the iOS app which the contact is using.", + "schema": { + "example": "5.0.0", + "type": "string" + }, + "generatedName": "ContactIosAppVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosDevice", + "key": "ios_device", + "schema": { + "generatedName": "contactIosDevice", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosDevice", + "description": "The iOS device which the contact is using.", + "value": { + "description": "The iOS device which the contact is using.", + "schema": { + "example": "iPhone 11", + "type": "string" + }, + "generatedName": "ContactIosDevice", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosOsVersion", + "key": "ios_os_version", + "schema": { + "generatedName": "contactIosOsVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosOsVersion", + "description": "The version of iOS which the contact is using.", + "value": { + "description": "The version of iOS which the contact is using.", + "schema": { + "example": "13.3.1", + "type": "string" + }, + "generatedName": "ContactIosOsVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosSdkVersion", + "key": "ios_sdk_version", + "schema": { + "generatedName": "contactIosSdkVersion", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosSdkVersion", + "description": "The version of the iOS SDK which the contact is using.", + "value": { + "description": "The version of the iOS SDK which the contact is using.", + "schema": { + "example": "13.3.1", + "type": "string" + }, + "generatedName": "ContactIosSdkVersion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactIosLastSeenAt", + "key": "ios_last_seen_at", + "schema": { + "generatedName": "contactIosLastSeenAt", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactIosLastSeenAt", + "description": "(UNIX timestamp) The last time the contact used the iOS app.", + "value": { + "description": "(UNIX timestamp) The last time the contact used the iOS app.", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "ContactIosLastSeenAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "contactCustomAttributes", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "description": "The custom attributes which are set for the contact.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "ContactCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "generatedName": "ContactCustomAttributesValue", + "type": "unknown" + }, + "generatedName": "ContactCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAvatar", + "key": "avatar", + "schema": { + "generatedName": "contactAvatar", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactAvatar", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactAvatarType", + "key": "type", + "schema": { + "generatedName": "contactAvatarType", + "value": { + "description": "The type of object", + "schema": { + "example": "avatar", + "type": "string" + }, + "generatedName": "ContactAvatarType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAvatarImageUrl", + "key": "image_url", + "schema": { + "generatedName": "contactAvatarImageUrl", + "value": { + "generatedName": "ContactAvatarImageUrl", + "description": "An image URL containing the avatar of a contact.", + "value": { + "description": "An image URL containing the avatar of a contact.", + "schema": { + "format": "uri", + "example": "https://example.org/128Wash.jpg", + "type": "string" + }, + "generatedName": "ContactAvatarImageUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "ContactAvatar", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactTags", + "key": "tags", + "schema": { + "generatedName": "contactTags", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactTags", + "schema": "contact_tags", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "contactNotes", + "key": "notes", + "schema": { + "generatedName": "contactNotes", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactNotes", + "schema": "contact_notes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "contactCompanies", + "key": "companies", + "schema": { + "generatedName": "contactCompanies", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactCompanies", + "schema": "contact_companies", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "contactLocation", + "key": "location", + "schema": { + "generatedName": "contactLocation", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactLocation", + "schema": "contact_location", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "contactSocialProfiles", + "key": "social_profiles", + "schema": { + "generatedName": "contactSocialProfiles", + "nameOverride": "Contact", + "title": "Contact", + "value": { + "generatedName": "ContactSocialProfiles", + "schema": "contact_social_profiles", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Contacts" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Contact are the objects that represent your leads and users in Intercom.", + "generatedName": "Contact", + "nameOverride": "Contact", + "title": "Contact", + "groupName": [ + "Contacts" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_archived": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactArchivedType", + "key": "type", + "schema": { + "generatedName": "contactArchivedType", + "title": "Contact Archived", + "value": { + "description": "always contact", + "value": { + "value": "contact", + "type": "string" + }, + "generatedName": "ContactArchivedType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactArchivedId", + "key": "id", + "schema": { + "generatedName": "contactArchivedId", + "title": "Contact Archived", + "value": { + "description": "The unique identifier for the contact which is given by Intercom.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "ContactArchivedId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactArchivedExternalId", + "key": "external_id", + "schema": { + "generatedName": "contactArchivedExternalId", + "title": "Contact Archived", + "value": { + "generatedName": "ContactArchivedExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ContactArchivedExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactArchivedArchived", + "key": "archived", + "schema": { + "generatedName": "contactArchivedArchived", + "title": "Contact Archived", + "value": { + "description": "Whether the contact is archived or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactArchivedArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "archived contact object", + "generatedName": "ContactArchived", + "title": "Contact Archived", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_attached_companies": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactAttachedCompaniesType", + "key": "type", + "schema": { + "generatedName": "contactAttachedCompaniesType", + "title": "Contact Attached Companies", + "value": { + "description": "The type of object", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "ContactAttachedCompaniesType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAttachedCompaniesCompanies", + "key": "companies", + "schema": { + "generatedName": "contactAttachedCompaniesCompanies", + "title": "Contact Attached Companies", + "value": { + "description": "An array containing Company Objects", + "value": { + "generatedName": "ContactAttachedCompaniesCompaniesItem", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactAttachedCompaniesCompanies", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAttachedCompaniesTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactAttachedCompaniesTotalCount", + "title": "Contact Attached Companies", + "value": { + "description": "The total number of companies associated to this contact", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactAttachedCompaniesTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactAttachedCompaniesPages", + "key": "pages", + "schema": { + "generatedName": "contactAttachedCompaniesPages", + "title": "Contact Attached Companies", + "value": { + "generatedName": "ContactAttachedCompaniesPages", + "schema": "pages_link", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Company Objects", + "generatedName": "ContactAttachedCompanies", + "title": "Contact Attached Companies", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_companies": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactCompaniesUrl", + "key": "url", + "schema": { + "generatedName": "contactCompaniesUrl", + "title": "Contact companies", + "value": { + "description": "Url to get more company resources for this contact", + "schema": { + "format": "uri", + "example": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + "type": "string" + }, + "generatedName": "ContactCompaniesUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactCompaniesTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactCompaniesTotalCount", + "title": "Contact companies", + "value": { + "description": "Int representing the total number of companyies attached to this contact", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactCompaniesTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactCompaniesHasMore", + "key": "has_more", + "schema": { + "generatedName": "contactCompaniesHasMore", + "title": "Contact companies", + "value": { + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactCompaniesHasMore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "generatedName": "ContactCompanies", + "title": "Contact companies", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_deleted": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactDeletedType", + "key": "type", + "schema": { + "generatedName": "contactDeletedType", + "title": "Contact Deleted", + "value": { + "description": "always contact", + "value": { + "value": "contact", + "type": "string" + }, + "generatedName": "ContactDeletedType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactDeletedId", + "key": "id", + "schema": { + "generatedName": "contactDeletedId", + "title": "Contact Deleted", + "value": { + "description": "The unique identifier for the contact which is given by Intercom.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "ContactDeletedId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactDeletedExternalId", + "key": "external_id", + "schema": { + "generatedName": "contactDeletedExternalId", + "title": "Contact Deleted", + "value": { + "generatedName": "ContactDeletedExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ContactDeletedExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactDeletedDeleted", + "key": "deleted", + "schema": { + "generatedName": "contactDeletedDeleted", + "title": "Contact Deleted", + "value": { + "description": "Whether the contact is deleted or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactDeletedDeleted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "deleted contact object", + "generatedName": "ContactDeleted", + "title": "Contact Deleted", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactListType", + "key": "type", + "schema": { + "generatedName": "contactListType", + "title": "Contact List", + "value": { + "description": "Always list", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "ContactListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactListData", + "key": "data", + "schema": { + "generatedName": "contactListData", + "title": "Contact List", + "value": { + "description": "The list of contact objects", + "value": { + "generatedName": "ContactListDataItem", + "schema": "contact", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactListTotalCount", + "title": "Contact List", + "value": { + "description": "A count of the total number of objects.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactListPages", + "key": "pages", + "schema": { + "generatedName": "contactListPages", + "title": "Contact List", + "value": { + "generatedName": "ContactListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Contacts are your users in Intercom.", + "generatedName": "ContactList", + "title": "Contact List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_location": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactLocationType", + "key": "type", + "schema": { + "generatedName": "contactLocationType", + "title": "Contact Location", + "value": { + "generatedName": "ContactLocationType", + "description": "Always location", + "value": { + "description": "Always location", + "schema": { + "example": "location", + "type": "string" + }, + "generatedName": "ContactLocationType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLocationCountry", + "key": "country", + "schema": { + "generatedName": "contactLocationCountry", + "title": "Contact Location", + "value": { + "generatedName": "ContactLocationCountry", + "description": "The country that the contact is located in", + "value": { + "description": "The country that the contact is located in", + "schema": { + "example": "Ireland", + "type": "string" + }, + "generatedName": "ContactLocationCountry", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLocationRegion", + "key": "region", + "schema": { + "generatedName": "contactLocationRegion", + "title": "Contact Location", + "value": { + "generatedName": "ContactLocationRegion", + "description": "The overal region that the contact is located in", + "value": { + "description": "The overal region that the contact is located in", + "schema": { + "example": "Dublin", + "type": "string" + }, + "generatedName": "ContactLocationRegion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactLocationCity", + "key": "city", + "schema": { + "generatedName": "contactLocationCity", + "title": "Contact Location", + "value": { + "generatedName": "ContactLocationCity", + "description": "The city that the contact is located in", + "value": { + "description": "The city that the contact is located in", + "schema": { + "example": "Dublin", + "type": "string" + }, + "generatedName": "ContactLocationCity", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing location meta data about a Intercom contact.", + "generatedName": "ContactLocation", + "title": "Contact Location", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_notes": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactNotesData", + "key": "data", + "schema": { + "generatedName": "contactNotesData", + "title": "Contact notes", + "value": { + "description": "This object represents the notes attached to a contact.", + "value": { + "generatedName": "ContactNotesDataItem", + "schema": "addressable_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactNotesData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactNotesUrl", + "key": "url", + "schema": { + "generatedName": "contactNotesUrl", + "title": "Contact notes", + "value": { + "description": "Url to get more company resources for this contact", + "schema": { + "format": "uri", + "example": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + "type": "string" + }, + "generatedName": "ContactNotesUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactNotesTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactNotesTotalCount", + "title": "Contact notes", + "value": { + "description": "Int representing the total number of companyies attached to this contact", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactNotesTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactNotesHasMore", + "key": "has_more", + "schema": { + "generatedName": "contactNotesHasMore", + "title": "Contact notes", + "value": { + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactNotesHasMore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "generatedName": "ContactNotes", + "title": "Contact notes", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reference": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReferenceType", + "key": "type", + "schema": { + "generatedName": "contactReferenceType", + "title": "Contact Reference", + "value": { + "description": "always contact", + "value": { + "value": "contact", + "type": "string" + }, + "generatedName": "ContactReferenceType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReferenceId", + "key": "id", + "schema": { + "generatedName": "contactReferenceId", + "title": "Contact Reference", + "value": { + "description": "The unique identifier for the contact which is given by Intercom.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "ContactReferenceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReferenceExternalId", + "key": "external_id", + "schema": { + "generatedName": "contactReferenceExternalId", + "title": "Contact Reference", + "value": { + "generatedName": "ContactReferenceExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ContactReferenceExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "reference to contact object", + "generatedName": "ContactReference", + "title": "Contact Reference", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_base_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyBaseRequestMessageType", + "key": "message_type", + "schema": { + "value": { + "value": "comment", + "type": "string" + }, + "generatedName": "ContactReplyBaseRequestMessageType", + "groupName": [], + "type": "literal" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyBaseRequestType", + "key": "type", + "schema": { + "value": { + "value": "user", + "type": "string" + }, + "generatedName": "ContactReplyBaseRequestType", + "groupName": [], + "type": "literal" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyBaseRequestBody", + "key": "body", + "schema": { + "description": "The text body of the comment.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyBaseRequestBody", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyBaseRequestCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "contactReplyBaseRequestCreatedAt", + "title": "Contact Reply Base Object", + "value": { + "description": "The time the reply was created. If not provided, the current time will be used.", + "schema": { + "example": 1590000000, + "type": "int" + }, + "generatedName": "ContactReplyBaseRequestCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyBaseRequestAttachmentUrls", + "key": "attachment_urls", + "schema": { + "generatedName": "contactReplyBaseRequestAttachmentUrls", + "title": "Contact Reply Base Object", + "value": { + "description": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "value": { + "schema": { + "format": "uri", + "type": "string" + }, + "generatedName": "ContactReplyBaseRequestAttachmentUrlsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "ContactReplyBaseRequestAttachmentUrls", + "title": "Attachment URLs", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "ContactReplyBaseRequest", + "title": "Contact Reply Base Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_conversation_request": { + "value": { + "generatedName": "ContactReplyConversationRequest", + "title": "Contact Reply", + "schemas": [ + { + "generatedName": "ContactReplyConversationRequestZero", + "schema": "contact_reply_intercom_user_id_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ContactReplyConversationRequestOne", + "schema": "contact_reply_email_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ContactReplyConversationRequestTwo", + "schema": "contact_reply_user_id_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "contact_reply_email_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyEmailRequestEmail", + "key": "email", + "schema": { + "description": "The email you have defined for the user.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyEmailRequestEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyEmailRequestAttachmentFiles", + "key": "attachment_files", + "schema": { + "generatedName": "contactReplyEmailRequestAttachmentFiles", + "nameOverride": "Email", + "title": "Email", + "value": { + "description": "A list of files that will be added as attachments.", + "value": { + "generatedName": "ContactReplyEmailRequestAttachmentFilesItem", + "schema": "conversation_attachment_files", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactReplyEmailRequestAttachmentFiles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `email`", + "generatedName": "ContactReplyEmailRequest", + "nameOverride": "Email", + "title": "Email", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_intercom_user_id_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyIntercomUserIdRequestIntercomUserId", + "key": "intercom_user_id", + "schema": { + "description": "The identifier for the contact as given by Intercom.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyIntercomUserIdRequestIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyIntercomUserIdRequestAttachmentFiles", + "key": "attachment_files", + "schema": { + "generatedName": "contactReplyIntercomUserIdRequestAttachmentFiles", + "title": "Intercom User ID", + "value": { + "description": "A list of files that will be added as attachments.", + "value": { + "generatedName": "ContactReplyIntercomUserIdRequestAttachmentFilesItem", + "schema": "conversation_attachment_files", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactReplyIntercomUserIdRequestAttachmentFiles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "generatedName": "ContactReplyIntercomUserIdRequest", + "title": "Intercom User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_ticket_email_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyTicketEmailRequestEmail", + "key": "email", + "schema": { + "description": "The email you have defined for the user.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyTicketEmailRequestEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `email`", + "generatedName": "ContactReplyTicketEmailRequest", + "nameOverride": "Email", + "title": "Email", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_ticket_intercom_user_id_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyTicketIntercomUserIdRequestIntercomUserId", + "key": "intercom_user_id", + "schema": { + "description": "The identifier for the contact as given by Intercom.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyTicketIntercomUserIdRequestIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "generatedName": "ContactReplyTicketIntercomUserIdRequest", + "title": "Intercom User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_ticket_request": { + "value": { + "generatedName": "ContactReplyTicketRequest", + "title": "Contact Reply on ticket", + "schemas": [ + { + "generatedName": "ContactReplyTicketRequestZero", + "schema": "contact_reply_ticket_intercom_user_id_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ContactReplyTicketRequestOne", + "schema": "contact_reply_ticket_user_id_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ContactReplyTicketRequestTwo", + "schema": "contact_reply_ticket_email_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "contact_reply_ticket_user_id_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyTicketUserIdRequestUserId", + "key": "user_id", + "schema": { + "description": "The external_id you have defined for the contact.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyTicketUserIdRequestUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `user_id`", + "generatedName": "ContactReplyTicketUserIdRequest", + "title": "User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_reply_user_id_request": { + "allOf": [ + { + "generatedName": "ContactReplyBaseRequest", + "schema": "contact_reply_base_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "properties": [ + { + "conflict": {}, + "generatedName": "contactReplyUserIdRequestUserId", + "key": "user_id", + "schema": { + "description": "The external_id you have defined for the contact.", + "schema": { + "type": "string" + }, + "generatedName": "ContactReplyUserIdRequestUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactReplyUserIdRequestAttachmentFiles", + "key": "attachment_files", + "schema": { + "generatedName": "contactReplyUserIdRequestAttachmentFiles", + "title": "User ID", + "value": { + "description": "A list of files that will be added as attachments. You can include up to 10 files.", + "value": { + "generatedName": "ContactReplyUserIdRequestAttachmentFilesItem", + "schema": "conversation_attachment_files", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactReplyUserIdRequestAttachmentFiles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to reply on behalf of a contact using their `user_id`", + "generatedName": "ContactReplyUserIdRequest", + "title": "User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_segments": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactSegmentsType", + "key": "type", + "schema": { + "generatedName": "contactSegmentsType", + "nameOverride": "Segments", + "title": "Segments", + "value": { + "description": "The type of the object", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "ContactSegmentsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactSegmentsData", + "key": "data", + "schema": { + "generatedName": "contactSegmentsData", + "nameOverride": "Segments", + "title": "Segments", + "value": { + "description": "Segment objects associated with the contact.", + "value": { + "generatedName": "ContactSegmentsDataItem", + "schema": "segment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactSegmentsData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of segments objects attached to a specific contact.", + "generatedName": "ContactSegments", + "nameOverride": "Segments", + "title": "Segments", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_social_profiles": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactSocialProfilesData", + "key": "data", + "schema": { + "generatedName": "contactSocialProfilesData", + "title": "Social Profile", + "value": { + "description": "A list of social profiles objects associated with the contact.", + "value": { + "generatedName": "ContactSocialProfilesDataItem", + "schema": "social_profile", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactSocialProfilesData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing social profiles that a contact has.", + "generatedName": "ContactSocialProfiles", + "title": "Social Profile", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_subscription_types": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactSubscriptionTypesData", + "key": "data", + "schema": { + "generatedName": "contactSubscriptionTypesData", + "title": "Contact Subscription Types", + "value": { + "description": "This object represents the subscriptions attached to a contact.", + "value": { + "generatedName": "ContactSubscriptionTypesDataItem", + "schema": "addressable_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactSubscriptionTypesData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactSubscriptionTypesUrl", + "key": "url", + "schema": { + "generatedName": "contactSubscriptionTypesUrl", + "title": "Contact Subscription Types", + "value": { + "description": "Url to get more subscription type resources for this contact", + "schema": { + "format": "uri", + "example": "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions", + "type": "string" + }, + "generatedName": "ContactSubscriptionTypesUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactSubscriptionTypesTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactSubscriptionTypesTotalCount", + "title": "Contact Subscription Types", + "value": { + "description": "Int representing the total number of subscription types attached to this contact", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactSubscriptionTypesTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactSubscriptionTypesHasMore", + "key": "has_more", + "schema": { + "generatedName": "contactSubscriptionTypesHasMore", + "title": "Contact Subscription Types", + "value": { + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactSubscriptionTypesHasMore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", + "generatedName": "ContactSubscriptionTypes", + "title": "Contact Subscription Types", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "contact_tags": { + "generatedName": "ContactTags", + "title": "Contact Tags", + "description": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactTagsData", + "key": "data", + "schema": { + "generatedName": "contactTagsData", + "title": "Contact Tags", + "value": { + "description": "This object represents the tags attached to a contact.", + "value": { + "generatedName": "ContactTagsDataItem", + "schema": "addressable_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContactTagsData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactTagsUrl", + "key": "url", + "schema": { + "generatedName": "contactTagsUrl", + "title": "Contact Tags", + "value": { + "description": "url to get more tag resources for this contact", + "schema": { + "format": "uri", + "example": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + "type": "string" + }, + "generatedName": "ContactTagsUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactTagsTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contactTagsTotalCount", + "title": "Contact Tags", + "value": { + "description": "Int representing the total number of tags attached to this contact", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "ContactTagsTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactTagsHasMore", + "key": "has_more", + "schema": { + "generatedName": "contactTagsHasMore", + "title": "Contact Tags", + "value": { + "description": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ContactTagsHasMore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "generatedName": "ContactTags", + "title": "Contact Tags", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "contact_unarchived": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contactUnarchivedType", + "key": "type", + "schema": { + "generatedName": "contactUnarchivedType", + "title": "Contact Unarchived", + "value": { + "description": "always contact", + "value": { + "value": "contact", + "type": "string" + }, + "generatedName": "ContactUnarchivedType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactUnarchivedId", + "key": "id", + "schema": { + "generatedName": "contactUnarchivedId", + "title": "Contact Unarchived", + "value": { + "description": "The unique identifier for the contact which is given by Intercom.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "ContactUnarchivedId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactUnarchivedExternalId", + "key": "external_id", + "schema": { + "generatedName": "contactUnarchivedExternalId", + "title": "Contact Unarchived", + "value": { + "generatedName": "ContactUnarchivedExternalId", + "description": "The unique identifier for the contact which is provided by the Client.", + "value": { + "description": "The unique identifier for the contact which is provided by the Client.", + "schema": { + "example": "f3b87a2e09d514c6c2e79b9a", + "type": "string" + }, + "generatedName": "ContactUnarchivedExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contactUnarchivedArchived", + "key": "archived", + "schema": { + "generatedName": "contactUnarchivedArchived", + "title": "Contact Unarchived", + "value": { + "description": "Whether the contact is archived or not.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "ContactUnarchivedArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "unarchived contact object", + "generatedName": "ContactUnarchived", + "title": "Contact Unarchived", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "content_source": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contentSourceContentType", + "key": "content_type", + "schema": { + "generatedName": "contentSourceContentType", + "title": "Content Source", + "value": { + "description": "The type of the content source.", + "generatedName": "ContentSourceContentType", + "values": [ + { + "generatedName": "file", + "value": "file", + "casing": {} + }, + { + "generatedName": "article", + "value": "article", + "casing": {} + }, + { + "generatedName": "external_content", + "value": "external_content", + "casing": {} + }, + { + "generatedName": "content_snippet", + "value": "content_snippet", + "casing": {} + }, + { + "generatedName": "workflow_connector_action", + "value": "workflow_connector_action", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "AI Content Source" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contentSourceUrl", + "key": "url", + "schema": { + "generatedName": "contentSourceUrl", + "title": "Content Source", + "value": { + "description": "The internal URL linking to the content source for teammates.", + "schema": { + "example": "/fin-ai-agent/content?content=content_snippet&id=3234924", + "type": "string" + }, + "generatedName": "ContentSourceUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "AI Content Source" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contentSourceTitle", + "key": "title", + "schema": { + "generatedName": "contentSourceTitle", + "title": "Content Source", + "value": { + "description": "The title of the content source.", + "schema": { + "example": "My internal content snippet", + "type": "string" + }, + "generatedName": "ContentSourceTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "AI Content Source" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contentSourceLocale", + "key": "locale", + "schema": { + "generatedName": "contentSourceLocale", + "title": "Content Source", + "value": { + "description": "The ISO 639 language code of the content source.", + "schema": { + "example": "en", + "type": "string" + }, + "generatedName": "ContentSourceLocale", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "AI Content Source" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The content source used by AI Agent in the conversation.", + "generatedName": "ContentSource", + "title": "Content Source", + "groupName": [ + "AI Content Source" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "content_sources_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "contentSourcesListType", + "key": "type", + "schema": { + "generatedName": "contentSourcesListType", + "title": "Content Source List", + "value": { + "value": { + "value": "content_source.list", + "type": "string" + }, + "generatedName": "ContentSourcesListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contentSourcesListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "contentSourcesListTotalCount", + "title": "Content Source List", + "value": { + "description": "The total number of content sources used by AI Agent in the conversation.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "ContentSourcesListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "contentSourcesListContentSources", + "key": "content_sources", + "schema": { + "generatedName": "contentSourcesListContentSources", + "title": "Content Source List", + "value": { + "description": "The content sources used by AI Agent in the conversation.", + "value": { + "generatedName": "ContentSourcesListContentSourcesItem", + "schema": "content_source", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ContentSourcesListContentSources", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "ContentSourcesList", + "title": "Content Source List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationType", + "key": "type", + "schema": { + "generatedName": "conversationType", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "Always conversation.", + "schema": { + "example": "conversation", + "type": "string" + }, + "generatedName": "ConversationType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationId", + "key": "id", + "schema": { + "generatedName": "conversationId", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "The id representing the conversation.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "ConversationId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationTitle", + "key": "title", + "schema": { + "generatedName": "conversationTitle", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationTitle", + "description": "The title given to the conversation.", + "value": { + "description": "The title given to the conversation.", + "schema": { + "example": "Conversation Title", + "type": "string" + }, + "generatedName": "ConversationTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "conversationCreatedAt", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "The time the conversation was created.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "ConversationCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "conversationUpdatedAt", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "The last time the conversation was updated.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ConversationUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationWaitingSince", + "key": "waiting_since", + "schema": { + "generatedName": "conversationWaitingSince", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationWaitingSince", + "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", + "value": { + "description": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ConversationWaitingSince", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSnoozedUntil", + "key": "snoozed_until", + "schema": { + "generatedName": "conversationSnoozedUntil", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationSnoozedUntil", + "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", + "value": { + "description": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ConversationSnoozedUntil", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationOpen", + "key": "open", + "schema": { + "generatedName": "conversationOpen", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "Indicates whether a conversation is open (true) or closed (false).", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ConversationOpen", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationState", + "key": "state", + "schema": { + "generatedName": "conversationState", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "Can be set to \"open\", \"closed\" or \"snoozed\".", + "generatedName": "ConversationState", + "values": [ + { + "generatedName": "open", + "value": "open", + "casing": {} + }, + { + "generatedName": "closed", + "value": "closed", + "casing": {} + }, + { + "generatedName": "snoozed", + "value": "snoozed", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationRead", + "key": "read", + "schema": { + "generatedName": "conversationRead", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "Indicates whether a conversation has been read.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ConversationRead", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPriority", + "key": "priority", + "schema": { + "generatedName": "conversationPriority", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "If marked as priority, it will return priority or else not_priority.", + "generatedName": "ConversationPriority", + "values": [ + { + "generatedName": "priority", + "value": "priority", + "casing": {} + }, + { + "generatedName": "not_priority", + "value": "not_priority", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationAdminAssigneeId", + "key": "admin_assignee_id", + "schema": { + "generatedName": "conversationAdminAssigneeId", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationAdminAssigneeId", + "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", + "value": { + "description": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", + "schema": { + "example": 0, + "type": "int" + }, + "generatedName": "ConversationAdminAssigneeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationTeamAssigneeId", + "key": "team_assignee_id", + "schema": { + "generatedName": "conversationTeamAssigneeId", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationTeamAssigneeId", + "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", + "value": { + "description": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", + "schema": { + "example": "5017691", + "type": "string" + }, + "generatedName": "ConversationTeamAssigneeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationTags", + "key": "tags", + "schema": { + "generatedName": "conversationTags", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationTags", + "schema": "tags", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationConversationRating", + "key": "conversation_rating", + "schema": { + "generatedName": "conversationConversationRating", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationConversationRating", + "schema": "conversation_rating", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationSource", + "key": "source", + "schema": { + "generatedName": "conversationSource", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationSource", + "schema": "conversation_source", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationContacts", + "key": "contacts", + "schema": { + "generatedName": "conversationContacts", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationContacts", + "schema": "conversation_contacts", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationTeammates", + "key": "teammates", + "schema": { + "generatedName": "conversationTeammates", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationTeammates", + "schema": "conversation_teammates", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "conversationCustomAttributes", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationCustomAttributes", + "schema": "custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationFirstContactReply", + "key": "first_contact_reply", + "schema": { + "generatedName": "conversationFirstContactReply", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationFirstContactReply", + "schema": "conversation_first_contact_reply", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationSlaApplied", + "key": "sla_applied", + "schema": { + "generatedName": "conversationSlaApplied", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationSlaApplied", + "schema": "sla_applied", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationStatistics", + "key": "statistics", + "schema": { + "generatedName": "conversationStatistics", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationStatistics", + "schema": "conversation_statistics", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationConversationParts", + "key": "conversation_parts", + "schema": { + "generatedName": "conversationConversationParts", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationConversationParts", + "schema": "conversation_parts", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationLinkedObjects", + "key": "linked_objects", + "schema": { + "generatedName": "conversationLinkedObjects", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationLinkedObjects", + "schema": "linked_object_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationAiAgentParticipated", + "key": "ai_agent_participated", + "schema": { + "generatedName": "conversationAiAgentParticipated", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "description": "Indicates whether the AI Agent participated in the conversation.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "ConversationAiAgentParticipated", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationAiAgent", + "key": "ai_agent", + "schema": { + "generatedName": "conversationAiAgent", + "nameOverride": "Conversation", + "title": "Conversation", + "value": { + "generatedName": "ConversationAiAgent", + "schema": "ai_agent", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Conversations" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "generatedName": "Conversation", + "nameOverride": "Conversation", + "title": "Conversation", + "groupName": [ + "Conversations" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_attachment_files": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationAttachmentFilesContentType", + "key": "content_type", + "schema": { + "generatedName": "conversationAttachmentFilesContentType", + "title": "Conversation attachment files", + "value": { + "description": "The content type of the file", + "schema": { + "example": "application/json", + "type": "string" + }, + "generatedName": "ConversationAttachmentFilesContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationAttachmentFilesData", + "key": "data", + "schema": { + "generatedName": "conversationAttachmentFilesData", + "title": "Conversation attachment files", + "value": { + "description": "The base64 encoded file data.", + "schema": { + "example": "ewogICJ0ZXN0IjogMQp9", + "type": "string" + }, + "generatedName": "ConversationAttachmentFilesData", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationAttachmentFilesName", + "key": "name", + "schema": { + "generatedName": "conversationAttachmentFilesName", + "title": "Conversation attachment files", + "value": { + "description": "The name of the file.", + "schema": { + "example": "test.json", + "type": "string" + }, + "generatedName": "ConversationAttachmentFilesName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Properties of the attachment files in a conversation part", + "generatedName": "ConversationAttachmentFiles", + "title": "Conversation attachment files", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_contacts": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationContactsType", + "key": "type", + "schema": { + "generatedName": "conversationContactsType", + "nameOverride": "Contacts", + "title": "Contacts", + "value": { + "description": "", + "value": { + "value": "contact.list", + "type": "string" + }, + "generatedName": "ConversationContactsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationContactsContacts", + "key": "contacts", + "schema": { + "generatedName": "conversationContactsContacts", + "nameOverride": "Contacts", + "title": "Contacts", + "value": { + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "value": { + "generatedName": "ConversationContactsContactsItem", + "schema": "contact_reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationContactsContacts", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "generatedName": "ConversationContacts", + "nameOverride": "Contacts", + "title": "Contacts", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_first_contact_reply": { + "generatedName": "ConversationFirstContactReply", + "title": "First contact reply", + "description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationFirstContactReplyCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "conversationFirstContactReplyCreatedAt", + "title": "First contact reply", + "value": { + "description": "", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "ConversationFirstContactReplyCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationFirstContactReplyType", + "key": "type", + "schema": { + "generatedName": "conversationFirstContactReplyType", + "title": "First contact reply", + "value": { + "description": "", + "schema": { + "example": "conversation", + "type": "string" + }, + "generatedName": "ConversationFirstContactReplyType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationFirstContactReplyUrl", + "key": "url", + "schema": { + "generatedName": "conversationFirstContactReplyUrl", + "title": "First contact reply", + "value": { + "generatedName": "ConversationFirstContactReplyUrl", + "description": "", + "value": { + "description": "", + "schema": { + "example": "https://developers.intercom.com/", + "type": "string" + }, + "generatedName": "ConversationFirstContactReplyUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "generatedName": "ConversationFirstContactReply", + "title": "First contact reply", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "conversation_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationListType", + "key": "type", + "schema": { + "generatedName": "conversationListType", + "title": "Conversation List", + "value": { + "description": "Always conversation.list", + "value": { + "value": "conversation.list", + "type": "string" + }, + "generatedName": "ConversationListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationListConversations", + "key": "conversations", + "schema": { + "generatedName": "conversationListConversations", + "title": "Conversation List", + "value": { + "description": "The list of conversation objects", + "value": { + "generatedName": "ConversationListConversationsItem", + "schema": "conversation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationListConversations", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "conversationListTotalCount", + "title": "Conversation List", + "value": { + "description": "A count of the total number of objects.", + "schema": { + "example": 12345, + "type": "int" + }, + "generatedName": "ConversationListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationListPages", + "key": "pages", + "schema": { + "generatedName": "conversationListPages", + "title": "Conversation List", + "value": { + "generatedName": "ConversationListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "generatedName": "ConversationList", + "title": "Conversation List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_part": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationPartType", + "key": "type", + "schema": { + "generatedName": "conversationPartType", + "title": "Conversation Part", + "value": { + "description": "Always conversation_part", + "schema": { + "example": "conversation_part", + "type": "string" + }, + "generatedName": "ConversationPartType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartId", + "key": "id", + "schema": { + "generatedName": "conversationPartId", + "title": "Conversation Part", + "value": { + "description": "The id representing the conversation part.", + "schema": { + "example": "3", + "type": "string" + }, + "generatedName": "ConversationPartId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartPartType", + "key": "part_type", + "schema": { + "generatedName": "conversationPartPartType", + "title": "Conversation Part", + "value": { + "description": "The type of conversation part.", + "schema": { + "example": "comment", + "type": "string" + }, + "generatedName": "ConversationPartPartType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartBody", + "key": "body", + "schema": { + "generatedName": "conversationPartBody", + "title": "Conversation Part", + "value": { + "generatedName": "ConversationPartBody", + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "value": { + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "schema": { + "example": "

Okay!

", + "type": "string" + }, + "generatedName": "ConversationPartBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "conversationPartCreatedAt", + "title": "Conversation Part", + "value": { + "description": "The time the conversation part was created.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "ConversationPartCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "conversationPartUpdatedAt", + "title": "Conversation Part", + "value": { + "description": "The last time the conversation part was updated.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ConversationPartUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartNotifiedAt", + "key": "notified_at", + "schema": { + "generatedName": "conversationPartNotifiedAt", + "title": "Conversation Part", + "value": { + "description": "The time the user was notified with the conversation part.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "ConversationPartNotifiedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartAssignedTo", + "key": "assigned_to", + "schema": { + "generatedName": "conversationPartAssignedTo", + "title": "Conversation Part", + "value": { + "description": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", + "generatedName": "ConversationPartAssignedTo", + "schema": "reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationPartAuthor", + "key": "author", + "schema": { + "generatedName": "conversationPartAuthor", + "title": "Conversation Part", + "value": { + "generatedName": "ConversationPartAuthor", + "schema": "conversation_part_author", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationPartAttachments", + "key": "attachments", + "schema": { + "generatedName": "conversationPartAttachments", + "title": "Conversation Part", + "value": { + "description": "A list of attachments for the part.", + "value": { + "generatedName": "ConversationPartAttachmentsItem", + "schema": "part_attachment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationPartAttachments", + "title": "Conversation part attachments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartExternalId", + "key": "external_id", + "schema": { + "generatedName": "conversationPartExternalId", + "title": "Conversation Part", + "value": { + "generatedName": "ConversationPartExternalId", + "description": "The external id of the conversation part", + "value": { + "description": "The external id of the conversation part", + "schema": { + "example": "abcd1234", + "type": "string" + }, + "generatedName": "ConversationPartExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartRedacted", + "key": "redacted", + "schema": { + "generatedName": "conversationPartRedacted", + "title": "Conversation Part", + "value": { + "description": "Whether or not the conversation part has been redacted.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "ConversationPartRedacted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Conversation Part represents a message in the conversation.", + "generatedName": "ConversationPart", + "title": "Conversation Part", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_part_author": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationPartAuthorType", + "key": "type", + "schema": { + "generatedName": "conversationPartAuthorType", + "title": "Conversation part author", + "value": { + "description": "The type of the author", + "schema": { + "example": "admin", + "type": "string" + }, + "generatedName": "ConversationPartAuthorType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartAuthorId", + "key": "id", + "schema": { + "generatedName": "conversationPartAuthorId", + "title": "Conversation part author", + "value": { + "description": "The id of the author", + "schema": { + "example": "274", + "type": "string" + }, + "generatedName": "ConversationPartAuthorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartAuthorName", + "key": "name", + "schema": { + "generatedName": "conversationPartAuthorName", + "title": "Conversation part author", + "value": { + "description": "The name of the author", + "schema": { + "example": "Operator", + "type": "string" + }, + "generatedName": "ConversationPartAuthorName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartAuthorEmail", + "key": "email", + "schema": { + "generatedName": "conversationPartAuthorEmail", + "title": "Conversation part author", + "value": { + "description": "The email of the author", + "schema": { + "format": "email", + "example": "operator+abcd1234@intercom.io", + "type": "string" + }, + "generatedName": "ConversationPartAuthorEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "generatedName": "ConversationPartAuthor", + "title": "Conversation part author", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_parts": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationPartsType", + "key": "type", + "schema": { + "generatedName": "conversationPartsType", + "title": "Conversation Parts", + "value": { + "description": "", + "value": { + "value": "conversation_part.list", + "type": "string" + }, + "generatedName": "ConversationPartsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartsConversationParts", + "key": "conversation_parts", + "schema": { + "generatedName": "conversationPartsConversationParts", + "title": "Conversation Parts", + "value": { + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "value": { + "generatedName": "ConversationPartsConversationPartsItem", + "schema": "conversation_part", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationPartsConversationParts", + "title": "Conversation Parts", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationPartsTotalCount", + "key": "total_count", + "schema": { + "generatedName": "conversationPartsTotalCount", + "title": "Conversation Parts", + "value": { + "description": "", + "schema": { + "example": 2, + "type": "int" + }, + "generatedName": "ConversationPartsTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "generatedName": "ConversationParts", + "title": "Conversation Parts", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_rating": { + "generatedName": "ConversationRating", + "title": "Conversation Rating", + "description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationRatingRating", + "key": "rating", + "schema": { + "generatedName": "conversationRatingRating", + "title": "Conversation Rating", + "value": { + "description": "The rating, between 1 and 5, for the conversation.", + "schema": { + "example": 5, + "type": "int" + }, + "generatedName": "ConversationRatingRating", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationRatingRemark", + "key": "remark", + "schema": { + "generatedName": "conversationRatingRemark", + "title": "Conversation Rating", + "value": { + "description": "An optional field to add a remark to correspond to the number rating", + "schema": { + "example": "", + "type": "string" + }, + "generatedName": "ConversationRatingRemark", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationRatingCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "conversationRatingCreatedAt", + "title": "Conversation Rating", + "value": { + "description": "The time the rating was requested in the conversation being rated.", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "ConversationRatingCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationRatingContact", + "key": "contact", + "schema": { + "generatedName": "conversationRatingContact", + "title": "Conversation Rating", + "value": { + "generatedName": "ConversationRatingContact", + "schema": "contact_reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationRatingTeammate", + "key": "teammate", + "schema": { + "generatedName": "conversationRatingTeammate", + "title": "Conversation Rating", + "value": { + "generatedName": "ConversationRatingTeammate", + "schema": "reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "generatedName": "ConversationRating", + "title": "Conversation Rating", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "conversation_source": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationSourceType", + "key": "type", + "schema": { + "generatedName": "conversationSourceType", + "title": "Conversation source", + "value": { + "description": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.", + "schema": { + "example": "conversation", + "type": "string" + }, + "generatedName": "ConversationSourceType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceId", + "key": "id", + "schema": { + "generatedName": "conversationSourceId", + "title": "Conversation source", + "value": { + "description": "The id representing the message.", + "schema": { + "example": "3", + "type": "string" + }, + "generatedName": "ConversationSourceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceDeliveredAs", + "key": "delivered_as", + "schema": { + "generatedName": "conversationSourceDeliveredAs", + "title": "Conversation source", + "value": { + "description": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).", + "schema": { + "example": "operator_initiated", + "type": "string" + }, + "generatedName": "ConversationSourceDeliveredAs", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceSubject", + "key": "subject", + "schema": { + "generatedName": "conversationSourceSubject", + "title": "Conversation source", + "value": { + "description": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.", + "schema": { + "example": "", + "type": "string" + }, + "generatedName": "ConversationSourceSubject", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceBody", + "key": "body", + "schema": { + "generatedName": "conversationSourceBody", + "title": "Conversation source", + "value": { + "description": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "schema": { + "example": "

Hey there!

", + "type": "string" + }, + "generatedName": "ConversationSourceBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceAuthor", + "key": "author", + "schema": { + "generatedName": "conversationSourceAuthor", + "title": "Conversation source", + "value": { + "generatedName": "ConversationSourceAuthor", + "schema": "conversation_part_author", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "conversationSourceAttachments", + "key": "attachments", + "schema": { + "generatedName": "conversationSourceAttachments", + "title": "Conversation source", + "value": { + "description": "A list of attachments for the part.", + "value": { + "generatedName": "ConversationSourceAttachmentsItem", + "schema": "part_attachment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationSourceAttachments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceUrl", + "key": "url", + "schema": { + "generatedName": "conversationSourceUrl", + "title": "Conversation source", + "value": { + "generatedName": "ConversationSourceUrl", + "description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.", + "value": { + "description": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.", + "schema": { + "type": "string" + }, + "generatedName": "ConversationSourceUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationSourceRedacted", + "key": "redacted", + "schema": { + "generatedName": "conversationSourceRedacted", + "title": "Conversation source", + "value": { + "description": "Whether or not the source message has been redacted. Only applicable for contact initiated messages.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "ConversationSourceRedacted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "generatedName": "ConversationSource", + "title": "Conversation source", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "conversation_statistics": { + "generatedName": "ConversationStatistics", + "title": "Conversation statistics", + "description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationStatisticsType", + "key": "type", + "schema": { + "generatedName": "conversationStatisticsType", + "title": "Conversation statistics", + "value": { + "description": "", + "schema": { + "example": "conversation_statistics", + "type": "string" + }, + "generatedName": "ConversationStatisticsType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsTimeToAssignment", + "key": "time_to_assignment", + "schema": { + "generatedName": "conversationStatisticsTimeToAssignment", + "title": "Conversation statistics", + "value": { + "description": "Duration until last assignment before first admin reply. In seconds.", + "schema": { + "example": 2310, + "type": "int" + }, + "generatedName": "ConversationStatisticsTimeToAssignment", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsTimeToAdminReply", + "key": "time_to_admin_reply", + "schema": { + "generatedName": "conversationStatisticsTimeToAdminReply", + "title": "Conversation statistics", + "value": { + "description": "Duration until first admin reply. Subtracts out of business hours. In seconds.", + "schema": { + "example": 2310, + "type": "int" + }, + "generatedName": "ConversationStatisticsTimeToAdminReply", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsTimeToFirstClose", + "key": "time_to_first_close", + "schema": { + "generatedName": "conversationStatisticsTimeToFirstClose", + "title": "Conversation statistics", + "value": { + "description": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds.", + "schema": { + "example": 2310, + "type": "int" + }, + "generatedName": "ConversationStatisticsTimeToFirstClose", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsTimeToLastClose", + "key": "time_to_last_close", + "schema": { + "generatedName": "conversationStatisticsTimeToLastClose", + "title": "Conversation statistics", + "value": { + "description": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds.", + "schema": { + "example": 2310, + "type": "int" + }, + "generatedName": "ConversationStatisticsTimeToLastClose", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsMedianTimeToReply", + "key": "median_time_to_reply", + "schema": { + "generatedName": "conversationStatisticsMedianTimeToReply", + "title": "Conversation statistics", + "value": { + "description": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.", + "schema": { + "example": 2310, + "type": "int" + }, + "generatedName": "ConversationStatisticsMedianTimeToReply", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsFirstContactReplyAt", + "key": "first_contact_reply_at", + "schema": { + "generatedName": "conversationStatisticsFirstContactReplyAt", + "title": "Conversation statistics", + "value": { + "description": "Time of first text conversation part from a contact.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsFirstContactReplyAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsFirstAssignmentAt", + "key": "first_assignment_at", + "schema": { + "generatedName": "conversationStatisticsFirstAssignmentAt", + "title": "Conversation statistics", + "value": { + "description": "Time of first assignment after first_contact_reply_at.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsFirstAssignmentAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsFirstAdminReplyAt", + "key": "first_admin_reply_at", + "schema": { + "generatedName": "conversationStatisticsFirstAdminReplyAt", + "title": "Conversation statistics", + "value": { + "description": "Time of first admin reply after first_contact_reply_at.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsFirstAdminReplyAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsFirstCloseAt", + "key": "first_close_at", + "schema": { + "generatedName": "conversationStatisticsFirstCloseAt", + "title": "Conversation statistics", + "value": { + "description": "Time of first close after first_contact_reply_at.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsFirstCloseAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastAssignmentAt", + "key": "last_assignment_at", + "schema": { + "generatedName": "conversationStatisticsLastAssignmentAt", + "title": "Conversation statistics", + "value": { + "description": "Time of last assignment after first_contact_reply_at.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsLastAssignmentAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastAssignmentAdminReplyAt", + "key": "last_assignment_admin_reply_at", + "schema": { + "generatedName": "conversationStatisticsLastAssignmentAdminReplyAt", + "title": "Conversation statistics", + "value": { + "description": "Time of first admin reply since most recent assignment.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsLastAssignmentAdminReplyAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastContactReplyAt", + "key": "last_contact_reply_at", + "schema": { + "generatedName": "conversationStatisticsLastContactReplyAt", + "title": "Conversation statistics", + "value": { + "description": "Time of the last conversation part from a contact.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsLastContactReplyAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastAdminReplyAt", + "key": "last_admin_reply_at", + "schema": { + "generatedName": "conversationStatisticsLastAdminReplyAt", + "title": "Conversation statistics", + "value": { + "description": "Time of the last conversation part from an admin.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsLastAdminReplyAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastCloseAt", + "key": "last_close_at", + "schema": { + "generatedName": "conversationStatisticsLastCloseAt", + "title": "Conversation statistics", + "value": { + "description": "Time of the last conversation close.", + "schema": { + "example": 1663597233, + "type": "int" + }, + "generatedName": "ConversationStatisticsLastCloseAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsLastClosedById", + "key": "last_closed_by_id", + "schema": { + "generatedName": "conversationStatisticsLastClosedById", + "title": "Conversation statistics", + "value": { + "description": "The last admin who closed the conversation. Returns a reference to an Admin object.", + "schema": { + "example": "c3po", + "type": "string" + }, + "generatedName": "ConversationStatisticsLastClosedById", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsCountReopens", + "key": "count_reopens", + "schema": { + "generatedName": "conversationStatisticsCountReopens", + "title": "Conversation statistics", + "value": { + "description": "Number of reopens after first_contact_reply_at.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "ConversationStatisticsCountReopens", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsCountAssignments", + "key": "count_assignments", + "schema": { + "generatedName": "conversationStatisticsCountAssignments", + "title": "Conversation statistics", + "value": { + "description": "Number of assignments after first_contact_reply_at.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "ConversationStatisticsCountAssignments", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationStatisticsCountConversationParts", + "key": "count_conversation_parts", + "schema": { + "generatedName": "conversationStatisticsCountConversationParts", + "title": "Conversation statistics", + "value": { + "description": "Total number of conversation parts.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "ConversationStatisticsCountConversationParts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "generatedName": "ConversationStatistics", + "title": "Conversation statistics", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "conversation_teammates": { + "generatedName": "ConversationTeammates", + "title": "Conversation teammates", + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "conversationTeammatesType", + "key": "type", + "schema": { + "generatedName": "conversationTeammatesType", + "title": "Conversation teammates", + "value": { + "description": "The type of the object - `admin.list`.", + "schema": { + "example": "admin.list", + "type": "string" + }, + "generatedName": "ConversationTeammatesType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "conversationTeammatesTeammates", + "key": "teammates", + "schema": { + "generatedName": "conversationTeammatesTeammates", + "title": "Conversation teammates", + "value": { + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "value": { + "generatedName": "ConversationTeammatesTeammatesItem", + "schema": "reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "ConversationTeammatesTeammates", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "generatedName": "ConversationTeammates", + "title": "Conversation teammates", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "convert_conversation_to_ticket_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "convertConversationToTicketRequestTicketTypeId", + "key": "ticket_type_id", + "schema": { + "description": "The ID of the type of ticket you want to convert the conversation to", + "schema": { + "example": "1234", + "type": "string" + }, + "generatedName": "ConvertConversationToTicketRequestTicketTypeId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "convertConversationToTicketRequestAttributes", + "key": "attributes", + "schema": { + "generatedName": "convertConversationToTicketRequestAttributes", + "title": "Convert Ticket Request Payload", + "value": { + "generatedName": "ConvertConversationToTicketRequestAttributes", + "schema": "ticket_request_custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "You can convert a Conversation to a Ticket", + "generatedName": "ConvertConversationToTicketRequest", + "title": "Convert Ticket Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "convert_visitor_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "convertVisitorRequestType", + "key": "type", + "schema": { + "description": "Represents the role of the Contact model. Accepts `lead` or `user`.", + "schema": { + "example": "user", + "type": "string" + }, + "generatedName": "ConvertVisitorRequestType", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "convertVisitorRequestUser", + "key": "user", + "schema": { + "generatedName": "ConvertVisitorRequestUserOne", + "type": "unknown" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "convertVisitorRequestVisitor", + "key": "visitor", + "schema": { + "generatedName": "ConvertVisitorRequestVisitorTwo", + "type": "unknown" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can merge a Visitor to a Contact of role type lead or user.", + "generatedName": "ConvertVisitorRequest", + "title": "Convert Visitor Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_article_request": { + "generatedName": "CreateArticleRequest", + "title": "Create Article Request Payload", + "description": "You can create an Article", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createArticleRequestTitle", + "key": "title", + "schema": { + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "schema": { + "example": "Thanks for everything", + "type": "string" + }, + "generatedName": "CreateArticleRequestTitle", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestDescription", + "key": "description", + "schema": { + "generatedName": "createArticleRequestDescription", + "title": "Create Article Request Payload", + "value": { + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "schema": { + "example": "Description of the Article", + "type": "string" + }, + "generatedName": "CreateArticleRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestBody", + "key": "body", + "schema": { + "generatedName": "createArticleRequestBody", + "title": "Create Article Request Payload", + "value": { + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "schema": { + "example": "

This is the body in html

", + "type": "string" + }, + "generatedName": "CreateArticleRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestAuthorId", + "key": "author_id", + "schema": { + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "schema": { + "example": 1295, + "type": "int" + }, + "generatedName": "CreateArticleRequestAuthorId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestState", + "key": "state", + "schema": { + "generatedName": "createArticleRequestState", + "title": "Create Article Request Payload", + "value": { + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "generatedName": "CreateArticleRequestState", + "values": [ + { + "generatedName": "published", + "value": "published", + "casing": {} + }, + { + "generatedName": "draft", + "value": "draft", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestParentId", + "key": "parent_id", + "schema": { + "generatedName": "createArticleRequestParentId", + "title": "Create Article Request Payload", + "value": { + "description": "The id of the article's parent collection or section. An article without this field stands alone.", + "schema": { + "example": 18, + "type": "int" + }, + "generatedName": "CreateArticleRequestParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestParentType", + "key": "parent_type", + "schema": { + "generatedName": "createArticleRequestParentType", + "title": "Create Article Request Payload", + "value": { + "description": "The type of parent, which can either be a `collection` or `section`.", + "schema": { + "example": "collection", + "type": "string" + }, + "generatedName": "CreateArticleRequestParentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createArticleRequestTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "createArticleRequestTranslatedContent", + "title": "Create Article Request Payload", + "value": { + "generatedName": "CreateArticleRequestTranslatedContent", + "schema": "article_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "You can create an Article", + "generatedName": "CreateArticleRequest", + "title": "Create Article Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "create_collection_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createCollectionRequestName", + "key": "name", + "schema": { + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "schema": { + "example": "collection 51", + "type": "string" + }, + "generatedName": "CreateCollectionRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createCollectionRequestDescription", + "key": "description", + "schema": { + "generatedName": "createCollectionRequestDescription", + "title": "Create Collection Request Payload", + "value": { + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "schema": { + "example": "English description", + "type": "string" + }, + "generatedName": "CreateCollectionRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createCollectionRequestTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "createCollectionRequestTranslatedContent", + "title": "Create Collection Request Payload", + "value": { + "generatedName": "CreateCollectionRequestTranslatedContent", + "schema": "group_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "createCollectionRequestParentId", + "key": "parent_id", + "schema": { + "generatedName": "createCollectionRequestParentId", + "title": "Create Collection Request Payload", + "value": { + "generatedName": "CreateCollectionRequestParentId", + "description": "The id of the parent collection. If `null` then it will be created as the first level collection.", + "value": { + "description": "The id of the parent collection. If `null` then it will be created as the first level collection.", + "schema": { + "example": "6871118", + "type": "string" + }, + "generatedName": "CreateCollectionRequestParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createCollectionRequestHelpCenterId", + "key": "help_center_id", + "schema": { + "generatedName": "createCollectionRequestHelpCenterId", + "title": "Create Collection Request Payload", + "value": { + "generatedName": "CreateCollectionRequestHelpCenterId", + "description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center.", + "value": { + "description": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center.", + "schema": { + "type": "int" + }, + "generatedName": "CreateCollectionRequestHelpCenterId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can create a collection", + "generatedName": "CreateCollectionRequest", + "title": "Create Collection Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_contact_request": { + "generatedName": "CreateContactRequestTwo", + "type": "unknown" + }, + "create_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createConversationRequestFrom", + "key": "from", + "schema": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createConversationRequestFromType", + "key": "type", + "schema": { + "description": "The role associated to the contact - user or lead.", + "generatedName": "CreateConversationRequestFromType", + "values": [ + { + "generatedName": "lead", + "value": "lead", + "casing": {} + }, + { + "generatedName": "user", + "value": "user", + "casing": {} + }, + { + "generatedName": "contact", + "value": "contact", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createConversationRequestFromId", + "key": "id", + "schema": { + "description": "The identifier for the contact which is given by Intercom.", + "schema": { + "format": "uuid", + "minLength": 24, + "maxLength": 24, + "example": "536e564f316c83104c000020", + "type": "string" + }, + "generatedName": "CreateConversationRequestFromId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CreateConversationRequestFrom", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createConversationRequestBody", + "key": "body", + "schema": { + "description": "The content of the message. HTML is not supported.", + "schema": { + "example": "Hello", + "type": "string" + }, + "generatedName": "CreateConversationRequestBody", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "generatedName": "CreateConversationRequest", + "title": "Create Conversation Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_data_attribute_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createDataAttributeRequestName", + "key": "name", + "schema": { + "description": "The name of the data attribute.", + "schema": { + "example": "My Data Attribute", + "type": "string" + }, + "generatedName": "CreateDataAttributeRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataAttributeRequestModel", + "key": "model", + "schema": { + "description": "The model that the data attribute belongs to.", + "generatedName": "CreateDataAttributeRequestModel", + "values": [ + { + "generatedName": "contact", + "value": "contact", + "casing": {} + }, + { + "generatedName": "company", + "value": "company", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataAttributeRequestDataType", + "key": "data_type", + "schema": { + "description": "The type of data stored for this attribute.", + "generatedName": "CreateDataAttributeRequestDataType", + "values": [ + { + "generatedName": "string", + "value": "string", + "casing": {} + }, + { + "generatedName": "integer", + "value": "integer", + "casing": {} + }, + { + "generatedName": "float", + "value": "float", + "casing": {} + }, + { + "generatedName": "boolean", + "value": "boolean", + "casing": {} + }, + { + "generatedName": "datetime", + "value": "datetime", + "casing": {} + }, + { + "generatedName": "date", + "value": "date", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataAttributeRequestDescription", + "key": "description", + "schema": { + "generatedName": "createDataAttributeRequestDescription", + "title": "Create Data Attribute Request", + "value": { + "description": "The readable description you see in the UI for the attribute.", + "schema": { + "example": "My Data Attribute Description", + "type": "string" + }, + "generatedName": "CreateDataAttributeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataAttributeRequestOptions", + "key": "options", + "schema": { + "generatedName": "createDataAttributeRequestOptions", + "title": "Create Data Attribute Request", + "value": { + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "CreateDataAttributeRequestOptionsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "CreateDataAttributeRequestOptions", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataAttributeRequestMessengerWritable", + "key": "messenger_writable", + "schema": { + "generatedName": "createDataAttributeRequestMessengerWritable", + "title": "Create Data Attribute Request", + "value": { + "description": "Can this attribute be updated by the Messenger", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "CreateDataAttributeRequestMessengerWritable", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "", + "generatedName": "CreateDataAttributeRequest", + "title": "Create Data Attribute Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_data_event_request": { + "generatedName": "CreateDataEventRequestTwo", + "type": "unknown" + }, + "create_data_event_summaries_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestUserId", + "key": "user_id", + "schema": { + "generatedName": "createDataEventSummariesRequestUserId", + "title": "Create Data Event Summaries Request", + "value": { + "description": "Your identifier for the user.", + "schema": { + "example": "314159", + "type": "string" + }, + "generatedName": "CreateDataEventSummariesRequestUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestEventSummaries", + "key": "event_summaries", + "schema": { + "generatedName": "createDataEventSummariesRequestEventSummaries", + "title": "Create Data Event Summaries Request", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestEventSummariesEventName", + "key": "event_name", + "schema": { + "generatedName": "createDataEventSummariesRequestEventSummariesEventName", + "value": { + "description": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "schema": { + "example": "invited-friend", + "type": "string" + }, + "generatedName": "CreateDataEventSummariesRequestEventSummariesEventName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestEventSummariesCount", + "key": "count", + "schema": { + "generatedName": "createDataEventSummariesRequestEventSummariesCount", + "value": { + "description": "The number of times the event occurred.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "CreateDataEventSummariesRequestEventSummariesCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestEventSummariesFirst", + "key": "first", + "schema": { + "generatedName": "createDataEventSummariesRequestEventSummariesFirst", + "value": { + "description": "The first time the event was sent", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "CreateDataEventSummariesRequestEventSummariesFirst", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataEventSummariesRequestEventSummariesLast", + "key": "last", + "schema": { + "generatedName": "createDataEventSummariesRequestEventSummariesLast", + "value": { + "description": "The last time the event was sent", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "CreateDataEventSummariesRequestEventSummariesLast", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "generatedName": "CreateDataEventSummariesRequestEventSummaries", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can send a list of event summaries for a user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense \"verb-noun\" combination, to improve readability, for example `updated-plan`.", + "generatedName": "CreateDataEventSummariesRequest", + "title": "Create Data Event Summaries Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_data_exports_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createDataExportsRequestCreatedAtAfter", + "key": "created_at_after", + "schema": { + "description": "The start date that you request data for. It must be formatted as a unix timestamp.", + "schema": { + "example": 1527811200, + "type": "int" + }, + "generatedName": "CreateDataExportsRequestCreatedAtAfter", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createDataExportsRequestCreatedAtBefore", + "key": "created_at_before", + "schema": { + "description": "The end date that you request data for. It must be formatted as a unix timestamp.", + "schema": { + "example": 1527811200, + "type": "int" + }, + "generatedName": "CreateDataExportsRequestCreatedAtBefore", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Request for creating a data export", + "generatedName": "CreateDataExportsRequest", + "title": "Create Data Export Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_message_request": { + "generatedName": "CreateMessageRequestOne", + "type": "unknown" + }, + "create_or_update_company_request": { + "generatedName": "CreateOrUpdateCompanyRequest", + "title": "Create Or Update Company Request Payload", + "description": "You can create or update a Company", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestName", + "key": "name", + "schema": { + "generatedName": "createOrUpdateCompanyRequestName", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The name of the Company", + "schema": { + "example": "Intercom", + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestCompanyId", + "key": "company_id", + "schema": { + "generatedName": "createOrUpdateCompanyRequestCompanyId", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The company id you have defined for the company. Can't be updated", + "schema": { + "example": "625e90fc55ab113b6d92175f", + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestPlan", + "key": "plan", + "schema": { + "generatedName": "createOrUpdateCompanyRequestPlan", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The name of the plan you have associated with the company.", + "schema": { + "example": "Enterprise", + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestPlan", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestSize", + "key": "size", + "schema": { + "generatedName": "createOrUpdateCompanyRequestSize", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The number of employees in this company.", + "schema": { + "type": "int" + }, + "generatedName": "CreateOrUpdateCompanyRequestSize", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestWebsite", + "key": "website", + "schema": { + "generatedName": "createOrUpdateCompanyRequestWebsite", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.", + "schema": { + "example": "https://www.example.com", + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestWebsite", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestIndustry", + "key": "industry", + "schema": { + "generatedName": "createOrUpdateCompanyRequestIndustry", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The industry that this company operates in.", + "schema": { + "example": "Manufacturing", + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestIndustry", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "createOrUpdateCompanyRequestCustomAttributes", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "A hash of key/value pairs containing any other data about the company you want Intercom to store.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "schema": { + "type": "string" + }, + "generatedName": "CreateOrUpdateCompanyRequestCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "generatedName": "CreateOrUpdateCompanyRequestCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestRemoteCreatedAt", + "key": "remote_created_at", + "schema": { + "generatedName": "createOrUpdateCompanyRequestRemoteCreatedAt", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "The time the company was created by you.", + "schema": { + "example": 1394531169, + "type": "int" + }, + "generatedName": "CreateOrUpdateCompanyRequestRemoteCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateCompanyRequestMonthlySpend", + "key": "monthly_spend", + "schema": { + "generatedName": "createOrUpdateCompanyRequestMonthlySpend", + "title": "Create Or Update Company Request Payload", + "value": { + "description": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..", + "schema": { + "example": 1000, + "type": "int" + }, + "generatedName": "CreateOrUpdateCompanyRequestMonthlySpend", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can create or update a Company", + "generatedName": "CreateOrUpdateCompanyRequest", + "title": "Create Or Update Company Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "create_or_update_tag_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createOrUpdateTagRequestName", + "key": "name", + "schema": { + "description": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.", + "schema": { + "example": "Independent", + "type": "string" + }, + "generatedName": "CreateOrUpdateTagRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createOrUpdateTagRequestId", + "key": "id", + "schema": { + "generatedName": "createOrUpdateTagRequestId", + "title": "Create or Update Tag Request Payload", + "value": { + "description": "The id of tag to updates.", + "schema": { + "example": "656452352", + "type": "string" + }, + "generatedName": "CreateOrUpdateTagRequestId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can create or update an existing tag.", + "generatedName": "CreateOrUpdateTagRequest", + "title": "Create or Update Tag Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_phone_switch_request": { + "generatedName": "CreatePhoneSwitchRequest", + "title": "Create Phone Switch Request Payload", + "description": "You can create an phone switch", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createPhoneSwitchRequestPhone", + "key": "phone", + "schema": { + "description": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.", + "schema": { + "example": "+1 1234567890", + "type": "string" + }, + "generatedName": "CreatePhoneSwitchRequestPhone", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createPhoneSwitchRequestCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "createPhoneSwitchRequestCustomAttributes", + "title": "Create Phone Switch Request Payload", + "value": { + "generatedName": "CreatePhoneSwitchRequestCustomAttributes", + "schema": "custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "You can create an phone switch", + "generatedName": "CreatePhoneSwitchRequest", + "title": "Create Phone Switch Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "create_ticket_reply_with_comment_request": { + "value": { + "generatedName": "CreateTicketReplyWithCommentRequest", + "title": "Create Ticket Reply Request Payload", + "schemas": [ + { + "generatedName": "CreateTicketReplyWithCommentRequestZero", + "schema": "contact_reply_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "CreateTicketReplyWithCommentRequestOne", + "schema": "admin_reply_ticket_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "create_ticket_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketRequestTicketTypeId", + "key": "ticket_type_id", + "schema": { + "description": "The ID of the type of ticket you want to create", + "schema": { + "example": "1234", + "type": "string" + }, + "generatedName": "CreateTicketRequestTicketTypeId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketRequestContacts", + "key": "contacts", + "schema": { + "description": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed", + "value": { + "value": { + "generatedName": "CreateTicketRequestContactsItem", + "schemas": [ + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketRequestContactsItemIdId", + "key": "id", + "schema": { + "description": "The identifier for the contact as given by Intercom.", + "schema": { + "type": "string" + }, + "generatedName": "CreateTicketRequestContactsItemIdId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CreateTicketRequestContactsItemId", + "nameOverride": "ID", + "title": "ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketRequestContactsItemExternalIdExternalId", + "key": "external_id", + "schema": { + "description": "The external_id you have defined for the contact who is being added as a participant.", + "schema": { + "type": "string" + }, + "generatedName": "CreateTicketRequestContactsItemExternalIdExternalId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CreateTicketRequestContactsItemExternalId", + "title": "External ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketRequestContactsItemEmailEmail", + "key": "email", + "schema": { + "description": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", + "schema": { + "type": "string" + }, + "generatedName": "CreateTicketRequestContactsItemEmailEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CreateTicketRequestContactsItemEmail", + "nameOverride": "Email", + "title": "Email", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "generatedName": "CreateTicketRequestContacts", + "groupName": [], + "type": "array" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketRequestCompanyId", + "key": "company_id", + "schema": { + "generatedName": "createTicketRequestCompanyId", + "title": "Create Ticket Request Payload", + "value": { + "description": "The ID of the company that the ticket is associated with. The ID that you set upon company creation.", + "schema": { + "example": "1234", + "type": "string" + }, + "generatedName": "CreateTicketRequestCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketRequestCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "createTicketRequestCreatedAt", + "title": "Create Ticket Request Payload", + "value": { + "description": "The time the ticket was created. If not provided, the current time will be used.", + "schema": { + "example": 1590000000, + "type": "int" + }, + "generatedName": "CreateTicketRequestCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketRequestTicketAttributes", + "key": "ticket_attributes", + "schema": { + "generatedName": "createTicketRequestTicketAttributes", + "title": "Create Ticket Request Payload", + "value": { + "generatedName": "CreateTicketRequestTicketAttributes", + "schema": "ticket_request_custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "You can create a Ticket", + "generatedName": "CreateTicketRequest", + "title": "Create Ticket Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_ticket_type_attribute_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestName", + "key": "name", + "schema": { + "description": "The name of the ticket type attribute", + "schema": { + "example": "Bug Priority", + "type": "string" + }, + "generatedName": "CreateTicketTypeAttributeRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestDescription", + "key": "description", + "schema": { + "description": "The description of the attribute presented to the teammate or contact", + "schema": { + "example": "Priority level of the bug", + "type": "string" + }, + "generatedName": "CreateTicketTypeAttributeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestDataType", + "key": "data_type", + "schema": { + "description": "The data type of the attribute", + "generatedName": "CreateTicketTypeAttributeRequestDataType", + "values": [ + { + "generatedName": "string", + "value": "string", + "casing": {} + }, + { + "generatedName": "list", + "value": "list", + "casing": {} + }, + { + "generatedName": "integer", + "value": "integer", + "casing": {} + }, + { + "generatedName": "decimal", + "value": "decimal", + "casing": {} + }, + { + "generatedName": "boolean", + "value": "boolean", + "casing": {} + }, + { + "generatedName": "datetime", + "value": "datetime", + "casing": {} + }, + { + "generatedName": "files", + "value": "files", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestRequiredToCreate", + "key": "required_to_create", + "schema": { + "generatedName": "createTicketTypeAttributeRequestRequiredToCreate", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestRequiredToCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestRequiredToCreateForContacts", + "key": "required_to_create_for_contacts", + "schema": { + "generatedName": "createTicketTypeAttributeRequestRequiredToCreateForContacts", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestRequiredToCreateForContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestVisibleOnCreate", + "key": "visible_on_create", + "schema": { + "generatedName": "createTicketTypeAttributeRequestVisibleOnCreate", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "schema": { + "default": true, + "example": true, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestVisibleOnCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestVisibleToContacts", + "key": "visible_to_contacts", + "schema": { + "generatedName": "createTicketTypeAttributeRequestVisibleToContacts", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "schema": { + "default": true, + "example": true, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestVisibleToContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestMultiline", + "key": "multiline", + "schema": { + "generatedName": "createTicketTypeAttributeRequestMultiline", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestMultiline", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestListItems", + "key": "list_items", + "schema": { + "generatedName": "createTicketTypeAttributeRequestListItems", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "schema": { + "example": "Low Priority,Medium Priority,High Priority", + "type": "string" + }, + "generatedName": "CreateTicketTypeAttributeRequestListItems", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeAttributeRequestAllowMultipleValues", + "key": "allow_multiple_values", + "schema": { + "generatedName": "createTicketTypeAttributeRequestAllowMultipleValues", + "title": "Create Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeAttributeRequestAllowMultipleValues", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can create a Ticket Type Attribute", + "generatedName": "CreateTicketTypeAttributeRequest", + "title": "Create Ticket Type Attribute Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "create_ticket_type_request": { + "generatedName": "CreateTicketTypeRequest", + "title": "Create Ticket Type Request Payload", + "description": "The request payload for creating a ticket type.\n You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "createTicketTypeRequestName", + "key": "name", + "schema": { + "description": "The name of the ticket type.", + "schema": { + "example": "Bug", + "type": "string" + }, + "generatedName": "CreateTicketTypeRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeRequestDescription", + "key": "description", + "schema": { + "generatedName": "createTicketTypeRequestDescription", + "title": "Create Ticket Type Request Payload", + "value": { + "description": "The description of the ticket type.", + "schema": { + "example": "Used for tracking bugs", + "type": "string" + }, + "generatedName": "CreateTicketTypeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeRequestCategory", + "key": "category", + "schema": { + "generatedName": "createTicketTypeRequestCategory", + "title": "Create Ticket Type Request Payload", + "value": { + "description": "Category of the Ticket Type.", + "generatedName": "CreateTicketTypeRequestCategory", + "values": [ + { + "generatedName": "Customer", + "value": "Customer", + "casing": {} + }, + { + "generatedName": "BackOffice", + "value": "Back-office", + "casing": {} + }, + { + "generatedName": "Tracker", + "value": "Tracker", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeRequestIcon", + "key": "icon", + "schema": { + "generatedName": "createTicketTypeRequestIcon", + "title": "Create Ticket Type Request Payload", + "value": { + "description": "The icon of the ticket type.", + "schema": { + "default": "🎟️", + "example": "🐞", + "type": "string" + }, + "generatedName": "CreateTicketTypeRequestIcon", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "createTicketTypeRequestIsInternal", + "key": "is_internal", + "schema": { + "generatedName": "createTicketTypeRequestIsInternal", + "title": "Create Ticket Type Request Payload", + "value": { + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "CreateTicketTypeRequestIsInternal", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The request payload for creating a ticket type.\n You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "generatedName": "CreateTicketTypeRequest", + "title": "Create Ticket Type Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "cursor_pages": { + "generatedName": "CursorPages", + "title": "Cursor based pages", + "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "cursorPagesType", + "key": "type", + "schema": { + "generatedName": "cursorPagesType", + "title": "Cursor based pages", + "value": { + "description": "the type of object `pages`.", + "value": { + "value": "pages", + "type": "string" + }, + "generatedName": "CursorPagesType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "cursorPagesPage", + "key": "page", + "schema": { + "generatedName": "cursorPagesPage", + "title": "Cursor based pages", + "value": { + "description": "The current page", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "CursorPagesPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "cursorPagesNext", + "key": "next", + "schema": { + "generatedName": "cursorPagesNext", + "title": "Cursor based pages", + "value": { + "generatedName": "CursorPagesNext", + "schema": "starting_after_paging", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "cursorPagesPerPage", + "key": "per_page", + "schema": { + "generatedName": "cursorPagesPerPage", + "title": "Cursor based pages", + "value": { + "description": "Number of results per page", + "schema": { + "example": 2, + "type": "int" + }, + "generatedName": "CursorPagesPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "cursorPagesTotalPages", + "key": "total_pages", + "schema": { + "generatedName": "cursorPagesTotalPages", + "title": "Cursor based pages", + "value": { + "description": "Total number of pages", + "schema": { + "example": 13, + "type": "int" + }, + "generatedName": "CursorPagesTotalPages", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data.\nA \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.\n", + "generatedName": "CursorPages", + "title": "Cursor based pages", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "custom_attributes": { + "description": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "CustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "value": { + "generatedName": "CustomAttributesValue", + "schemas": [ + { + "schema": { + "type": "string" + }, + "generatedName": "CustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + { + "generatedName": "CustomAttributesValueOne", + "schema": "custom_object_instance", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "generatedName": "CustomAttributes", + "title": "Custom Attributes", + "groupName": [], + "type": "map" + }, + "custom_object_instance": { + "generatedName": "CustomObjectInstance", + "title": "Custom Object Instance", + "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "customObjectInstanceId", + "key": "id", + "schema": { + "generatedName": "customObjectInstanceId", + "title": "Custom Object Instance", + "value": { + "description": "The Intercom defined id representing the custom object instance.", + "schema": { + "example": "5a7a19e9f59ae20001d1c1e6", + "type": "string" + }, + "generatedName": "CustomObjectInstanceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Custom Object Instances" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "customObjectInstanceExternalId", + "key": "external_id", + "schema": { + "generatedName": "customObjectInstanceExternalId", + "title": "Custom Object Instance", + "value": { + "description": "The id you have defined for the custom object instance.", + "schema": { + "example": "0001d1c1e65a7a19e9f59ae2", + "type": "string" + }, + "generatedName": "CustomObjectInstanceExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Custom Object Instances" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "customObjectInstanceType", + "key": "type", + "schema": { + "generatedName": "customObjectInstanceType", + "title": "Custom Object Instance", + "value": { + "description": "The identifier of the custom object type that defines the structure of the custom object instance.", + "schema": { + "example": "Order", + "type": "string" + }, + "generatedName": "CustomObjectInstanceType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Custom Object Instances" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "customObjectInstanceCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "customObjectInstanceCustomAttributes", + "title": "Custom Object Instance", + "value": { + "description": "The custom attributes you have set on the custom object instance.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "CustomObjectInstanceCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "schema": { + "type": "string" + }, + "generatedName": "CustomObjectInstanceCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "generatedName": "CustomObjectInstanceCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [ + "Custom Object Instances" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "generatedName": "CustomObjectInstance", + "title": "Custom Object Instance", + "groupName": [ + "Custom Object Instances" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Custom Object Instances" + ], + "type": "nullable" + }, + "customer_request": { + "generatedName": "CustomerRequest", + "value": { + "value": { + "generatedName": "CustomerRequest", + "schemas": [ + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "customerRequestIntercomUserIdIntercomUserId", + "key": "intercom_user_id", + "schema": { + "description": "The identifier for the contact as given by Intercom.", + "schema": { + "example": "6329bd9ffe4e2e91dac76188", + "type": "string" + }, + "generatedName": "CustomerRequestIntercomUserIdIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CustomerRequestIntercomUserId", + "title": "Intercom User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "customerRequestUserIdUserId", + "key": "user_id", + "schema": { + "description": "The external_id you have defined for the contact who is being added as a participant.", + "schema": { + "example": "2e91dac761886329bd9ffe4e", + "type": "string" + }, + "generatedName": "CustomerRequestUserIdUserId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CustomerRequestUserId", + "title": "User ID", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "customerRequestEmailEmail", + "key": "email", + "schema": { + "description": "The email you have defined for the contact who is being added as a participant.", + "schema": { + "example": "sam.sung@example.com", + "type": "string" + }, + "generatedName": "CustomerRequestEmailEmail", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "CustomerRequestEmail", + "nameOverride": "Email", + "title": "Email", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "groupName": [], + "type": "nullable" + }, + "data_attribute": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataAttributeType", + "key": "type", + "schema": { + "generatedName": "dataAttributeType", + "title": "Data Attribute", + "value": { + "description": "Value is `data_attribute`.", + "value": { + "value": "data_attribute", + "type": "string" + }, + "generatedName": "DataAttributeType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeId", + "key": "id", + "schema": { + "generatedName": "dataAttributeId", + "title": "Data Attribute", + "value": { + "description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.", + "schema": { + "example": 12878, + "type": "int" + }, + "generatedName": "DataAttributeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeModel", + "key": "model", + "schema": { + "generatedName": "dataAttributeModel", + "title": "Data Attribute", + "value": { + "description": "Value is `contact` for user/lead attributes and `company` for company attributes.", + "generatedName": "DataAttributeModel", + "values": [ + { + "generatedName": "contact", + "value": "contact", + "casing": {} + }, + { + "generatedName": "company", + "value": "company", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeName", + "key": "name", + "schema": { + "generatedName": "dataAttributeName", + "title": "Data Attribute", + "value": { + "description": "Name of the attribute.", + "schema": { + "example": "paid_subscriber", + "type": "string" + }, + "generatedName": "DataAttributeName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeFullName", + "key": "full_name", + "schema": { + "generatedName": "dataAttributeFullName", + "title": "Data Attribute", + "value": { + "description": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values.", + "schema": { + "example": "custom_attributes.paid_subscriber", + "type": "string" + }, + "generatedName": "DataAttributeFullName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeLabel", + "key": "label", + "schema": { + "generatedName": "dataAttributeLabel", + "title": "Data Attribute", + "value": { + "description": "Readable name of the attribute (i.e. name you see in the UI)", + "schema": { + "example": "Paid Subscriber", + "type": "string" + }, + "generatedName": "DataAttributeLabel", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeDescription", + "key": "description", + "schema": { + "generatedName": "dataAttributeDescription", + "title": "Data Attribute", + "value": { + "description": "Readable description of the attribute.", + "schema": { + "example": "Whether the user is a paid subscriber.", + "type": "string" + }, + "generatedName": "DataAttributeDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeDataType", + "key": "data_type", + "schema": { + "generatedName": "dataAttributeDataType", + "title": "Data Attribute", + "value": { + "description": "The data type of the attribute.", + "generatedName": "DataAttributeDataType", + "values": [ + { + "generatedName": "string", + "value": "string", + "casing": {} + }, + { + "generatedName": "integer", + "value": "integer", + "casing": {} + }, + { + "generatedName": "float", + "value": "float", + "casing": {} + }, + { + "generatedName": "boolean", + "value": "boolean", + "casing": {} + }, + { + "generatedName": "date", + "value": "date", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeOptions", + "key": "options", + "schema": { + "generatedName": "dataAttributeOptions", + "title": "Data Attribute", + "value": { + "description": "List of predefined options for attribute value.", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "DataAttributeOptionsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "DataAttributeOptions", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeApiWritable", + "key": "api_writable", + "schema": { + "generatedName": "dataAttributeApiWritable", + "title": "Data Attribute", + "value": { + "description": "Can this attribute be updated through API", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DataAttributeApiWritable", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeMessengerWritable", + "key": "messenger_writable", + "schema": { + "generatedName": "dataAttributeMessengerWritable", + "title": "Data Attribute", + "value": { + "description": "Can this attribute be updated by the Messenger", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "DataAttributeMessengerWritable", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeUiWritable", + "key": "ui_writable", + "schema": { + "generatedName": "dataAttributeUiWritable", + "title": "Data Attribute", + "value": { + "description": "Can this attribute be updated in the UI", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DataAttributeUiWritable", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeCustom", + "key": "custom", + "schema": { + "generatedName": "dataAttributeCustom", + "title": "Data Attribute", + "value": { + "description": "Set to true if this is a CDA", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DataAttributeCustom", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeArchived", + "key": "archived", + "schema": { + "generatedName": "dataAttributeArchived", + "title": "Data Attribute", + "value": { + "description": "Is this attribute archived. (Only applicable to CDAs)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "DataAttributeArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "dataAttributeCreatedAt", + "title": "Data Attribute", + "value": { + "description": "The time the attribute was created as a UTC Unix timestamp", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "DataAttributeCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "dataAttributeUpdatedAt", + "title": "Data Attribute", + "value": { + "description": "The time the attribute was last updated as a UTC Unix timestamp", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "DataAttributeUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeAdminId", + "key": "admin_id", + "schema": { + "generatedName": "dataAttributeAdminId", + "title": "Data Attribute", + "value": { + "description": "Teammate who created the attribute. Only applicable to CDAs", + "schema": { + "example": "5712945", + "type": "string" + }, + "generatedName": "DataAttributeAdminId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Attributes" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "generatedName": "DataAttribute", + "title": "Data Attribute", + "groupName": [ + "Data Attributes" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_attribute_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataAttributeListType", + "key": "type", + "schema": { + "generatedName": "dataAttributeListType", + "title": "Data Attribute List", + "value": { + "description": "The type of the object", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "DataAttributeListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataAttributeListData", + "key": "data", + "schema": { + "generatedName": "dataAttributeListData", + "title": "Data Attribute List", + "value": { + "description": "A list of data attributes", + "value": { + "generatedName": "DataAttributeListDataItem", + "schema": "data_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "DataAttributeListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "generatedName": "DataAttributeList", + "title": "Data Attribute List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_event": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataEventType", + "key": "type", + "schema": { + "generatedName": "dataEventType", + "title": "Data Event", + "value": { + "description": "The type of the object", + "value": { + "value": "event", + "type": "string" + }, + "generatedName": "DataEventType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventEventName", + "key": "event_name", + "schema": { + "description": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "schema": { + "example": "invited-friend", + "type": "string" + }, + "generatedName": "DataEventEventName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventCreatedAt", + "key": "created_at", + "schema": { + "description": "The time the event occurred as a UTC Unix timestamp", + "schema": { + "example": 1671028894, + "type": "int" + }, + "generatedName": "DataEventCreatedAt", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventUserId", + "key": "user_id", + "schema": { + "generatedName": "dataEventUserId", + "title": "Data Event", + "value": { + "description": "Your identifier for the user.", + "schema": { + "example": "314159", + "type": "string" + }, + "generatedName": "DataEventUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventId", + "key": "id", + "schema": { + "generatedName": "dataEventId", + "title": "Data Event", + "value": { + "description": "Your identifier for a lead or a user.", + "schema": { + "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c", + "type": "string" + }, + "generatedName": "DataEventId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventIntercomUserId", + "key": "intercom_user_id", + "schema": { + "generatedName": "dataEventIntercomUserId", + "title": "Data Event", + "value": { + "description": "The Intercom identifier for the user.", + "schema": { + "example": "63a0979a5eeebeaf28dd56ba", + "type": "string" + }, + "generatedName": "DataEventIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventEmail", + "key": "email", + "schema": { + "generatedName": "dataEventEmail", + "title": "Data Event", + "value": { + "description": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", + "schema": { + "example": "frodo.baggins@example.com", + "type": "string" + }, + "generatedName": "DataEventEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventMetadata", + "key": "metadata", + "schema": { + "generatedName": "dataEventMetadata", + "title": "Data Event", + "value": { + "description": "Optional metadata about the event.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "DataEventMetadataKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "schema": { + "type": "string" + }, + "generatedName": "DataEventMetadataValue", + "groupName": [], + "type": "primitive" + }, + "generatedName": "DataEventMetadata", + "groupName": [], + "type": "map" + }, + "groupName": [ + "Data Events" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Data events are used to notify Intercom of changes to your data.", + "generatedName": "DataEvent", + "title": "Data Event", + "groupName": [ + "Data Events" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_event_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataEventListType", + "key": "type", + "schema": { + "generatedName": "dataEventListType", + "title": "Data Event List", + "value": { + "description": "The type of the object", + "value": { + "value": "event.list", + "type": "string" + }, + "generatedName": "DataEventListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventListEvents", + "key": "events", + "schema": { + "generatedName": "dataEventListEvents", + "title": "Data Event List", + "value": { + "description": "A list of data events", + "value": { + "generatedName": "DataEventListEventsItem", + "schema": "data_event", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "DataEventListEvents", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventListPages", + "key": "pages", + "schema": { + "generatedName": "dataEventListPages", + "title": "Data Event List", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataEventListPagesNext", + "key": "next", + "schema": { + "generatedName": "dataEventListPagesNext", + "value": { + "schema": { + "example": "https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user\"", + "type": "string" + }, + "generatedName": "DataEventListPagesNext", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventListPagesSince", + "key": "since", + "schema": { + "generatedName": "dataEventListPagesSince", + "value": { + "schema": { + "example": "https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065", + "type": "string" + }, + "generatedName": "DataEventListPagesSince", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Pagination", + "generatedName": "DataEventListPages", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of data events for the App.", + "generatedName": "DataEventList", + "title": "Data Event List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_event_summary": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataEventSummaryType", + "key": "type", + "schema": { + "generatedName": "dataEventSummaryType", + "title": "Data Event Summary", + "value": { + "description": "The type of the object", + "value": { + "value": "event.summary", + "type": "string" + }, + "generatedName": "DataEventSummaryType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryEmail", + "key": "email", + "schema": { + "generatedName": "dataEventSummaryEmail", + "title": "Data Event Summary", + "value": { + "description": "The email address of the user", + "schema": { + "example": "Sam.Sung@example.com", + "type": "string" + }, + "generatedName": "DataEventSummaryEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryIntercomUserId", + "key": "intercom_user_id", + "schema": { + "generatedName": "dataEventSummaryIntercomUserId", + "title": "Data Event Summary", + "value": { + "description": "The Intercom user ID of the user", + "schema": { + "example": "63a0979a5eeebeaf28dd56ba", + "type": "string" + }, + "generatedName": "DataEventSummaryIntercomUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryUserId", + "key": "user_id", + "schema": { + "generatedName": "dataEventSummaryUserId", + "title": "Data Event Summary", + "value": { + "description": "The user ID of the user", + "schema": { + "example": "62b997f288e14803c5006932", + "type": "string" + }, + "generatedName": "DataEventSummaryUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryEvents", + "key": "events", + "schema": { + "generatedName": "dataEventSummaryEvents", + "title": "Data Event Summary", + "value": { + "description": "A summary of data events", + "value": { + "generatedName": "DataEventSummaryEventsItem", + "schema": "data_event_summary_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "DataEventSummaryEvents", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a summary of data events for the App.", + "generatedName": "DataEventSummary", + "title": "Data Event Summary", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_event_summary_item": { + "generatedName": "DataEventSummaryItem", + "title": "Data Event Summary Item", + "description": "This will return a summary of a data event for the App.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataEventSummaryItemName", + "key": "name", + "schema": { + "generatedName": "dataEventSummaryItemName", + "title": "Data Event Summary Item", + "value": { + "description": "The name of the event", + "schema": { + "example": "placed-order", + "type": "string" + }, + "generatedName": "DataEventSummaryItemName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryItemFirst", + "key": "first", + "schema": { + "generatedName": "dataEventSummaryItemFirst", + "title": "Data Event Summary Item", + "value": { + "description": "The first time the event was sent", + "schema": { + "example": "2014-01-16T23:12:21.000+00:00", + "type": "string" + }, + "generatedName": "DataEventSummaryItemFirst", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryItemLast", + "key": "last", + "schema": { + "generatedName": "dataEventSummaryItemLast", + "title": "Data Event Summary Item", + "value": { + "description": "The last time the event was sent", + "schema": { + "example": "2014-01-16T23:12:21.000+00:00 ", + "type": "string" + }, + "generatedName": "DataEventSummaryItemLast", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryItemCount", + "key": "count", + "schema": { + "generatedName": "dataEventSummaryItemCount", + "title": "Data Event Summary Item", + "value": { + "description": "The number of times the event was sent", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "DataEventSummaryItemCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataEventSummaryItemDescription", + "key": "description", + "schema": { + "generatedName": "dataEventSummaryItemDescription", + "title": "Data Event Summary Item", + "value": { + "description": "The description of the event", + "schema": { + "example": "A user placed an order", + "type": "string" + }, + "generatedName": "DataEventSummaryItemDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a summary of a data event for the App.", + "generatedName": "DataEventSummaryItem", + "title": "Data Event Summary Item", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "data_export": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataExportJobIdentfier", + "key": "job_identfier", + "schema": { + "generatedName": "dataExportJobIdentfier", + "title": "Data Export", + "value": { + "description": "The identifier for your job.", + "schema": { + "example": "orzzsbd7hk67xyu", + "type": "string" + }, + "generatedName": "DataExportJobIdentfier", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Export" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportStatus", + "key": "status", + "schema": { + "generatedName": "dataExportStatus", + "title": "Data Export", + "value": { + "description": "The current state of your job.", + "generatedName": "DataExportStatus", + "values": [ + { + "generatedName": "pending", + "value": "pending", + "casing": {} + }, + { + "generatedName": "in_progress", + "value": "in_progress", + "casing": {} + }, + { + "generatedName": "failed", + "value": "failed", + "casing": {} + }, + { + "generatedName": "completed", + "value": "completed", + "casing": {} + }, + { + "generatedName": "no_data", + "value": "no_data", + "casing": {} + }, + { + "generatedName": "canceled", + "value": "canceled", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Data Export" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportDownloadExpiresAt", + "key": "download_expires_at", + "schema": { + "generatedName": "dataExportDownloadExpiresAt", + "title": "Data Export", + "value": { + "description": "The time after which you will not be able to access the data.", + "schema": { + "example": "1674917488", + "type": "string" + }, + "generatedName": "DataExportDownloadExpiresAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Export" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportDownloadUrl", + "key": "download_url", + "schema": { + "generatedName": "dataExportDownloadUrl", + "title": "Data Export", + "value": { + "description": "The location where you can download your data.", + "schema": { + "example": "https://api.intercom.test/download/messages/data/example", + "type": "string" + }, + "generatedName": "DataExportDownloadUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Data Export" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The data export api is used to view all message sent & viewed in a given timeframe.", + "generatedName": "DataExport", + "title": "Data Export", + "groupName": [ + "Data Export" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "data_export_csv": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "dataExportCsvUserId", + "key": "user_id", + "schema": { + "generatedName": "dataExportCsvUserId", + "title": "Data Export CSV", + "value": { + "description": "The user_id of the user who was sent the message.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvUserExternalId", + "key": "user_external_id", + "schema": { + "generatedName": "dataExportCsvUserExternalId", + "title": "Data Export CSV", + "value": { + "description": "The external_user_id of the user who was sent the message", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvUserExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvCompanyId", + "key": "company_id", + "schema": { + "generatedName": "dataExportCsvCompanyId", + "title": "Data Export CSV", + "value": { + "description": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvEmail", + "key": "email", + "schema": { + "generatedName": "dataExportCsvEmail", + "title": "Data Export CSV", + "value": { + "description": "The users email who was sent the message.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvName", + "key": "name", + "schema": { + "generatedName": "dataExportCsvName", + "title": "Data Export CSV", + "value": { + "description": "The full name of the user receiving the message", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvRulesetId", + "key": "ruleset_id", + "schema": { + "generatedName": "dataExportCsvRulesetId", + "title": "Data Export CSV", + "value": { + "description": "The id of the message.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvRulesetId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvContentId", + "key": "content_id", + "schema": { + "generatedName": "dataExportCsvContentId", + "title": "Data Export CSV", + "value": { + "description": "The specific content that was received. In an A/B test each version has its own Content ID.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvContentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvContentType", + "key": "content_type", + "schema": { + "generatedName": "dataExportCsvContentType", + "title": "Data Export CSV", + "value": { + "description": "Email, Chat, Post etc.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvContentTitle", + "key": "content_title", + "schema": { + "generatedName": "dataExportCsvContentTitle", + "title": "Data Export CSV", + "value": { + "description": "The title of the content you see in your Intercom workspace.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvContentTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvRulesetVersionId", + "key": "ruleset_version_id", + "schema": { + "generatedName": "dataExportCsvRulesetVersionId", + "title": "Data Export CSV", + "value": { + "description": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvRulesetVersionId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvReceiptId", + "key": "receipt_id", + "schema": { + "generatedName": "dataExportCsvReceiptId", + "title": "Data Export CSV", + "value": { + "description": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvReceiptId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvReceivedAt", + "key": "received_at", + "schema": { + "generatedName": "dataExportCsvReceivedAt", + "title": "Data Export CSV", + "value": { + "description": "Timestamp for when the receipt was recorded.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvReceivedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvSeriesId", + "key": "series_id", + "schema": { + "generatedName": "dataExportCsvSeriesId", + "title": "Data Export CSV", + "value": { + "description": "The id of the series that this content is part of. Will return -1 if not part of a series.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvSeriesId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvSeriesTitle", + "key": "series_title", + "schema": { + "generatedName": "dataExportCsvSeriesTitle", + "title": "Data Export CSV", + "value": { + "description": "The title of the series that this content is part of.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvSeriesTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvNodeId", + "key": "node_id", + "schema": { + "generatedName": "dataExportCsvNodeId", + "title": "Data Export CSV", + "value": { + "description": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.", + "schema": { + "type": "string" + }, + "generatedName": "DataExportCsvNodeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstReply", + "key": "first_reply", + "schema": { + "generatedName": "dataExportCsvFirstReply", + "title": "Data Export CSV", + "value": { + "description": "The first time a user replied to this message if the content was able to receive replies.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstReply", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstCompletion", + "key": "first_completion", + "schema": { + "generatedName": "dataExportCsvFirstCompletion", + "title": "Data Export CSV", + "value": { + "description": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstCompletion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstSeriesCompletion", + "key": "first_series_completion", + "schema": { + "generatedName": "dataExportCsvFirstSeriesCompletion", + "title": "Data Export CSV", + "value": { + "description": "The first time the series this message was a part of was completed by the user.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstSeriesCompletion", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstSeriesDisengagement", + "key": "first_series_disengagement", + "schema": { + "generatedName": "dataExportCsvFirstSeriesDisengagement", + "title": "Data Export CSV", + "value": { + "description": "The first time the series this message was a part of was disengaged by the user.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstSeriesDisengagement", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstSeriesExit", + "key": "first_series_exit", + "schema": { + "generatedName": "dataExportCsvFirstSeriesExit", + "title": "Data Export CSV", + "value": { + "description": "The first time the series this message was a part of was exited by the user.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstSeriesExit", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstGoalSuccess", + "key": "first_goal_success", + "schema": { + "generatedName": "dataExportCsvFirstGoalSuccess", + "title": "Data Export CSV", + "value": { + "description": "The first time the user met this messages associated goal if one exists.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstGoalSuccess", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstOpen", + "key": "first_open", + "schema": { + "generatedName": "dataExportCsvFirstOpen", + "title": "Data Export CSV", + "value": { + "description": "The first time the user opened this message.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstOpen", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstClick", + "key": "first_click", + "schema": { + "generatedName": "dataExportCsvFirstClick", + "title": "Data Export CSV", + "value": { + "description": "The first time the series the user clicked on a link within this message.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstClick", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstDismisall", + "key": "first_dismisall", + "schema": { + "generatedName": "dataExportCsvFirstDismisall", + "title": "Data Export CSV", + "value": { + "description": "The first time the series the user dismissed this message.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstDismisall", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstUnsubscribe", + "key": "first_unsubscribe", + "schema": { + "generatedName": "dataExportCsvFirstUnsubscribe", + "title": "Data Export CSV", + "value": { + "description": "The first time the user unsubscribed from this message.", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstUnsubscribe", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "dataExportCsvFirstHardBounce", + "key": "first_hard_bounce", + "schema": { + "generatedName": "dataExportCsvFirstHardBounce", + "title": "Data Export CSV", + "value": { + "description": "The first time this message hard bounced for this user", + "schema": { + "type": "int" + }, + "generatedName": "DataExportCsvFirstHardBounce", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A CSV output file", + "generatedName": "DataExportCsv", + "title": "Data Export CSV", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "deleted_article_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "deletedArticleObjectId", + "key": "id", + "schema": { + "generatedName": "deletedArticleObjectId", + "title": "Deleted Article Object", + "value": { + "description": "The unique identifier for the article which you provided in the URL.", + "schema": { + "example": "6890762", + "type": "string" + }, + "generatedName": "DeletedArticleObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedArticleObjectObject", + "key": "object", + "schema": { + "generatedName": "deletedArticleObjectObject", + "title": "Deleted Article Object", + "value": { + "description": "The type of object which was deleted. - article", + "value": { + "value": "article", + "type": "string" + }, + "generatedName": "DeletedArticleObjectObject", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedArticleObjectDeleted", + "key": "deleted", + "schema": { + "generatedName": "deletedArticleObjectDeleted", + "title": "Deleted Article Object", + "value": { + "description": "Whether the article was deleted successfully or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DeletedArticleObjectDeleted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Response returned when an object is deleted", + "generatedName": "DeletedArticleObject", + "title": "Deleted Article Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "deleted_collection_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "deletedCollectionObjectId", + "key": "id", + "schema": { + "generatedName": "deletedCollectionObjectId", + "title": "Deleted Collection Object", + "value": { + "description": "The unique identifier for the collection which you provided in the URL.", + "schema": { + "example": "6890762", + "type": "string" + }, + "generatedName": "DeletedCollectionObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedCollectionObjectObject", + "key": "object", + "schema": { + "generatedName": "deletedCollectionObjectObject", + "title": "Deleted Collection Object", + "value": { + "description": "The type of object which was deleted. - `collection`", + "value": { + "value": "collection", + "type": "string" + }, + "generatedName": "DeletedCollectionObjectObject", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedCollectionObjectDeleted", + "key": "deleted", + "schema": { + "generatedName": "deletedCollectionObjectDeleted", + "title": "Deleted Collection Object", + "value": { + "description": "Whether the collection was deleted successfully or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DeletedCollectionObjectDeleted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Response returned when an object is deleted", + "generatedName": "DeletedCollectionObject", + "title": "Deleted Collection Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "deleted_company_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "deletedCompanyObjectId", + "key": "id", + "schema": { + "generatedName": "deletedCompanyObjectId", + "title": "Deleted Company Object", + "value": { + "description": "The unique identifier for the company which is given by Intercom.", + "schema": { + "example": "5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f", + "type": "string" + }, + "generatedName": "DeletedCompanyObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedCompanyObjectObject", + "key": "object", + "schema": { + "generatedName": "deletedCompanyObjectObject", + "title": "Deleted Company Object", + "value": { + "description": "The type of object which was deleted. - `company`", + "value": { + "value": "company", + "type": "string" + }, + "generatedName": "DeletedCompanyObjectObject", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedCompanyObjectDeleted", + "key": "deleted", + "schema": { + "generatedName": "deletedCompanyObjectDeleted", + "title": "Deleted Company Object", + "value": { + "description": "Whether the company was deleted successfully or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DeletedCompanyObjectDeleted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Response returned when an object is deleted", + "generatedName": "DeletedCompanyObject", + "title": "Deleted Company Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "deleted_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "deletedObjectId", + "key": "id", + "schema": { + "generatedName": "deletedObjectId", + "title": "Deleted Object", + "value": { + "description": "The unique identifier for the news item which you provided in the URL.", + "schema": { + "example": "6890762", + "type": "string" + }, + "generatedName": "DeletedObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedObjectObject", + "key": "object", + "schema": { + "generatedName": "deletedObjectObject", + "title": "Deleted Object", + "value": { + "description": "The type of object which was deleted - news-item.", + "value": { + "value": "news-item", + "type": "string" + }, + "generatedName": "DeletedObjectObject", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "deletedObjectDeleted", + "key": "deleted", + "schema": { + "generatedName": "deletedObjectDeleted", + "title": "Deleted Object", + "value": { + "description": "Whether the news item was deleted successfully or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "DeletedObjectDeleted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Response returned when an object is deleted", + "generatedName": "DeletedObject", + "title": "Deleted Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "detach_contact_from_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "detachContactFromConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The `id` of the admin who is performing the action.", + "schema": { + "example": "5017690", + "type": "string" + }, + "generatedName": "DetachContactFromConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "DetachContactFromConversationRequest", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "error": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "errorType", + "key": "type", + "schema": { + "description": "The type is error.list", + "schema": { + "example": "error.list", + "type": "string" + }, + "generatedName": "ErrorType", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "errorRequestId", + "key": "request_id", + "schema": { + "generatedName": "errorRequestId", + "nameOverride": "Error", + "title": "Error", + "value": { + "generatedName": "ErrorRequestId", + "description": "", + "value": { + "description": "", + "schema": { + "format": "uuid", + "example": "f93ecfa8-d08a-4325-8694-89aeb89c8f85", + "type": "string" + }, + "generatedName": "ErrorRequestId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "errorErrors", + "key": "errors", + "schema": { + "description": "An array of one or more error objects", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "errorErrorsItemCode", + "key": "code", + "schema": { + "description": "A string indicating the kind of error, used to further qualify the HTTP response code", + "schema": { + "example": "unauthorized", + "type": "string" + }, + "generatedName": "ErrorErrorsItemCode", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "errorErrorsItemMessage", + "key": "message", + "schema": { + "generatedName": "errorErrorsItemMessage", + "value": { + "generatedName": "ErrorErrorsItemMessage", + "description": "Optional. Human readable description of the error.", + "value": { + "description": "Optional. Human readable description of the error.", + "schema": { + "example": "Access Token Invalid", + "type": "string" + }, + "generatedName": "ErrorErrorsItemMessage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "errorErrorsItemField", + "key": "field", + "schema": { + "generatedName": "errorErrorsItemField", + "value": { + "generatedName": "ErrorErrorsItemField", + "description": "Optional. Used to identify a particular field or query parameter that was in error.", + "value": { + "description": "Optional. Used to identify a particular field or query parameter that was in error.", + "schema": { + "example": "email", + "type": "string" + }, + "generatedName": "ErrorErrorsItemField", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "ErrorErrorsItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "ErrorErrors", + "groupName": [], + "type": "array" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "generatedName": "Error", + "nameOverride": "Error", + "title": "Error", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "file_attribute": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "fileAttributeType", + "key": "type", + "schema": { + "generatedName": "fileAttributeType", + "nameOverride": "File", + "title": "File", + "value": { + "schema": { + "example": "upload", + "type": "string" + }, + "generatedName": "FileAttributeType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeName", + "key": "name", + "schema": { + "generatedName": "fileAttributeName", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The name of the file", + "schema": { + "example": "Screenshot.png", + "type": "string" + }, + "generatedName": "FileAttributeName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeUrl", + "key": "url", + "schema": { + "generatedName": "fileAttributeUrl", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The url of the file. This is a temporary URL and will expire after 30 minutes.", + "schema": { + "example": "https://intercom-attachments-1.com/.../Screenshot.png", + "type": "string" + }, + "generatedName": "FileAttributeUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeContentType", + "key": "content_type", + "schema": { + "generatedName": "fileAttributeContentType", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The type of file", + "schema": { + "example": "image/png", + "type": "string" + }, + "generatedName": "FileAttributeContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeFilesize", + "key": "filesize", + "schema": { + "generatedName": "fileAttributeFilesize", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The size of the file in bytes", + "schema": { + "example": 11308309, + "type": "int" + }, + "generatedName": "FileAttributeFilesize", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeWidth", + "key": "width", + "schema": { + "generatedName": "fileAttributeWidth", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The width of the file in pixels, if applicable", + "schema": { + "example": 3024, + "type": "int" + }, + "generatedName": "FileAttributeWidth", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "fileAttributeHeight", + "key": "height", + "schema": { + "generatedName": "fileAttributeHeight", + "nameOverride": "File", + "title": "File", + "value": { + "description": "The height of the file in pixels, if applicable", + "schema": { + "example": 1964, + "type": "int" + }, + "generatedName": "FileAttributeHeight", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The value describing a file upload set for a custom attribute", + "generatedName": "FileAttribute", + "nameOverride": "File", + "title": "File", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "group_content": { + "generatedName": "GroupContent", + "title": "Group Content", + "description": "The Content of a Group.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "groupContentType", + "key": "type", + "schema": { + "generatedName": "groupContentType", + "title": "Group Content", + "value": { + "generatedName": "GroupContentType", + "description": "The type of object - `group_content` .", + "value": { + "description": "The type of object - `group_content` .", + "schema": { + "example": "group_content", + "type": "string" + }, + "generatedName": "GroupContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "groupContentName", + "key": "name", + "schema": { + "generatedName": "groupContentName", + "title": "Group Content", + "value": { + "description": "The name of the collection or section.", + "schema": { + "example": "Collection name", + "type": "string" + }, + "generatedName": "GroupContentName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "groupContentDescription", + "key": "description", + "schema": { + "generatedName": "groupContentDescription", + "title": "Group Content", + "value": { + "description": "The description of the collection. Only available for collections.", + "schema": { + "example": " Collection description", + "type": "string" + }, + "generatedName": "GroupContentDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The Content of a Group.", + "generatedName": "GroupContent", + "title": "Group Content", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "group_translated_content": { + "generatedName": "GroupTranslatedContent", + "title": "Group Translated Content", + "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "groupTranslatedContentType", + "key": "type", + "schema": { + "generatedName": "groupTranslatedContentType", + "title": "Group Translated Content", + "value": { + "generatedName": "GroupTranslatedContentType", + "description": "The type of object - group_translated_content.", + "value": { + "description": "The type of object - group_translated_content.", + "schema": { + "example": "group_translated_content", + "type": "string" + }, + "generatedName": "GroupTranslatedContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentAr", + "key": "ar", + "schema": { + "generatedName": "groupTranslatedContentAr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Arabic", + "generatedName": "GroupTranslatedContentAr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentBg", + "key": "bg", + "schema": { + "generatedName": "groupTranslatedContentBg", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Bulgarian", + "generatedName": "GroupTranslatedContentBg", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentBs", + "key": "bs", + "schema": { + "generatedName": "groupTranslatedContentBs", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Bosnian", + "generatedName": "GroupTranslatedContentBs", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentCa", + "key": "ca", + "schema": { + "generatedName": "groupTranslatedContentCa", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Catalan", + "generatedName": "GroupTranslatedContentCa", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentCs", + "key": "cs", + "schema": { + "generatedName": "groupTranslatedContentCs", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Czech", + "generatedName": "GroupTranslatedContentCs", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentDa", + "key": "da", + "schema": { + "generatedName": "groupTranslatedContentDa", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Danish", + "generatedName": "GroupTranslatedContentDa", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentDe", + "key": "de", + "schema": { + "generatedName": "groupTranslatedContentDe", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in German", + "generatedName": "GroupTranslatedContentDe", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentEl", + "key": "el", + "schema": { + "generatedName": "groupTranslatedContentEl", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Greek", + "generatedName": "GroupTranslatedContentEl", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentEn", + "key": "en", + "schema": { + "generatedName": "groupTranslatedContentEn", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in English", + "generatedName": "GroupTranslatedContentEn", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentEs", + "key": "es", + "schema": { + "generatedName": "groupTranslatedContentEs", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Spanish", + "generatedName": "GroupTranslatedContentEs", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentEt", + "key": "et", + "schema": { + "generatedName": "groupTranslatedContentEt", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Estonian", + "generatedName": "GroupTranslatedContentEt", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentFi", + "key": "fi", + "schema": { + "generatedName": "groupTranslatedContentFi", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Finnish", + "generatedName": "GroupTranslatedContentFi", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentFr", + "key": "fr", + "schema": { + "generatedName": "groupTranslatedContentFr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in French", + "generatedName": "GroupTranslatedContentFr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentHe", + "key": "he", + "schema": { + "generatedName": "groupTranslatedContentHe", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Hebrew", + "generatedName": "GroupTranslatedContentHe", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentHr", + "key": "hr", + "schema": { + "generatedName": "groupTranslatedContentHr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Croatian", + "generatedName": "GroupTranslatedContentHr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentHu", + "key": "hu", + "schema": { + "generatedName": "groupTranslatedContentHu", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Hungarian", + "generatedName": "GroupTranslatedContentHu", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentId", + "key": "id", + "schema": { + "generatedName": "groupTranslatedContentId", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Indonesian", + "generatedName": "GroupTranslatedContentId", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentIt", + "key": "it", + "schema": { + "generatedName": "groupTranslatedContentIt", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Italian", + "generatedName": "GroupTranslatedContentIt", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentJa", + "key": "ja", + "schema": { + "generatedName": "groupTranslatedContentJa", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Japanese", + "generatedName": "GroupTranslatedContentJa", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentKo", + "key": "ko", + "schema": { + "generatedName": "groupTranslatedContentKo", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Korean", + "generatedName": "GroupTranslatedContentKo", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentLt", + "key": "lt", + "schema": { + "generatedName": "groupTranslatedContentLt", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Lithuanian", + "generatedName": "GroupTranslatedContentLt", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentLv", + "key": "lv", + "schema": { + "generatedName": "groupTranslatedContentLv", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Latvian", + "generatedName": "GroupTranslatedContentLv", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentMn", + "key": "mn", + "schema": { + "generatedName": "groupTranslatedContentMn", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Mongolian", + "generatedName": "GroupTranslatedContentMn", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentNb", + "key": "nb", + "schema": { + "generatedName": "groupTranslatedContentNb", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Norwegian", + "generatedName": "GroupTranslatedContentNb", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentNl", + "key": "nl", + "schema": { + "generatedName": "groupTranslatedContentNl", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Dutch", + "generatedName": "GroupTranslatedContentNl", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentPl", + "key": "pl", + "schema": { + "generatedName": "groupTranslatedContentPl", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Polish", + "generatedName": "GroupTranslatedContentPl", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentPt", + "key": "pt", + "schema": { + "generatedName": "groupTranslatedContentPt", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Portuguese (Portugal)", + "generatedName": "GroupTranslatedContentPt", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentRo", + "key": "ro", + "schema": { + "generatedName": "groupTranslatedContentRo", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Romanian", + "generatedName": "GroupTranslatedContentRo", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentRu", + "key": "ru", + "schema": { + "generatedName": "groupTranslatedContentRu", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Russian", + "generatedName": "GroupTranslatedContentRu", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentSl", + "key": "sl", + "schema": { + "generatedName": "groupTranslatedContentSl", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Slovenian", + "generatedName": "GroupTranslatedContentSl", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentSr", + "key": "sr", + "schema": { + "generatedName": "groupTranslatedContentSr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Serbian", + "generatedName": "GroupTranslatedContentSr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentSv", + "key": "sv", + "schema": { + "generatedName": "groupTranslatedContentSv", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Swedish", + "generatedName": "GroupTranslatedContentSv", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentTr", + "key": "tr", + "schema": { + "generatedName": "groupTranslatedContentTr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Turkish", + "generatedName": "GroupTranslatedContentTr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentVi", + "key": "vi", + "schema": { + "generatedName": "groupTranslatedContentVi", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Vietnamese", + "generatedName": "GroupTranslatedContentVi", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentPtBr", + "key": "pt-BR", + "schema": { + "generatedName": "groupTranslatedContentPtBr", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Portuguese (Brazil)", + "generatedName": "GroupTranslatedContentPtBr", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentZhCn", + "key": "zh-CN", + "schema": { + "generatedName": "groupTranslatedContentZhCn", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Chinese (China)", + "generatedName": "GroupTranslatedContentZhCn", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "groupTranslatedContentZhTw", + "key": "zh-TW", + "schema": { + "generatedName": "groupTranslatedContentZhTw", + "title": "Group Translated Content", + "value": { + "description": "The content of the group in Chinese (Taiwan)", + "generatedName": "GroupTranslatedContentZhTw", + "schema": "group_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "generatedName": "GroupTranslatedContent", + "title": "Group Translated Content", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "help_center": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "helpCenterId", + "key": "id", + "schema": { + "generatedName": "helpCenterId", + "title": "Help Center", + "value": { + "description": "The unique identifier for the Help Center which is given by Intercom.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "HelpCenterId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "helpCenterWorkspaceId", + "title": "Help Center", + "value": { + "description": "The id of the workspace which the Help Center belongs to.", + "schema": { + "example": "hfi1bx4l", + "type": "string" + }, + "generatedName": "HelpCenterWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "helpCenterCreatedAt", + "title": "Help Center", + "value": { + "description": "The time when the Help Center was created.", + "schema": { + "example": 1672928359, + "type": "int" + }, + "generatedName": "HelpCenterCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "helpCenterUpdatedAt", + "title": "Help Center", + "value": { + "description": "The time when the Help Center was last updated.", + "schema": { + "example": 1672928610, + "type": "int" + }, + "generatedName": "HelpCenterUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterIdentifier", + "key": "identifier", + "schema": { + "generatedName": "helpCenterIdentifier", + "title": "Help Center", + "value": { + "description": "The identifier of the Help Center. This is used in the URL of the Help Center.", + "schema": { + "example": "intercom", + "type": "string" + }, + "generatedName": "HelpCenterIdentifier", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterWebsiteTurnedOn", + "key": "website_turned_on", + "schema": { + "generatedName": "helpCenterWebsiteTurnedOn", + "title": "Help Center", + "value": { + "description": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "HelpCenterWebsiteTurnedOn", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterDisplayName", + "key": "display_name", + "schema": { + "generatedName": "helpCenterDisplayName", + "title": "Help Center", + "value": { + "description": "The display name of the Help Center only seen by teammates.", + "schema": { + "example": "Intercom Help Center", + "type": "string" + }, + "generatedName": "HelpCenterDisplayName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Help Centers contain collections", + "generatedName": "HelpCenter", + "title": "Help Center", + "groupName": [ + "Help Center" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "help_center_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "helpCenterListType", + "key": "type", + "schema": { + "generatedName": "helpCenterListType", + "title": "Help Centers", + "value": { + "description": "The type of the object - `list`.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "HelpCenterListType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "helpCenterListData", + "key": "data", + "schema": { + "generatedName": "helpCenterListData", + "title": "Help Centers", + "value": { + "description": "An array of Help Center objects", + "value": { + "generatedName": "HelpCenterListDataItem", + "schema": "help_center", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "HelpCenterListData", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Help Center" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Help Centers belonging to the App", + "generatedName": "HelpCenterList", + "title": "Help Centers", + "groupName": [ + "Help Center" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "intercom_version": { + "description": "Intercom API version.
By default, it's equal to the version set in the app package.", + "generatedName": "IntercomVersion", + "values": [ + { + "generatedName": "One0", + "value": "1.0", + "casing": {} + }, + { + "generatedName": "One1", + "value": "1.1", + "casing": {} + }, + { + "generatedName": "One2", + "value": "1.2", + "casing": {} + }, + { + "generatedName": "One3", + "value": "1.3", + "casing": {} + }, + { + "generatedName": "One4", + "value": "1.4", + "casing": {} + }, + { + "generatedName": "Two0", + "value": "2.0", + "casing": {} + }, + { + "generatedName": "Two1", + "value": "2.1", + "casing": {} + }, + { + "generatedName": "Two2", + "value": "2.2", + "casing": {} + }, + { + "generatedName": "Two3", + "value": "2.3", + "casing": {} + }, + { + "generatedName": "Two4", + "value": "2.4", + "casing": {} + }, + { + "generatedName": "Two5", + "value": "2.5", + "casing": {} + }, + { + "generatedName": "Two6", + "value": "2.6", + "casing": {} + }, + { + "generatedName": "Two7", + "value": "2.7", + "casing": {} + }, + { + "generatedName": "Two8", + "value": "2.8", + "casing": {} + }, + { + "generatedName": "Two9", + "value": "2.9", + "casing": {} + }, + { + "generatedName": "Two10", + "value": "2.10", + "casing": {} + }, + { + "generatedName": "Two11", + "value": "2.11", + "casing": {} + }, + { + "generatedName": "Unstable", + "value": "Unstable", + "casing": {} + } + ], + "default": { + "generatedName": "Two11", + "value": "2.11", + "casing": {} + }, + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "linked_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "linkedObjectType", + "key": "type", + "schema": { + "generatedName": "linkedObjectType", + "title": "Linked Object", + "value": { + "description": "ticket or conversation", + "generatedName": "LinkedObjectType", + "values": [ + { + "generatedName": "ticket", + "value": "ticket", + "casing": {} + }, + { + "generatedName": "conversation", + "value": "conversation", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "linkedObjectId", + "key": "id", + "schema": { + "generatedName": "linkedObjectId", + "title": "Linked Object", + "value": { + "description": "The ID of the linked object", + "schema": { + "example": "7583", + "type": "string" + }, + "generatedName": "LinkedObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "linkedObjectCategory", + "key": "category", + "schema": { + "generatedName": "linkedObjectCategory", + "title": "Linked Object", + "value": { + "generatedName": "LinkedObjectCategory", + "description": "Category of the Linked Ticket Object.", + "value": { + "description": "Category of the Linked Ticket Object.", + "schema": { + "example": "Customer", + "type": "string" + }, + "generatedName": "LinkedObjectCategory", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A linked conversation or ticket.", + "generatedName": "LinkedObject", + "title": "Linked Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "linked_object_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "linkedObjectListType", + "key": "type", + "schema": { + "generatedName": "linkedObjectListType", + "title": "Linked Objects", + "value": { + "description": "Always list.", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "LinkedObjectListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "linkedObjectListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "linkedObjectListTotalCount", + "title": "Linked Objects", + "value": { + "description": "The total number of linked objects.", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "LinkedObjectListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "linkedObjectListHasMore", + "key": "has_more", + "schema": { + "generatedName": "linkedObjectListHasMore", + "title": "Linked Objects", + "value": { + "description": "Whether or not there are more linked objects than returned.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "LinkedObjectListHasMore", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "linkedObjectListData", + "key": "data", + "schema": { + "generatedName": "linkedObjectListData", + "title": "Linked Objects", + "value": { + "description": "An array containing the linked conversations and linked tickets.", + "value": { + "generatedName": "LinkedObjectListDataItem", + "schema": "linked_object", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "LinkedObjectListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "generatedName": "LinkedObjectList", + "title": "Linked Objects", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "merge_contacts_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "mergeContactsRequestFrom", + "key": "from", + "schema": { + "generatedName": "mergeContactsRequestFrom", + "title": "Merge contact data", + "value": { + "description": "The unique identifier for the contact to merge away from. Must be a lead.", + "schema": { + "example": "5d70dd30de4efd54f42fd526", + "type": "string" + }, + "generatedName": "MergeContactsRequestFrom", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "mergeContactsRequestInto", + "key": "into", + "schema": { + "generatedName": "mergeContactsRequestInto", + "title": "Merge contact data", + "value": { + "description": "The unique identifier for the contact to merge into. Must be a user.", + "schema": { + "example": "5ba682d23d7cf92bef87bfd4", + "type": "string" + }, + "generatedName": "MergeContactsRequestInto", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Merge contact data.", + "generatedName": "MergeContactsRequest", + "title": "Merge contact data", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "message": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "messageType", + "key": "type", + "schema": { + "description": "The type of the message", + "schema": { + "example": "user_message", + "type": "string" + }, + "generatedName": "MessageType", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageId", + "key": "id", + "schema": { + "description": "The id representing the message.", + "schema": { + "example": "1488971108", + "type": "string" + }, + "generatedName": "MessageId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageCreatedAt", + "key": "created_at", + "schema": { + "description": "The time the conversation was created.", + "schema": { + "example": 1667560812, + "type": "int" + }, + "generatedName": "MessageCreatedAt", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageSubject", + "key": "subject", + "schema": { + "generatedName": "messageSubject", + "nameOverride": "Message", + "title": "Message", + "value": { + "description": "The subject of the message. Only present if message_type: email.", + "schema": { + "example": "Greetings", + "type": "string" + }, + "generatedName": "MessageSubject", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Messages" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageBody", + "key": "body", + "schema": { + "description": "The message body, which may contain HTML.", + "schema": { + "example": "Hello", + "type": "string" + }, + "generatedName": "MessageBody", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageMessageType", + "key": "message_type", + "schema": { + "description": "The type of message that was sent. Can be email, inapp, facebook or twitter.", + "generatedName": "MessageMessageType", + "values": [ + { + "generatedName": "email", + "value": "email", + "casing": {} + }, + { + "generatedName": "inapp", + "value": "inapp", + "casing": {} + }, + { + "generatedName": "facebook", + "value": "facebook", + "casing": {} + }, + { + "generatedName": "twitter", + "value": "twitter", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "messageConversationId", + "key": "conversation_id", + "schema": { + "generatedName": "messageConversationId", + "nameOverride": "Message", + "title": "Message", + "value": { + "description": "The associated conversation_id", + "schema": { + "example": "64619700005570", + "type": "string" + }, + "generatedName": "MessageConversationId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Messages" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "generatedName": "Message", + "nameOverride": "Message", + "title": "Message", + "groupName": [ + "Messages" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "multiple_filter_search_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "multipleFilterSearchRequestOperator", + "key": "operator", + "schema": { + "generatedName": "multipleFilterSearchRequestOperator", + "title": "Multiple Filter Search Request", + "value": { + "description": "An operator to allow boolean inspection between multiple fields.", + "generatedName": "MultipleFilterSearchRequestOperator", + "values": [ + { + "generatedName": "AND", + "value": "AND", + "casing": {} + }, + { + "generatedName": "OR", + "value": "OR", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "multipleFilterSearchRequestValue", + "key": "value", + "schema": { + "generatedName": "multipleFilterSearchRequestValue", + "title": "Multiple Filter Search Request", + "value": { + "value": { + "generatedName": "MultipleFilterSearchRequestValue", + "schemas": [ + { + "description": "Add mutiple filters.", + "value": { + "generatedName": "MultipleFilterSearchRequestValueItem", + "schema": "multiple_filter_search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "MultipleFilterSearchRequestValue", + "title": "multiple filter search request", + "groupName": [], + "type": "array" + }, + { + "description": "Add a single filter field.", + "value": { + "generatedName": "MultipleFilterSearchRequestValueItem", + "schema": "single_filter_search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "MultipleFilterSearchRequestValue", + "title": "single filter search request", + "groupName": [], + "type": "array" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Search using Intercoms Search APIs with more than one filter.", + "generatedName": "MultipleFilterSearchRequest", + "title": "Multiple Filter Search Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "news_item": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "newsItemId", + "key": "id", + "schema": { + "generatedName": "newsItemId", + "title": "News Item", + "value": { + "description": "The unique identifier for the news item which is given by Intercom.", + "schema": { + "example": "141", + "type": "string" + }, + "generatedName": "NewsItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "newsItemWorkspaceId", + "title": "News Item", + "value": { + "description": "The id of the workspace which the news item belongs to.", + "schema": { + "example": "t74hdn32", + "type": "string" + }, + "generatedName": "NewsItemWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemTitle", + "key": "title", + "schema": { + "generatedName": "newsItemTitle", + "title": "News Item", + "value": { + "description": "The title of the news item.", + "schema": { + "example": "New feature: News Items", + "type": "string" + }, + "generatedName": "NewsItemTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemBody", + "key": "body", + "schema": { + "generatedName": "newsItemBody", + "title": "News Item", + "value": { + "description": "The news item body, which may contain HTML.", + "schema": { + "example": "We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "type": "string" + }, + "generatedName": "NewsItemBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemSenderId", + "key": "sender_id", + "schema": { + "generatedName": "newsItemSenderId", + "title": "News Item", + "value": { + "description": "The id of the sender of the news item. Must be a teammate on the workspace.", + "schema": { + "example": 123, + "type": "int" + }, + "generatedName": "NewsItemSenderId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemState", + "key": "state", + "schema": { + "generatedName": "newsItemState", + "title": "News Item", + "value": { + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "generatedName": "NewsItemState", + "values": [ + { + "generatedName": "draft", + "value": "draft", + "casing": {} + }, + { + "generatedName": "live", + "value": "live", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemNewsfeedAssignments", + "key": "newsfeed_assignments", + "schema": { + "generatedName": "newsItemNewsfeedAssignments", + "title": "News Item", + "value": { + "description": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "value": { + "generatedName": "NewsItemNewsfeedAssignmentsItem", + "schema": "newsfeed_assignment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "NewsItemNewsfeedAssignments", + "groupName": [], + "type": "array" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemLabels", + "key": "labels", + "schema": { + "generatedName": "newsItemLabels", + "title": "News Item", + "value": { + "description": "Label names displayed to users to categorize the news item.", + "value": { + "generatedName": "NewsItemLabelsItem", + "description": "The label name.", + "value": { + "description": "The label name.", + "schema": { + "example": "Product Update", + "type": "string" + }, + "generatedName": "NewsItemLabelsItem", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "generatedName": "NewsItemLabels", + "groupName": [], + "type": "array" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemCoverImageUrl", + "key": "cover_image_url", + "schema": { + "generatedName": "newsItemCoverImageUrl", + "title": "News Item", + "value": { + "generatedName": "NewsItemCoverImageUrl", + "description": "URL of the image used as cover. Must have .jpg or .png extension.", + "value": { + "description": "URL of the image used as cover. Must have .jpg or .png extension.", + "schema": { + "format": "uri", + "example": "https://example.com/cover.jpg", + "type": "string" + }, + "generatedName": "NewsItemCoverImageUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemReactions", + "key": "reactions", + "schema": { + "generatedName": "newsItemReactions", + "title": "News Item", + "value": { + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "value": { + "generatedName": "NewsItemReactionsItem", + "description": "The emoji reaction to the news item.", + "value": { + "description": "The emoji reaction to the news item.", + "schema": { + "example": "👍", + "type": "string" + }, + "generatedName": "NewsItemReactionsItem", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "generatedName": "NewsItemReactions", + "groupName": [], + "type": "array" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemDeliverSilently", + "key": "deliver_silently", + "schema": { + "generatedName": "newsItemDeliverSilently", + "title": "News Item", + "value": { + "description": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "NewsItemDeliverSilently", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "newsItemCreatedAt", + "title": "News Item", + "value": { + "description": "Timestamp for when the news item was created.", + "schema": { + "example": 1610589632, + "type": "int" + }, + "generatedName": "NewsItemCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "newsItemUpdatedAt", + "title": "News Item", + "value": { + "description": "Timestamp for when the news item was last updated.", + "schema": { + "example": 1610589632, + "type": "int" + }, + "generatedName": "NewsItemUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "generatedName": "NewsItem", + "title": "News Item", + "groupName": [ + "News" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "news_item_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "newsItemRequestTitle", + "key": "title", + "schema": { + "description": "The title of the news item.", + "schema": { + "example": "Halloween is here!", + "type": "string" + }, + "generatedName": "NewsItemRequestTitle", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestBody", + "key": "body", + "schema": { + "generatedName": "newsItemRequestBody", + "title": "Create News Item Request", + "value": { + "description": "The news item body, which may contain HTML.", + "schema": { + "example": "

New costumes in store for this spooky season

", + "type": "string" + }, + "generatedName": "NewsItemRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestSenderId", + "key": "sender_id", + "schema": { + "description": "The id of the sender of the news item. Must be a teammate on the workspace.", + "schema": { + "example": 123, + "type": "int" + }, + "generatedName": "NewsItemRequestSenderId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestState", + "key": "state", + "schema": { + "generatedName": "newsItemRequestState", + "title": "Create News Item Request", + "value": { + "description": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "generatedName": "NewsItemRequestState", + "values": [ + { + "generatedName": "draft", + "value": "draft", + "casing": {} + }, + { + "generatedName": "live", + "value": "live", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestDeliverSilently", + "key": "deliver_silently", + "schema": { + "generatedName": "newsItemRequestDeliverSilently", + "title": "Create News Item Request", + "value": { + "description": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "NewsItemRequestDeliverSilently", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestLabels", + "key": "labels", + "schema": { + "generatedName": "newsItemRequestLabels", + "title": "Create News Item Request", + "value": { + "description": "Label names displayed to users to categorize the news item.", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "NewsItemRequestLabelsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "NewsItemRequestLabels", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestReactions", + "key": "reactions", + "schema": { + "generatedName": "newsItemRequestReactions", + "title": "Create News Item Request", + "value": { + "description": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "value": { + "generatedName": "NewsItemRequestReactionsItem", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "NewsItemRequestReactionsItem", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "generatedName": "NewsItemRequestReactions", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsItemRequestNewsfeedAssignments", + "key": "newsfeed_assignments", + "schema": { + "generatedName": "newsItemRequestNewsfeedAssignments", + "title": "Create News Item Request", + "value": { + "description": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "value": { + "generatedName": "NewsItemRequestNewsfeedAssignmentsItem", + "schema": "newsfeed_assignment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "NewsItemRequestNewsfeedAssignments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "generatedName": "NewsItemRequest", + "title": "Create News Item Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "newsfeed": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "newsfeedId", + "key": "id", + "schema": { + "generatedName": "newsfeedId", + "nameOverride": "Newsfeed", + "title": "Newsfeed", + "value": { + "description": "The unique identifier for the newsfeed which is given by Intercom.", + "schema": { + "example": "12312", + "type": "string" + }, + "generatedName": "NewsfeedId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsfeedName", + "key": "name", + "schema": { + "generatedName": "newsfeedName", + "nameOverride": "Newsfeed", + "title": "Newsfeed", + "value": { + "description": "The name of the newsfeed. This name will never be visible to your users.", + "schema": { + "example": "My Newsfeed", + "type": "string" + }, + "generatedName": "NewsfeedName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsfeedCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "newsfeedCreatedAt", + "nameOverride": "Newsfeed", + "title": "Newsfeed", + "value": { + "description": "Timestamp for when the newsfeed was created.", + "schema": { + "example": 1674917488, + "type": "int" + }, + "generatedName": "NewsfeedCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsfeedUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "newsfeedUpdatedAt", + "nameOverride": "Newsfeed", + "title": "Newsfeed", + "value": { + "description": "Timestamp for when the newsfeed was last updated.", + "schema": { + "example": 1674917488, + "type": "int" + }, + "generatedName": "NewsfeedUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A newsfeed is a collection of news items, targeted to a specific audience.\n\nNewsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom.\n", + "generatedName": "Newsfeed", + "nameOverride": "Newsfeed", + "title": "Newsfeed", + "groupName": [ + "News" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "newsfeed_assignment": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "newsfeedAssignmentNewsfeedId", + "key": "newsfeed_id", + "schema": { + "generatedName": "newsfeedAssignmentNewsfeedId", + "title": "Newsfeed Assignment", + "value": { + "description": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", + "schema": { + "example": 198313, + "type": "int" + }, + "generatedName": "NewsfeedAssignmentNewsfeedId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "newsfeedAssignmentPublishedAt", + "key": "published_at", + "schema": { + "generatedName": "newsfeedAssignmentPublishedAt", + "title": "Newsfeed Assignment", + "value": { + "description": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is \"draft\".", + "schema": { + "example": 1674917488, + "type": "int" + }, + "generatedName": "NewsfeedAssignmentPublishedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "News" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Assigns a news item to a newsfeed.", + "generatedName": "NewsfeedAssignment", + "title": "Newsfeed Assignment", + "groupName": [ + "News" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "note": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "noteType", + "key": "type", + "schema": { + "generatedName": "noteType", + "nameOverride": "Note", + "title": "Note", + "value": { + "description": "String representing the object's type. Always has the value `note`.", + "schema": { + "example": "note", + "type": "string" + }, + "generatedName": "NoteType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteId", + "key": "id", + "schema": { + "generatedName": "noteId", + "nameOverride": "Note", + "title": "Note", + "value": { + "description": "The id of the note.", + "schema": { + "example": "17495962", + "type": "string" + }, + "generatedName": "NoteId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "noteCreatedAt", + "nameOverride": "Note", + "title": "Note", + "value": { + "description": "The time the note was created.", + "schema": { + "example": 1674589321, + "type": "int" + }, + "generatedName": "NoteCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteContact", + "key": "contact", + "schema": { + "generatedName": "noteContact", + "nameOverride": "Note", + "title": "Note", + "value": { + "generatedName": "NoteContact", + "description": "Represents the contact that the note was created about.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "noteContactType", + "key": "type", + "schema": { + "generatedName": "noteContactType", + "value": { + "description": "String representing the object's type. Always has the value `contact`.", + "schema": { + "type": "string" + }, + "generatedName": "NoteContactType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteContactId", + "key": "id", + "schema": { + "generatedName": "noteContactId", + "value": { + "description": "The id of the contact.", + "schema": { + "example": "214656d0c743eafcfde7f248", + "type": "string" + }, + "generatedName": "NoteContactId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Represents the contact that the note was created about.", + "generatedName": "NoteContact", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteAuthor", + "key": "author", + "schema": { + "generatedName": "noteAuthor", + "nameOverride": "Note", + "title": "Note", + "value": { + "description": "Optional. Represents the Admin that created the note.", + "generatedName": "NoteAuthor", + "schema": "admin", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "noteBody", + "key": "body", + "schema": { + "generatedName": "noteBody", + "nameOverride": "Note", + "title": "Note", + "value": { + "description": "The body text of the note.", + "schema": { + "example": "

Text for the note.

", + "type": "string" + }, + "generatedName": "NoteBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Notes" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Notes allow you to annotate and comment on your contacts.", + "generatedName": "Note", + "nameOverride": "Note", + "title": "Note", + "groupName": [ + "Notes" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "note_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "noteListType", + "key": "type", + "schema": { + "generatedName": "noteListType", + "title": "Paginated Response", + "value": { + "description": "String representing the object's type. Always has the value `list`.", + "schema": { + "example": "list", + "type": "string" + }, + "generatedName": "NoteListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteListData", + "key": "data", + "schema": { + "generatedName": "noteListData", + "title": "Paginated Response", + "value": { + "description": "An array of notes.", + "value": { + "generatedName": "NoteListDataItem", + "schema": "note", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "NoteListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "noteListTotalCount", + "title": "Paginated Response", + "value": { + "description": "A count of the total number of notes.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "NoteListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "noteListPages", + "key": "pages", + "schema": { + "generatedName": "noteListPages", + "title": "Paginated Response", + "value": { + "generatedName": "NoteListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "A paginated list of notes associated with a contact.", + "generatedName": "NoteList", + "title": "Paginated Response", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "open_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "openConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is performing the action.", + "schema": { + "example": "5017690", + "type": "string" + }, + "generatedName": "OpenConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to open a conversation", + "generatedName": "OpenConversationRequest", + "title": "Open Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "pages_link": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "pagesLinkType", + "key": "type", + "schema": { + "generatedName": "pagesLinkType", + "title": "Pagination Object", + "value": { + "value": { + "value": "pages", + "type": "string" + }, + "generatedName": "PagesLinkType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "pagesLinkPage", + "key": "page", + "schema": { + "generatedName": "pagesLinkPage", + "title": "Pagination Object", + "value": { + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "PagesLinkPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "pagesLinkNext", + "key": "next", + "schema": { + "generatedName": "pagesLinkNext", + "title": "Pagination Object", + "value": { + "generatedName": "PagesLinkNext", + "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", + "value": { + "description": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", + "schema": { + "format": "uri", + "type": "string" + }, + "generatedName": "PagesLinkNext", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "pagesLinkPerPage", + "key": "per_page", + "schema": { + "generatedName": "pagesLinkPerPage", + "title": "Pagination Object", + "value": { + "schema": { + "example": 50, + "type": "int" + }, + "generatedName": "PagesLinkPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "pagesLinkTotalPages", + "key": "total_pages", + "schema": { + "generatedName": "pagesLinkTotalPages", + "title": "Pagination Object", + "value": { + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "PagesLinkTotalPages", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.\n\nTheir responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.\n", + "generatedName": "PagesLink", + "title": "Pagination Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "paginated_response": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "paginatedResponseType", + "key": "type", + "schema": { + "generatedName": "paginatedResponseType", + "title": "Paginated Response", + "value": { + "description": "The type of object", + "generatedName": "PaginatedResponseType", + "values": [ + { + "generatedName": "list", + "value": "list", + "casing": {} + }, + { + "generatedName": "ConversationList", + "value": "conversation.list", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "paginatedResponsePages", + "key": "pages", + "schema": { + "generatedName": "paginatedResponsePages", + "title": "Paginated Response", + "value": { + "generatedName": "PaginatedResponsePages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "paginatedResponseTotalCount", + "key": "total_count", + "schema": { + "generatedName": "paginatedResponseTotalCount", + "title": "Paginated Response", + "value": { + "description": "A count of the total number of objects.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "PaginatedResponseTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "paginatedResponseData", + "key": "data", + "schema": { + "generatedName": "paginatedResponseData", + "title": "Paginated Response", + "value": { + "description": "An array of Objects", + "value": { + "value": { + "commonProperties": [], + "discriminantProperty": "type", + "generatedName": "PaginatedResponseDataItem", + "schemas": { + "news-item": { + "generatedName": "ComponentsSchemasNewsItem", + "schema": "news_item", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "newsfeed": { + "generatedName": "ComponentsSchemasNewsfeed", + "schema": "newsfeed", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + }, + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "generatedName": "PaginatedResponseData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Paginated Response", + "generatedName": "PaginatedResponse", + "title": "Paginated Response", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "part_attachment": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "partAttachmentType", + "key": "type", + "schema": { + "generatedName": "partAttachmentType", + "title": "Part attachment", + "value": { + "description": "The type of attachment", + "schema": { + "example": "upload", + "type": "string" + }, + "generatedName": "PartAttachmentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentName", + "key": "name", + "schema": { + "generatedName": "partAttachmentName", + "title": "Part attachment", + "value": { + "description": "The name of the attachment", + "schema": { + "example": "example.png", + "type": "string" + }, + "generatedName": "PartAttachmentName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentUrl", + "key": "url", + "schema": { + "generatedName": "partAttachmentUrl", + "title": "Part attachment", + "value": { + "description": "The URL of the attachment", + "schema": { + "example": "https://picsum.photos/200/300", + "type": "string" + }, + "generatedName": "PartAttachmentUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentContentType", + "key": "content_type", + "schema": { + "generatedName": "partAttachmentContentType", + "title": "Part attachment", + "value": { + "description": "The content type of the attachment", + "schema": { + "example": "image/png", + "type": "string" + }, + "generatedName": "PartAttachmentContentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentFilesize", + "key": "filesize", + "schema": { + "generatedName": "partAttachmentFilesize", + "title": "Part attachment", + "value": { + "description": "The size of the attachment", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "PartAttachmentFilesize", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentWidth", + "key": "width", + "schema": { + "generatedName": "partAttachmentWidth", + "title": "Part attachment", + "value": { + "description": "The width of the attachment", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "PartAttachmentWidth", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "partAttachmentHeight", + "key": "height", + "schema": { + "generatedName": "partAttachmentHeight", + "title": "Part attachment", + "value": { + "description": "The height of the attachment", + "schema": { + "example": 100, + "type": "int" + }, + "generatedName": "PartAttachmentHeight", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The file attached to a part", + "generatedName": "PartAttachment", + "title": "Part attachment", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "phone_switch": { + "generatedName": "PhoneSwitch", + "title": "Phone Switch", + "description": "Phone Switch Response", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "phoneSwitchType", + "key": "type", + "schema": { + "generatedName": "phoneSwitchType", + "title": "Phone Switch", + "value": { + "description": "", + "value": { + "value": "phone_call_redirect", + "type": "string" + }, + "generatedName": "PhoneSwitchType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "phoneSwitchPhone", + "key": "phone", + "schema": { + "generatedName": "phoneSwitchPhone", + "title": "Phone Switch", + "value": { + "description": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", + "schema": { + "example": "+1 1234567890", + "type": "string" + }, + "generatedName": "PhoneSwitchPhone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Phone Switch Response", + "generatedName": "PhoneSwitch", + "title": "Phone Switch", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "redact_conversation_request": { + "value": { + "commonProperties": [], + "discriminantProperty": "type", + "generatedName": "RedactConversationRequest", + "schemas": { + "conversation_part": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "redactConversationRequestConversationPartConversationId", + "key": "conversation_id", + "schema": { + "description": "The id of the conversation.", + "schema": { + "example": "19894788788", + "type": "string" + }, + "generatedName": "RedactConversationRequestConversationPartConversationId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "redactConversationRequestConversationPartConversationPartId", + "key": "conversation_part_id", + "schema": { + "description": "The id of the conversation_part.", + "schema": { + "example": "19381789428", + "type": "string" + }, + "generatedName": "RedactConversationRequestConversationPartConversationPartId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to redact a conversation part", + "generatedName": "RedactConversationRequestConversationPart", + "title": "Redact Conversation Part Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "source": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "redactConversationRequestSourceConversationId", + "key": "conversation_id", + "schema": { + "description": "The id of the conversation.", + "schema": { + "example": "19894788788", + "type": "string" + }, + "generatedName": "RedactConversationRequestSourceConversationId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "redactConversationRequestSourceSourceId", + "key": "source_id", + "schema": { + "description": "The id of the source.", + "schema": { + "example": "19894781231", + "type": "string" + }, + "generatedName": "RedactConversationRequestSourceSourceId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to redact a conversation source", + "generatedName": "RedactConversationRequestSource", + "title": "Redact Conversation Source Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + }, + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "discriminated" + }, + "type": "oneOf" + }, + "reference": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "referenceType", + "key": "type", + "schema": { + "generatedName": "referenceType", + "nameOverride": "Reference", + "title": "Reference", + "value": { + "description": "", + "schema": { + "example": "contact", + "type": "string" + }, + "generatedName": "ReferenceType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "referenceId", + "key": "id", + "schema": { + "generatedName": "referenceId", + "nameOverride": "Reference", + "title": "Reference", + "value": { + "generatedName": "ReferenceId", + "description": "", + "value": { + "description": "", + "schema": { + "example": "1a2b3c", + "type": "string" + }, + "generatedName": "ReferenceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "reference to another object", + "generatedName": "Reference", + "nameOverride": "Reference", + "title": "Reference", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "reply_conversation_request": { + "value": { + "generatedName": "ReplyConversationRequest", + "schemas": [ + { + "generatedName": "ReplyConversationRequestZero", + "schema": "contact_reply_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "ReplyConversationRequestOne", + "schema": "admin_reply_conversation_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "search_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "searchRequestQuery", + "key": "query", + "schema": { + "value": { + "generatedName": "SearchRequestQuery", + "schemas": [ + { + "generatedName": "SearchRequestQueryZero", + "schema": "single_filter_search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + { + "generatedName": "SearchRequestQueryOne", + "schema": "multiple_filter_search_request", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "searchRequestPagination", + "key": "pagination", + "schema": { + "generatedName": "searchRequestPagination", + "title": "Search data", + "value": { + "generatedName": "SearchRequestPagination", + "schema": "starting_after_paging", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Search using Intercoms Search APIs.", + "generatedName": "SearchRequest", + "title": "Search data", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "segment": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "segmentType", + "key": "type", + "schema": { + "generatedName": "segmentType", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "The type of object.", + "value": { + "value": "segment", + "type": "string" + }, + "generatedName": "SegmentType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentId", + "key": "id", + "schema": { + "generatedName": "segmentId", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "The unique identifier representing the segment.", + "schema": { + "example": "56203d253cba154d39010062", + "type": "string" + }, + "generatedName": "SegmentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentName", + "key": "name", + "schema": { + "generatedName": "segmentName", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "The name of the segment.", + "schema": { + "example": "Active", + "type": "string" + }, + "generatedName": "SegmentName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "segmentCreatedAt", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "The time the segment was created.", + "schema": { + "example": 1394621988, + "type": "int" + }, + "generatedName": "SegmentCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "segmentUpdatedAt", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "The time the segment was updated.", + "schema": { + "example": 1394622004, + "type": "int" + }, + "generatedName": "SegmentUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentPersonType", + "key": "person_type", + "schema": { + "generatedName": "segmentPersonType", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "description": "Type of the contact: contact (lead) or user.", + "generatedName": "SegmentPersonType", + "values": [ + { + "generatedName": "contact", + "value": "contact", + "casing": {} + }, + { + "generatedName": "user", + "value": "user", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentCount", + "key": "count", + "schema": { + "generatedName": "segmentCount", + "nameOverride": "Segment", + "title": "Segment", + "value": { + "generatedName": "SegmentCount", + "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", + "value": { + "description": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", + "schema": { + "example": 3, + "type": "int" + }, + "generatedName": "SegmentCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Segments" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A segment is a group of your contacts defined by the rules that you set.", + "generatedName": "Segment", + "nameOverride": "Segment", + "title": "Segment", + "groupName": [ + "Segments" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "segment_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "segmentListType", + "key": "type", + "schema": { + "generatedName": "segmentListType", + "title": "Segment List", + "value": { + "description": "The type of the object", + "value": { + "value": "segment.list", + "type": "string" + }, + "generatedName": "SegmentListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentListSegments", + "key": "segments", + "schema": { + "generatedName": "segmentListSegments", + "title": "Segment List", + "value": { + "description": "A list of Segment objects", + "value": { + "generatedName": "SegmentListSegmentsItem", + "schema": "segment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "SegmentListSegments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "segmentListPages", + "key": "pages", + "schema": { + "generatedName": "segmentListPages", + "title": "Segment List", + "value": { + "description": "A pagination object, which may be empty, indicating no further pages to fetch.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "SegmentListPagesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "generatedName": "SegmentListPagesValue", + "type": "unknown" + }, + "generatedName": "SegmentListPages", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "generatedName": "SegmentList", + "title": "Segment List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "single_filter_search_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "singleFilterSearchRequestField", + "key": "field", + "schema": { + "generatedName": "singleFilterSearchRequestField", + "title": "Single Filter Search Request", + "value": { + "description": "The accepted field that you want to search on.", + "schema": { + "example": "created_at", + "type": "string" + }, + "generatedName": "SingleFilterSearchRequestField", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "singleFilterSearchRequestOperator", + "key": "operator", + "schema": { + "generatedName": "singleFilterSearchRequestOperator", + "title": "Single Filter Search Request", + "value": { + "description": "The accepted operators you can use to define how you want to search for the value.", + "generatedName": "SingleFilterSearchRequestOperator", + "values": [ + { + "generatedName": "EQUAL_TO", + "value": "=", + "casing": {} + }, + { + "generatedName": "NOT_EQUALS", + "value": "!=", + "casing": {} + }, + { + "generatedName": "IN", + "value": "IN", + "casing": {} + }, + { + "generatedName": "NIN", + "value": "NIN", + "casing": {} + }, + { + "generatedName": "LESS_THAN", + "value": "<", + "casing": {} + }, + { + "generatedName": "GREATER_THAN", + "value": ">", + "casing": {} + }, + { + "generatedName": "", + "value": "~", + "casing": {} + }, + { + "generatedName": "", + "value": "!~", + "casing": {} + }, + { + "generatedName": "", + "value": "^", + "casing": {} + }, + { + "generatedName": "", + "value": "$", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "singleFilterSearchRequestValue", + "key": "value", + "schema": { + "generatedName": "singleFilterSearchRequestValue", + "title": "Single Filter Search Request", + "value": { + "description": "The value that you want to search on.", + "schema": { + "example": "73732934", + "type": "string" + }, + "generatedName": "SingleFilterSearchRequestValue", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Search using Intercoms Search APIs with a single filter.", + "generatedName": "SingleFilterSearchRequest", + "title": "Single Filter Search Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "sla_applied": { + "generatedName": "SlaApplied", + "title": "Applied SLA", + "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "slaAppliedType", + "key": "type", + "schema": { + "generatedName": "slaAppliedType", + "title": "Applied SLA", + "value": { + "description": "object type", + "schema": { + "example": "conversation_sla_summary", + "type": "string" + }, + "generatedName": "SlaAppliedType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "slaAppliedSlaName", + "key": "sla_name", + "schema": { + "generatedName": "slaAppliedSlaName", + "title": "Applied SLA", + "value": { + "description": "The name of the SLA as given by the teammate when it was created.", + "schema": { + "example": "", + "type": "string" + }, + "generatedName": "SlaAppliedSlaName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "slaAppliedSlaStatus", + "key": "sla_status", + "schema": { + "generatedName": "slaAppliedSlaStatus", + "title": "Applied SLA", + "value": { + "description": "SLA statuses:\n - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.\n - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.\n - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", + "generatedName": "SlaAppliedSlaStatus", + "values": [ + { + "generatedName": "hit", + "value": "hit", + "casing": {} + }, + { + "generatedName": "missed", + "value": "missed", + "casing": {} + }, + { + "generatedName": "cancelled", + "value": "cancelled", + "casing": {} + }, + { + "generatedName": "active", + "value": "active", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The SLA Applied object contains the details for which SLA has been applied to this conversation.\nImportant: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.\n", + "generatedName": "SlaApplied", + "title": "Applied SLA", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "snooze_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "snoozeConversationRequestAdminId", + "key": "admin_id", + "schema": { + "description": "The id of the admin who is performing the action.", + "schema": { + "example": "5017691", + "type": "string" + }, + "generatedName": "SnoozeConversationRequestAdminId", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "snoozeConversationRequestSnoozedUntil", + "key": "snoozed_until", + "schema": { + "description": "The time you want the conversation to reopen.", + "schema": { + "example": 1673609604, + "type": "int" + }, + "generatedName": "SnoozeConversationRequestSnoozedUntil", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to snooze a conversation", + "generatedName": "SnoozeConversationRequest", + "title": "Snooze Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "social_profile": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "socialProfileType", + "key": "type", + "schema": { + "generatedName": "socialProfileType", + "title": "Social Profile", + "value": { + "description": "value is \"social_profile\"", + "schema": { + "example": "social_profile", + "type": "string" + }, + "generatedName": "SocialProfileType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "socialProfileName", + "key": "name", + "schema": { + "generatedName": "socialProfileName", + "title": "Social Profile", + "value": { + "description": "The name of the Social media profile", + "schema": { + "example": "Facebook", + "type": "string" + }, + "generatedName": "SocialProfileName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "socialProfileUrl", + "key": "url", + "schema": { + "generatedName": "socialProfileUrl", + "title": "Social Profile", + "value": { + "description": "The name of the Social media profile", + "schema": { + "format": "uri", + "example": "http://twitter.com/th1sland", + "type": "string" + }, + "generatedName": "SocialProfileUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "generatedName": "SocialProfile", + "title": "Social Profile", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "starting_after_paging": { + "generatedName": "StartingAfterPaging", + "title": "Pagination: Starting After", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "startingAfterPagingPerPage", + "key": "per_page", + "schema": { + "generatedName": "startingAfterPagingPerPage", + "title": "Pagination: Starting After", + "value": { + "description": "The number of results to fetch per page.", + "schema": { + "example": 2, + "type": "int" + }, + "generatedName": "StartingAfterPagingPerPage", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "startingAfterPagingStartingAfter", + "key": "starting_after", + "schema": { + "generatedName": "startingAfterPagingStartingAfter", + "title": "Pagination: Starting After", + "value": { + "generatedName": "StartingAfterPagingStartingAfter", + "description": "The cursor to use in the next request to get the next page of results.", + "value": { + "description": "The cursor to use in the next request to get the next page of results.", + "schema": { + "example": "your-cursor-from-response", + "type": "string" + }, + "generatedName": "StartingAfterPagingStartingAfter", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "StartingAfterPaging", + "title": "Pagination: Starting After", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "subscription_type": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "subscriptionTypeType", + "key": "type", + "schema": { + "generatedName": "subscriptionTypeType", + "title": "Subscription Types", + "value": { + "description": "The type of the object - subscription", + "schema": { + "example": "subscription", + "type": "string" + }, + "generatedName": "SubscriptionTypeType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeId", + "key": "id", + "schema": { + "generatedName": "subscriptionTypeId", + "title": "Subscription Types", + "value": { + "description": "The unique identifier representing the subscription type.", + "schema": { + "example": "123456", + "type": "string" + }, + "generatedName": "SubscriptionTypeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeState", + "key": "state", + "schema": { + "generatedName": "subscriptionTypeState", + "title": "Subscription Types", + "value": { + "description": "The state of the subscription type.", + "generatedName": "SubscriptionTypeState", + "values": [ + { + "generatedName": "live", + "value": "live", + "casing": {} + }, + { + "generatedName": "draft", + "value": "draft", + "casing": {} + }, + { + "generatedName": "archived", + "value": "archived", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeDefaultTranslation", + "key": "default_translation", + "schema": { + "generatedName": "subscriptionTypeDefaultTranslation", + "title": "Subscription Types", + "value": { + "generatedName": "SubscriptionTypeDefaultTranslation", + "schema": "translation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeTranslations", + "key": "translations", + "schema": { + "generatedName": "subscriptionTypeTranslations", + "title": "Subscription Types", + "value": { + "description": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.", + "value": { + "generatedName": "SubscriptionTypeTranslationsItem", + "schema": "translation", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "SubscriptionTypeTranslations", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeConsentType", + "key": "consent_type", + "schema": { + "generatedName": "subscriptionTypeConsentType", + "title": "Subscription Types", + "value": { + "description": "Describes the type of consent.", + "generatedName": "SubscriptionTypeConsentType", + "values": [ + { + "generatedName": "opt_out", + "value": "opt_out", + "casing": {} + }, + { + "generatedName": "opt_in", + "value": "opt_in", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeContentTypes", + "key": "content_types", + "schema": { + "generatedName": "subscriptionTypeContentTypes", + "title": "Subscription Types", + "value": { + "description": "The message types that this subscription supports - can contain `email` or `sms_message`.", + "value": { + "generatedName": "SubscriptionTypeContentTypesItem", + "values": [ + { + "generatedName": "email", + "value": "email", + "casing": {} + }, + { + "generatedName": "sms_message", + "value": "sms_message", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "generatedName": "SubscriptionTypeContentTypes", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Subscription Types" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "generatedName": "SubscriptionType", + "title": "Subscription Types", + "groupName": [ + "Subscription Types" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "subscription_type_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "subscriptionTypeListType", + "key": "type", + "schema": { + "generatedName": "subscriptionTypeListType", + "title": "Subscription Types", + "value": { + "description": "The type of the object", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "SubscriptionTypeListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "subscriptionTypeListData", + "key": "data", + "schema": { + "generatedName": "subscriptionTypeListData", + "title": "Subscription Types", + "value": { + "description": "A list of subscription type objects associated with the workspace .", + "value": { + "generatedName": "SubscriptionTypeListDataItem", + "schema": "subscription_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "SubscriptionTypeListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of subscription type objects.", + "generatedName": "SubscriptionTypeList", + "title": "Subscription Types", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "tag": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagType", + "key": "type", + "schema": { + "generatedName": "tagType", + "nameOverride": "Tag", + "title": "Tag", + "value": { + "description": "value is \"tag\"", + "schema": { + "example": "tag", + "type": "string" + }, + "generatedName": "TagType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tags" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagId", + "key": "id", + "schema": { + "generatedName": "tagId", + "nameOverride": "Tag", + "title": "Tag", + "value": { + "description": "The id of the tag", + "schema": { + "example": "123456", + "type": "string" + }, + "generatedName": "TagId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tags" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagName", + "key": "name", + "schema": { + "generatedName": "tagName", + "nameOverride": "Tag", + "title": "Tag", + "value": { + "description": "The name of the tag", + "schema": { + "example": "Test tag", + "type": "string" + }, + "generatedName": "TagName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tags" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagAppliedAt", + "key": "applied_at", + "schema": { + "generatedName": "tagAppliedAt", + "nameOverride": "Tag", + "title": "Tag", + "value": { + "description": "The time when the tag was applied to the object", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "TagAppliedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tags" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagAppliedBy", + "key": "applied_by", + "schema": { + "generatedName": "tagAppliedBy", + "nameOverride": "Tag", + "title": "Tag", + "value": { + "generatedName": "TagAppliedBy", + "schema": "reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tags" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "generatedName": "Tag", + "nameOverride": "Tag", + "title": "Tag", + "groupName": [ + "Tags" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "tag_company_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagCompanyRequestName", + "key": "name", + "schema": { + "description": "The name of the tag, which will be created if not found.", + "schema": { + "example": "Independent", + "type": "string" + }, + "generatedName": "TagCompanyRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagCompanyRequestCompanies", + "key": "companies", + "schema": { + "description": "The id or company_id of the company can be passed as input parameters.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagCompanyRequestCompaniesItemId", + "key": "id", + "schema": { + "generatedName": "tagCompanyRequestCompaniesItemId", + "value": { + "description": "The Intercom defined id representing the company.", + "schema": { + "example": "531ee472cce572a6ec000006", + "type": "string" + }, + "generatedName": "TagCompanyRequestCompaniesItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagCompanyRequestCompaniesItemCompanyId", + "key": "company_id", + "schema": { + "generatedName": "tagCompanyRequestCompaniesItemCompanyId", + "value": { + "description": "The company id you have defined for the company.", + "schema": { + "example": "6", + "type": "string" + }, + "generatedName": "TagCompanyRequestCompaniesItemCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "TagCompanyRequestCompaniesItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "TagCompanyRequestCompanies", + "groupName": [], + "type": "array" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can tag a single company or a list of companies.", + "generatedName": "TagCompanyRequest", + "title": "Tag Company Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "tag_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagListType", + "key": "type", + "schema": { + "generatedName": "tagListType", + "nameOverride": "Tags", + "title": "Tags", + "value": { + "description": "The type of the object", + "value": { + "value": "list", + "type": "string" + }, + "generatedName": "TagListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagListData", + "key": "data", + "schema": { + "generatedName": "tagListData", + "nameOverride": "Tags", + "title": "Tags", + "value": { + "description": "A list of tags objects associated with the workspace .", + "value": { + "generatedName": "TagListDataItem", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TagListData", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of tags objects in the workspace.", + "generatedName": "TagList", + "nameOverride": "Tags", + "title": "Tags", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "tag_multiple_users_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagMultipleUsersRequestName", + "key": "name", + "schema": { + "description": "The name of the tag, which will be created if not found.", + "schema": { + "example": "Independent", + "type": "string" + }, + "generatedName": "TagMultipleUsersRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagMultipleUsersRequestUsers", + "key": "users", + "schema": { + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagMultipleUsersRequestUsersItemId", + "key": "id", + "schema": { + "generatedName": "tagMultipleUsersRequestUsersItemId", + "value": { + "description": "The Intercom defined id representing the user.", + "schema": { + "example": "5f7f0d217289f8d2f4262080", + "type": "string" + }, + "generatedName": "TagMultipleUsersRequestUsersItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "TagMultipleUsersRequestUsersItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "TagMultipleUsersRequestUsers", + "groupName": [], + "type": "array" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can tag a list of users.", + "generatedName": "TagMultipleUsersRequest", + "title": "Tag Users Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "tags": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "tagsType", + "key": "type", + "schema": { + "generatedName": "tagsType", + "nameOverride": "Tags", + "title": "Tags", + "value": { + "description": "The type of the object", + "value": { + "value": "tag.list", + "type": "string" + }, + "generatedName": "TagsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "tagsTags", + "key": "tags", + "schema": { + "generatedName": "tagsTags", + "nameOverride": "Tags", + "title": "Tags", + "value": { + "description": "A list of tags objects associated with the conversation.", + "value": { + "generatedName": "TagsTagsItem", + "schema": "tag", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TagsTags", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of tags objects associated with a conversation", + "generatedName": "Tags", + "nameOverride": "Tags", + "title": "Tags", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "team": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "teamType", + "key": "type", + "schema": { + "generatedName": "teamType", + "nameOverride": "Team", + "title": "Team", + "value": { + "description": "Value is always \"team\"", + "schema": { + "example": "team", + "type": "string" + }, + "generatedName": "TeamType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Teams" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamId", + "key": "id", + "schema": { + "generatedName": "teamId", + "nameOverride": "Team", + "title": "Team", + "value": { + "description": "The id of the team", + "schema": { + "example": "814865", + "type": "string" + }, + "generatedName": "TeamId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Teams" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamName", + "key": "name", + "schema": { + "generatedName": "teamName", + "nameOverride": "Team", + "title": "Team", + "value": { + "description": "The name of the team", + "schema": { + "example": "Example Team", + "type": "string" + }, + "generatedName": "TeamName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Teams" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamAdminIds", + "key": "admin_ids", + "schema": { + "generatedName": "teamAdminIds", + "nameOverride": "Team", + "title": "Team", + "value": { + "description": "The list of admin IDs that are a part of the team.", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "TeamAdminIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "TeamAdminIds", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Teams" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamAdminPriorityLevel", + "key": "admin_priority_level", + "schema": { + "generatedName": "teamAdminPriorityLevel", + "nameOverride": "Team", + "title": "Team", + "value": { + "generatedName": "TeamAdminPriorityLevel", + "schema": "admin_priority_level", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Teams" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Teams are groups of admins in Intercom.", + "generatedName": "Team", + "nameOverride": "Team", + "title": "Team", + "groupName": [ + "Teams" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "team_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "teamListType", + "key": "type", + "schema": { + "generatedName": "teamListType", + "title": "Team List", + "value": { + "description": "The type of the object", + "value": { + "value": "team.list", + "type": "string" + }, + "generatedName": "TeamListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamListTeams", + "key": "teams", + "schema": { + "generatedName": "teamListTeams", + "title": "Team List", + "value": { + "description": "A list of team objects", + "value": { + "generatedName": "TeamListTeamsItem", + "schema": "team", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TeamListTeams", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "This will return a list of team objects for the App.", + "generatedName": "TeamList", + "title": "Team List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "team_priority_level": { + "generatedName": "TeamPriorityLevel", + "title": "Team Priority Level", + "description": "Admin priority levels for teams", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "teamPriorityLevelPrimaryTeamIds", + "key": "primary_team_ids", + "schema": { + "generatedName": "teamPriorityLevelPrimaryTeamIds", + "title": "Team Priority Level", + "value": { + "generatedName": "TeamPriorityLevelPrimaryTeamIds", + "description": "The primary team ids for the team", + "value": { + "description": "The primary team ids for the team", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "TeamPriorityLevelPrimaryTeamIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "TeamPriorityLevelPrimaryTeamIds", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "teamPriorityLevelSecondaryTeamIds", + "key": "secondary_team_ids", + "schema": { + "generatedName": "teamPriorityLevelSecondaryTeamIds", + "title": "Team Priority Level", + "value": { + "generatedName": "TeamPriorityLevelSecondaryTeamIds", + "description": "The secondary team ids for the team", + "value": { + "description": "The secondary team ids for the team", + "value": { + "schema": { + "type": "int" + }, + "generatedName": "TeamPriorityLevelSecondaryTeamIdsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "TeamPriorityLevelSecondaryTeamIds", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Admin priority levels for teams", + "generatedName": "TeamPriorityLevel", + "title": "Team Priority Level", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "ticket": { + "generatedName": "Ticket", + "nameOverride": "Ticket", + "title": "Ticket", + "description": "Tickets are how you track requests from your users.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketType", + "key": "type", + "schema": { + "generatedName": "ticketType", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "Always ticket", + "value": { + "value": "ticket", + "type": "string" + }, + "generatedName": "TicketType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketId", + "key": "id", + "schema": { + "generatedName": "ticketId", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The unique identifier for the ticket which is given by Intercom.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "TicketId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTicketId", + "key": "ticket_id", + "schema": { + "generatedName": "ticketTicketId", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.", + "schema": { + "example": "1390", + "type": "string" + }, + "generatedName": "TicketTicketId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketCategory", + "key": "category", + "schema": { + "generatedName": "ticketCategory", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "Category of the Ticket.", + "generatedName": "TicketCategory", + "values": [ + { + "generatedName": "Customer", + "value": "Customer", + "casing": {} + }, + { + "generatedName": "BackOffice", + "value": "Back-office", + "casing": {} + }, + { + "generatedName": "Tracker", + "value": "Tracker", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTicketAttributes", + "key": "ticket_attributes", + "schema": { + "generatedName": "ticketTicketAttributes", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "generatedName": "TicketTicketAttributes", + "schema": "ticket_custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketTicketState", + "key": "ticket_state", + "schema": { + "generatedName": "ticketTicketState", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The state the ticket is currently in", + "generatedName": "TicketTicketState", + "values": [ + { + "generatedName": "submitted", + "value": "submitted", + "casing": {} + }, + { + "generatedName": "in_progress", + "value": "in_progress", + "casing": {} + }, + { + "generatedName": "waiting_on_customer", + "value": "waiting_on_customer", + "casing": {} + }, + { + "generatedName": "resolved", + "value": "resolved", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTicketType", + "key": "ticket_type", + "schema": { + "generatedName": "ticketTicketType", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "generatedName": "TicketTicketType", + "schema": "ticket_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketContacts", + "key": "contacts", + "schema": { + "generatedName": "ticketContacts", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "generatedName": "TicketContacts", + "schema": "ticket_contacts", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketAdminAssigneeId", + "key": "admin_assignee_id", + "schema": { + "generatedName": "ticketAdminAssigneeId", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The id representing the admin assigned to the ticket.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "TicketAdminAssigneeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTeamAssigneeId", + "key": "team_assignee_id", + "schema": { + "generatedName": "ticketTeamAssigneeId", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The id representing the team assigned to the ticket.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "TicketTeamAssigneeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "ticketCreatedAt", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The time the ticket was created as a UTC Unix timestamp.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "TicketCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "ticketUpdatedAt", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The last time the ticket was updated as a UTC Unix timestamp.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "TicketUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketOpen", + "key": "open", + "schema": { + "generatedName": "ticketOpen", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "Whether or not the ticket is open. If false, the ticket is closed.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "TicketOpen", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketSnoozedUntil", + "key": "snoozed_until", + "schema": { + "generatedName": "ticketSnoozedUntil", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "TicketSnoozedUntil", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketLinkedObjects", + "key": "linked_objects", + "schema": { + "generatedName": "ticketLinkedObjects", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "generatedName": "TicketLinkedObjects", + "schema": "linked_object_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketTicketParts", + "key": "ticket_parts", + "schema": { + "generatedName": "ticketTicketParts", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "generatedName": "TicketTicketParts", + "schema": "ticket_parts", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketIsShared", + "key": "is_shared", + "schema": { + "generatedName": "ticketIsShared", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "Whether or not the ticket is shared with the customer.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "TicketIsShared", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTicketStateInternalLabel", + "key": "ticket_state_internal_label", + "schema": { + "generatedName": "ticketTicketStateInternalLabel", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The state the ticket is currently in, in a human readable form - visible in Intercom", + "schema": { + "type": "string" + }, + "generatedName": "TicketTicketStateInternalLabel", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTicketStateExternalLabel", + "key": "ticket_state_external_label", + "schema": { + "generatedName": "ticketTicketStateExternalLabel", + "nameOverride": "Ticket", + "title": "Ticket", + "value": { + "description": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.", + "schema": { + "type": "string" + }, + "generatedName": "TicketTicketStateExternalLabel", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Tickets are how you track requests from your users.", + "generatedName": "Ticket", + "nameOverride": "Ticket", + "title": "Ticket", + "groupName": [ + "Tickets" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Tickets" + ], + "type": "nullable" + }, + "ticket_contacts": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketContactsType", + "key": "type", + "schema": { + "generatedName": "ticketContactsType", + "nameOverride": "Contacts", + "title": "Contacts", + "value": { + "description": "always contact.list", + "value": { + "value": "contact.list", + "type": "string" + }, + "generatedName": "TicketContactsType", + "groupName": [], + "type": "literal" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketContactsContacts", + "key": "contacts", + "schema": { + "generatedName": "ticketContactsContacts", + "nameOverride": "Contacts", + "title": "Contacts", + "value": { + "description": "The list of contacts affected by this ticket.", + "value": { + "generatedName": "TicketContactsContactsItem", + "schema": "contact_reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketContactsContacts", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The list of contacts affected by a ticket.", + "generatedName": "TicketContacts", + "nameOverride": "Contacts", + "title": "Contacts", + "groupName": [ + "Tickets" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_custom_attributes": { + "description": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "TicketCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "value": { + "generatedName": "TicketCustomAttributesValue", + "schemas": [ + { + "generatedName": "TicketCustomAttributesValue", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "TicketCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + { + "schema": { + "type": "double" + }, + "generatedName": "TicketCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + { + "schema": { + "type": "boolean" + }, + "generatedName": "TicketCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + { + "value": { + "generatedName": "TicketCustomAttributesValue", + "type": "unknown" + }, + "generatedName": "TicketCustomAttributesValue", + "groupName": [], + "type": "array" + }, + { + "generatedName": "TicketCustomAttributesValueFour", + "schema": "file_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "generatedName": "TicketCustomAttributes", + "title": "Ticket Attributes", + "groupName": [], + "type": "map" + }, + "ticket_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketListType", + "key": "type", + "schema": { + "generatedName": "ticketListType", + "title": "Ticket List", + "value": { + "description": "Always ticket.list", + "value": { + "value": "ticket.list", + "type": "string" + }, + "generatedName": "TicketListType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketListTickets", + "key": "tickets", + "schema": { + "generatedName": "ticketListTickets", + "title": "Ticket List", + "value": { + "description": "The list of ticket objects", + "value": { + "generatedName": "TicketListTicketsItem", + "schema": "ticket", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketListTickets", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketListTotalCount", + "key": "total_count", + "schema": { + "generatedName": "ticketListTotalCount", + "title": "Ticket List", + "value": { + "description": "A count of the total number of objects.", + "schema": { + "example": 12345, + "type": "int" + }, + "generatedName": "TicketListTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketListPages", + "key": "pages", + "schema": { + "generatedName": "ticketListPages", + "title": "Ticket List", + "value": { + "generatedName": "TicketListPages", + "schema": "cursor_pages", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Tickets are how you track requests from your users.", + "generatedName": "TicketList", + "title": "Ticket List", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_part": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketPartType", + "key": "type", + "schema": { + "generatedName": "ticketPartType", + "title": "Ticket Part", + "value": { + "description": "Always ticket_part", + "schema": { + "example": "ticket_part", + "type": "string" + }, + "generatedName": "TicketPartType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartId", + "key": "id", + "schema": { + "generatedName": "ticketPartId", + "title": "Ticket Part", + "value": { + "description": "The id representing the ticket part.", + "schema": { + "example": "3", + "type": "string" + }, + "generatedName": "TicketPartId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartPartType", + "key": "part_type", + "schema": { + "generatedName": "ticketPartPartType", + "title": "Ticket Part", + "value": { + "description": "The type of ticket part.", + "schema": { + "example": "comment", + "type": "string" + }, + "generatedName": "TicketPartPartType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartBody", + "key": "body", + "schema": { + "generatedName": "ticketPartBody", + "title": "Ticket Part", + "value": { + "generatedName": "TicketPartBody", + "description": "The message body, which may contain HTML.", + "value": { + "description": "The message body, which may contain HTML.", + "schema": { + "example": "

Okay!

", + "type": "string" + }, + "generatedName": "TicketPartBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartPreviousTicketState", + "key": "previous_ticket_state", + "schema": { + "generatedName": "ticketPartPreviousTicketState", + "title": "Ticket Part", + "value": { + "description": "The previous state of the ticket.", + "generatedName": "TicketPartPreviousTicketState", + "values": [ + { + "generatedName": "submitted", + "value": "submitted", + "casing": {} + }, + { + "generatedName": "in_progress", + "value": "in_progress", + "casing": {} + }, + { + "generatedName": "waiting_on_customer", + "value": "waiting_on_customer", + "casing": {} + }, + { + "generatedName": "resolved", + "value": "resolved", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartTicketState", + "key": "ticket_state", + "schema": { + "generatedName": "ticketPartTicketState", + "title": "Ticket Part", + "value": { + "description": "The state of the ticket.", + "generatedName": "TicketPartTicketState", + "values": [ + { + "generatedName": "submitted", + "value": "submitted", + "casing": {} + }, + { + "generatedName": "in_progress", + "value": "in_progress", + "casing": {} + }, + { + "generatedName": "waiting_on_customer", + "value": "waiting_on_customer", + "casing": {} + }, + { + "generatedName": "resolved", + "value": "resolved", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "ticketPartCreatedAt", + "title": "Ticket Part", + "value": { + "description": "The time the ticket part was created.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "TicketPartCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "ticketPartUpdatedAt", + "title": "Ticket Part", + "value": { + "description": "The last time the ticket part was updated.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "TicketPartUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartAssignedTo", + "key": "assigned_to", + "schema": { + "generatedName": "ticketPartAssignedTo", + "title": "Ticket Part", + "value": { + "description": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", + "generatedName": "TicketPartAssignedTo", + "schema": "reference", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketPartAuthor", + "key": "author", + "schema": { + "generatedName": "ticketPartAuthor", + "title": "Ticket Part", + "value": { + "generatedName": "TicketPartAuthor", + "schema": "ticket_part_author", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketPartAttachments", + "key": "attachments", + "schema": { + "generatedName": "ticketPartAttachments", + "title": "Ticket Part", + "value": { + "description": "A list of attachments for the part.", + "value": { + "generatedName": "TicketPartAttachmentsItem", + "schema": "part_attachment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketPartAttachments", + "title": "Ticket part attachments", + "groupName": [], + "type": "array" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartExternalId", + "key": "external_id", + "schema": { + "generatedName": "ticketPartExternalId", + "title": "Ticket Part", + "value": { + "generatedName": "TicketPartExternalId", + "description": "The external id of the ticket part", + "value": { + "description": "The external id of the ticket part", + "schema": { + "example": "abcd1234", + "type": "string" + }, + "generatedName": "TicketPartExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartRedacted", + "key": "redacted", + "schema": { + "generatedName": "ticketPartRedacted", + "title": "Ticket Part", + "value": { + "description": "Whether or not the ticket part has been redacted.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "TicketPartRedacted", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Ticket Part represents a message in the ticket.", + "generatedName": "TicketPart", + "title": "Ticket Part", + "groupName": [ + "Tickets" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_part_author": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketPartAuthorType", + "key": "type", + "schema": { + "generatedName": "ticketPartAuthorType", + "title": "Ticket part author", + "value": { + "description": "The type of the author", + "generatedName": "TicketPartAuthorType", + "values": [ + { + "generatedName": "admin", + "value": "admin", + "casing": {} + }, + { + "generatedName": "bot", + "value": "bot", + "casing": {} + }, + { + "generatedName": "team", + "value": "team", + "casing": {} + }, + { + "generatedName": "user", + "value": "user", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartAuthorId", + "key": "id", + "schema": { + "generatedName": "ticketPartAuthorId", + "title": "Ticket part author", + "value": { + "description": "The id of the author", + "schema": { + "example": "274", + "type": "string" + }, + "generatedName": "TicketPartAuthorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartAuthorName", + "key": "name", + "schema": { + "generatedName": "ticketPartAuthorName", + "title": "Ticket part author", + "value": { + "generatedName": "TicketPartAuthorName", + "description": "The name of the author", + "value": { + "description": "The name of the author", + "schema": { + "example": "Operator", + "type": "string" + }, + "generatedName": "TicketPartAuthorName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartAuthorEmail", + "key": "email", + "schema": { + "generatedName": "ticketPartAuthorEmail", + "title": "Ticket part author", + "value": { + "description": "The email of the author", + "schema": { + "format": "email", + "example": "operator+abcd1234@intercom.io", + "type": "string" + }, + "generatedName": "TicketPartAuthorEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "generatedName": "TicketPartAuthor", + "title": "Ticket part author", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_parts": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketPartsType", + "key": "type", + "schema": { + "generatedName": "ticketPartsType", + "title": "Ticket Parts", + "value": { + "description": "", + "value": { + "value": "ticket_part.list", + "type": "string" + }, + "generatedName": "TicketPartsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartsTicketParts", + "key": "ticket_parts", + "schema": { + "generatedName": "ticketPartsTicketParts", + "title": "Ticket Parts", + "value": { + "description": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", + "value": { + "generatedName": "TicketPartsTicketPartsItem", + "schema": "ticket_part", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketPartsTicketParts", + "title": "Tickt Parts", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketPartsTotalCount", + "key": "total_count", + "schema": { + "generatedName": "ticketPartsTotalCount", + "title": "Ticket Parts", + "value": { + "description": "", + "schema": { + "example": 2, + "type": "int" + }, + "generatedName": "TicketPartsTotalCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "generatedName": "TicketParts", + "title": "Ticket Parts", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_reply": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketReplyType", + "key": "type", + "schema": { + "generatedName": "ticketReplyType", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "Always ticket_part", + "value": { + "value": "ticket_part", + "type": "string" + }, + "generatedName": "TicketReplyType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyId", + "key": "id", + "schema": { + "generatedName": "ticketReplyId", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "The id representing the part.", + "schema": { + "example": "3", + "type": "string" + }, + "generatedName": "TicketReplyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyPartType", + "key": "part_type", + "schema": { + "generatedName": "ticketReplyPartType", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "Type of the part", + "generatedName": "TicketReplyPartType", + "values": [ + { + "generatedName": "note", + "value": "note", + "casing": {} + }, + { + "generatedName": "comment", + "value": "comment", + "casing": {} + }, + { + "generatedName": "quick_reply", + "value": "quick_reply", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyBody", + "key": "body", + "schema": { + "generatedName": "ticketReplyBody", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "generatedName": "TicketReplyBody", + "description": "The message body, which may contain HTML.", + "value": { + "description": "The message body, which may contain HTML.", + "schema": { + "example": "

Okay!

", + "type": "string" + }, + "generatedName": "TicketReplyBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "ticketReplyCreatedAt", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "The time the note was created.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "TicketReplyCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "ticketReplyUpdatedAt", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "The last time the note was updated.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "TicketReplyUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyAuthor", + "key": "author", + "schema": { + "generatedName": "ticketReplyAuthor", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "generatedName": "TicketReplyAuthor", + "schema": "ticket_part_author", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketReplyAttachments", + "key": "attachments", + "schema": { + "generatedName": "ticketReplyAttachments", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "A list of attachments for the part.", + "value": { + "generatedName": "TicketReplyAttachmentsItem", + "schema": "part_attachment", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketReplyAttachments", + "title": "Ticket part attachments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketReplyRedacted", + "key": "redacted", + "schema": { + "generatedName": "ticketReplyRedacted", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "value": { + "description": "Whether or not the ticket part has been redacted.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "TicketReplyRedacted", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "generatedName": "TicketReply", + "title": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_request_custom_attributes": { + "description": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "TicketRequestCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "value": { + "generatedName": "TicketRequestCustomAttributesValue", + "schemas": [ + { + "generatedName": "TicketRequestCustomAttributesValue", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "TicketRequestCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + { + "schema": { + "type": "double" + }, + "generatedName": "TicketRequestCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + { + "schema": { + "type": "boolean" + }, + "generatedName": "TicketRequestCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + { + "value": { + "generatedName": "TicketRequestCustomAttributesValue", + "type": "unknown" + }, + "generatedName": "TicketRequestCustomAttributesValue", + "groupName": [], + "type": "array" + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "undisciminated" + }, + "type": "oneOf" + }, + "generatedName": "TicketRequestCustomAttributes", + "title": "Ticket Attributes", + "groupName": [], + "type": "map" + }, + "ticket_type": { + "generatedName": "TicketType", + "title": "Ticket Type", + "description": "A ticket type, used to define the data fields to be captured in a ticket.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketTypeType", + "key": "type", + "schema": { + "generatedName": "ticketTypeType", + "title": "Ticket Type", + "value": { + "description": "String representing the object's type. Always has the value `ticket_type`.", + "schema": { + "example": "ticket_type", + "type": "string" + }, + "generatedName": "TicketTypeType", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeId", + "key": "id", + "schema": { + "generatedName": "ticketTypeId", + "title": "Ticket Type", + "value": { + "description": "The id representing the ticket type.", + "schema": { + "example": "1295", + "type": "string" + }, + "generatedName": "TicketTypeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeCategory", + "key": "category", + "schema": { + "generatedName": "ticketTypeCategory", + "title": "Ticket Type", + "value": { + "description": "Category of the Ticket Type.", + "generatedName": "TicketTypeCategory", + "values": [ + { + "generatedName": "Customer", + "value": "Customer", + "casing": {} + }, + { + "generatedName": "BackOffice", + "value": "Back-office", + "casing": {} + }, + { + "generatedName": "Tracker", + "value": "Tracker", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeName", + "key": "name", + "schema": { + "generatedName": "ticketTypeName", + "title": "Ticket Type", + "value": { + "description": "The name of the ticket type", + "schema": { + "example": "Bug", + "type": "string" + }, + "generatedName": "TicketTypeName", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeDescription", + "key": "description", + "schema": { + "generatedName": "ticketTypeDescription", + "title": "Ticket Type", + "value": { + "description": "The description of the ticket type", + "schema": { + "example": "A bug that has been reported.", + "type": "string" + }, + "generatedName": "TicketTypeDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeIcon", + "key": "icon", + "schema": { + "generatedName": "ticketTypeIcon", + "title": "Ticket Type", + "value": { + "description": "The icon of the ticket type", + "schema": { + "example": "🐞", + "type": "string" + }, + "generatedName": "TicketTypeIcon", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "ticketTypeWorkspaceId", + "title": "Ticket Type", + "value": { + "description": "The id of the workspace that the ticket type belongs to.", + "schema": { + "example": "ecahpwf5", + "type": "string" + }, + "generatedName": "TicketTypeWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeTicketTypeAttributes", + "key": "ticket_type_attributes", + "schema": { + "generatedName": "ticketTypeTicketTypeAttributes", + "title": "Ticket Type", + "value": { + "generatedName": "TicketTypeTicketTypeAttributes", + "schema": "ticket_type_attribute_list", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "ticketTypeArchived", + "key": "archived", + "schema": { + "generatedName": "ticketTypeArchived", + "title": "Ticket Type", + "value": { + "description": "Whether the ticket type is archived or not.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "ticketTypeCreatedAt", + "title": "Ticket Type", + "value": { + "description": "The date and time the ticket type was created.", + "schema": { + "type": "int" + }, + "generatedName": "TicketTypeCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "ticketTypeUpdatedAt", + "title": "Ticket Type", + "value": { + "description": "The date and time the ticket type was last updated.", + "schema": { + "type": "int" + }, + "generatedName": "TicketTypeUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [ + "Tickets" + ], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A ticket type, used to define the data fields to be captured in a ticket.", + "generatedName": "TicketType", + "title": "Ticket Type", + "groupName": [ + "Tickets" + ], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [ + "Tickets" + ], + "type": "nullable" + }, + "ticket_type_attribute": { + "generatedName": "TicketTypeAttribute", + "title": "Ticket Type Attribute", + "description": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketTypeAttributeType", + "key": "type", + "schema": { + "generatedName": "ticketTypeAttributeType", + "title": "Ticket Type Attribute", + "value": { + "description": "String representing the object's type. Always has the value `ticket_type_attribute`.", + "schema": { + "example": "ticket_type_attribute", + "type": "string" + }, + "generatedName": "TicketTypeAttributeType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeId", + "key": "id", + "schema": { + "generatedName": "ticketTypeAttributeId", + "title": "Ticket Type Attribute", + "value": { + "description": "The id representing the ticket type attribute.", + "schema": { + "example": "1", + "type": "string" + }, + "generatedName": "TicketTypeAttributeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeWorkspaceId", + "key": "workspace_id", + "schema": { + "generatedName": "ticketTypeAttributeWorkspaceId", + "title": "Ticket Type Attribute", + "value": { + "description": "The id of the workspace that the ticket type attribute belongs to.", + "schema": { + "example": "ecahpwf5", + "type": "string" + }, + "generatedName": "TicketTypeAttributeWorkspaceId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeName", + "key": "name", + "schema": { + "generatedName": "ticketTypeAttributeName", + "title": "Ticket Type Attribute", + "value": { + "description": "The name of the ticket type attribute", + "schema": { + "example": "Title", + "type": "string" + }, + "generatedName": "TicketTypeAttributeName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeDescription", + "key": "description", + "schema": { + "generatedName": "ticketTypeAttributeDescription", + "title": "Ticket Type Attribute", + "value": { + "description": "The description of the ticket type attribute", + "schema": { + "example": "Bug title.", + "type": "string" + }, + "generatedName": "TicketTypeAttributeDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeDataType", + "key": "data_type", + "schema": { + "generatedName": "ticketTypeAttributeDataType", + "title": "Ticket Type Attribute", + "value": { + "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")", + "schema": { + "example": "string", + "type": "string" + }, + "generatedName": "TicketTypeAttributeDataType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeInputOptions", + "key": "input_options", + "schema": { + "generatedName": "ticketTypeAttributeInputOptions", + "title": "Ticket Type Attribute", + "value": { + "description": "Input options for the attribute", + "key": { + "schema": { + "example": "multiline: true", + "type": "string" + }, + "generatedName": "TicketTypeAttributeInputOptionsKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "generatedName": "TicketTypeAttributeInputOptionsValue", + "type": "unknown" + }, + "generatedName": "TicketTypeAttributeInputOptions", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeOrder", + "key": "order", + "schema": { + "generatedName": "ticketTypeAttributeOrder", + "title": "Ticket Type Attribute", + "value": { + "description": "The order of the attribute against other attributes", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "TicketTypeAttributeOrder", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeRequiredToCreate", + "key": "required_to_create", + "schema": { + "generatedName": "ticketTypeAttributeRequiredToCreate", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the attribute is required or not for teammates.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeRequiredToCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeRequiredToCreateForContacts", + "key": "required_to_create_for_contacts", + "schema": { + "generatedName": "ticketTypeAttributeRequiredToCreateForContacts", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the attribute is required or not for contacts.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeRequiredToCreateForContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeVisibleOnCreate", + "key": "visible_on_create", + "schema": { + "generatedName": "ticketTypeAttributeVisibleOnCreate", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the attribute is visible or not to teammates.", + "schema": { + "default": true, + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeVisibleOnCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeVisibleToContacts", + "key": "visible_to_contacts", + "schema": { + "generatedName": "ticketTypeAttributeVisibleToContacts", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the attribute is visible or not to contacts.", + "schema": { + "default": true, + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeVisibleToContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeDefault", + "key": "default", + "schema": { + "generatedName": "ticketTypeAttributeDefault", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the attribute is built in or not.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeDefault", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeTicketTypeId", + "key": "ticket_type_id", + "schema": { + "generatedName": "ticketTypeAttributeTicketTypeId", + "title": "Ticket Type Attribute", + "value": { + "description": "The id of the ticket type that the attribute belongs to.", + "schema": { + "example": 42, + "type": "int" + }, + "generatedName": "TicketTypeAttributeTicketTypeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeArchived", + "key": "archived", + "schema": { + "generatedName": "ticketTypeAttributeArchived", + "title": "Ticket Type Attribute", + "value": { + "description": "Whether the ticket type attribute is archived or not.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "TicketTypeAttributeArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "ticketTypeAttributeCreatedAt", + "title": "Ticket Type Attribute", + "value": { + "description": "The date and time the ticket type attribute was created.", + "schema": { + "type": "int" + }, + "generatedName": "TicketTypeAttributeCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "ticketTypeAttributeUpdatedAt", + "title": "Ticket Type Attribute", + "value": { + "description": "The date and time the ticket type attribute was last updated.", + "schema": { + "type": "int" + }, + "generatedName": "TicketTypeAttributeUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "generatedName": "TicketTypeAttribute", + "title": "Ticket Type Attribute", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "ticket_type_attribute_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketTypeAttributeListType", + "key": "type", + "schema": { + "generatedName": "ticketTypeAttributeListType", + "title": "Ticket Type Attributes", + "value": { + "description": "String representing the object's type. Always has the value `ticket_type_attributes.list`.", + "schema": { + "type": "string" + }, + "generatedName": "TicketTypeAttributeListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeAttributeListTicketTypeAttributes", + "key": "ticket_type_attributes", + "schema": { + "generatedName": "ticketTypeAttributeListTicketTypeAttributes", + "title": "Ticket Type Attributes", + "value": { + "description": "A list of ticket type attributes associated with a given ticket type.", + "value": { + "generatedName": "TicketTypeAttributeListTicketTypeAttributesItem", + "schema": "ticket_type_attribute", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketTypeAttributeListTicketTypeAttributes", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of attributes associated with a given ticket type.", + "generatedName": "TicketTypeAttributeList", + "title": "Ticket Type Attributes", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "ticket_type_list": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "ticketTypeListType", + "key": "type", + "schema": { + "generatedName": "ticketTypeListType", + "title": "Ticket Types", + "value": { + "description": "String representing the object's type. Always has the value `ticket_type.list`.", + "schema": { + "type": "string" + }, + "generatedName": "TicketTypeListType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "ticketTypeListTicketTypes", + "key": "ticket_types", + "schema": { + "generatedName": "ticketTypeListTicketTypes", + "title": "Ticket Types", + "value": { + "description": "A list of ticket_types associated with a given workspace.", + "value": { + "generatedName": "TicketTypeListTicketTypesItem", + "schema": "ticket_type", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "TicketTypeListTicketTypes", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A list of ticket types associated with a given workspace.", + "generatedName": "TicketTypeList", + "title": "Ticket Types", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "translation": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "translationName", + "key": "name", + "schema": { + "generatedName": "translationName", + "nameOverride": "Translation", + "title": "Translation", + "value": { + "description": "The localised name of the subscription type.", + "schema": { + "example": "Announcements", + "type": "string" + }, + "generatedName": "TranslationName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "translationDescription", + "key": "description", + "schema": { + "generatedName": "translationDescription", + "nameOverride": "Translation", + "title": "Translation", + "value": { + "description": "The localised description of the subscription type.", + "schema": { + "example": "Offers, product and feature announcements", + "type": "string" + }, + "generatedName": "TranslationDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "translationLocale", + "key": "locale", + "schema": { + "generatedName": "translationLocale", + "nameOverride": "Translation", + "title": "Translation", + "value": { + "description": "The two character identifier for the language of the translation object.", + "schema": { + "example": "en", + "type": "string" + }, + "generatedName": "TranslationLocale", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "A translation object contains the localised details of a subscription type.", + "generatedName": "Translation", + "nameOverride": "Translation", + "title": "Translation", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "untag_company_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "untagCompanyRequestName", + "key": "name", + "schema": { + "description": "The name of the tag which will be untagged from the company", + "schema": { + "example": "Independent", + "type": "string" + }, + "generatedName": "UntagCompanyRequestName", + "groupName": [], + "type": "primitive" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "untagCompanyRequestCompanies", + "key": "companies", + "schema": { + "description": "The id or company_id of the company can be passed as input parameters.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "untagCompanyRequestCompaniesItemId", + "key": "id", + "schema": { + "generatedName": "untagCompanyRequestCompaniesItemId", + "value": { + "description": "The Intercom defined id representing the company.", + "schema": { + "example": "531ee472cce572a6ec000006", + "type": "string" + }, + "generatedName": "UntagCompanyRequestCompaniesItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "untagCompanyRequestCompaniesItemCompanyId", + "key": "company_id", + "schema": { + "generatedName": "untagCompanyRequestCompaniesItemCompanyId", + "value": { + "description": "The company id you have defined for the company.", + "schema": { + "example": "6", + "type": "string" + }, + "generatedName": "UntagCompanyRequestCompaniesItemCompanyId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "untagCompanyRequestCompaniesItemUntag", + "key": "untag", + "schema": { + "generatedName": "untagCompanyRequestCompaniesItemUntag", + "value": { + "description": "Always set to true", + "schema": { + "type": "boolean" + }, + "generatedName": "UntagCompanyRequestCompaniesItemUntag", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "UntagCompanyRequestCompaniesItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "UntagCompanyRequestCompanies", + "groupName": [], + "type": "array" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can tag a single company or a list of companies.", + "generatedName": "UntagCompanyRequest", + "title": "Untag Company Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_article_request": { + "generatedName": "UpdateArticleRequest", + "title": "Update Article Request Payload", + "description": "You can Update an Article", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateArticleRequestTitle", + "key": "title", + "schema": { + "generatedName": "updateArticleRequestTitle", + "title": "Update Article Request Payload", + "value": { + "description": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "schema": { + "example": "Thanks for everything", + "type": "string" + }, + "generatedName": "UpdateArticleRequestTitle", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestDescription", + "key": "description", + "schema": { + "generatedName": "updateArticleRequestDescription", + "title": "Update Article Request Payload", + "value": { + "description": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "schema": { + "example": "Description of the Article", + "type": "string" + }, + "generatedName": "UpdateArticleRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestBody", + "key": "body", + "schema": { + "generatedName": "updateArticleRequestBody", + "title": "Update Article Request Payload", + "value": { + "description": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "schema": { + "example": "

This is the body in html

", + "type": "string" + }, + "generatedName": "UpdateArticleRequestBody", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestAuthorId", + "key": "author_id", + "schema": { + "generatedName": "updateArticleRequestAuthorId", + "title": "Update Article Request Payload", + "value": { + "description": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "schema": { + "example": 1295, + "type": "int" + }, + "generatedName": "UpdateArticleRequestAuthorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestState", + "key": "state", + "schema": { + "generatedName": "updateArticleRequestState", + "title": "Update Article Request Payload", + "value": { + "description": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "generatedName": "UpdateArticleRequestState", + "values": [ + { + "generatedName": "published", + "value": "published", + "casing": {} + }, + { + "generatedName": "draft", + "value": "draft", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestParentId", + "key": "parent_id", + "schema": { + "generatedName": "updateArticleRequestParentId", + "title": "Update Article Request Payload", + "value": { + "description": "The id of the article's parent collection or section. An article without this field stands alone.", + "schema": { + "example": "18", + "type": "string" + }, + "generatedName": "UpdateArticleRequestParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestParentType", + "key": "parent_type", + "schema": { + "generatedName": "updateArticleRequestParentType", + "title": "Update Article Request Payload", + "value": { + "description": "The type of parent, which can either be a `collection` or `section`.", + "schema": { + "example": "collection", + "type": "string" + }, + "generatedName": "UpdateArticleRequestParentType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateArticleRequestTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "updateArticleRequestTranslatedContent", + "title": "Update Article Request Payload", + "value": { + "generatedName": "UpdateArticleRequestTranslatedContent", + "schema": "article_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "You can Update an Article", + "generatedName": "UpdateArticleRequest", + "title": "Update Article Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "update_collection_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateCollectionRequestName", + "key": "name", + "schema": { + "generatedName": "updateCollectionRequestName", + "title": "Update Collection Request Payload", + "value": { + "description": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "schema": { + "example": "collection 51", + "type": "string" + }, + "generatedName": "UpdateCollectionRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateCollectionRequestDescription", + "key": "description", + "schema": { + "generatedName": "updateCollectionRequestDescription", + "title": "Update Collection Request Payload", + "value": { + "description": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "schema": { + "example": "English description", + "type": "string" + }, + "generatedName": "UpdateCollectionRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateCollectionRequestTranslatedContent", + "key": "translated_content", + "schema": { + "generatedName": "updateCollectionRequestTranslatedContent", + "title": "Update Collection Request Payload", + "value": { + "generatedName": "UpdateCollectionRequestTranslatedContent", + "schema": "group_translated_content", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + }, + { + "conflict": {}, + "generatedName": "updateCollectionRequestParentId", + "key": "parent_id", + "schema": { + "generatedName": "updateCollectionRequestParentId", + "title": "Update Collection Request Payload", + "value": { + "generatedName": "UpdateCollectionRequestParentId", + "description": "The id of the parent collection. If `null` then it will be updated as the first level collection.", + "value": { + "description": "The id of the parent collection. If `null` then it will be updated as the first level collection.", + "schema": { + "example": "6871118", + "type": "string" + }, + "generatedName": "UpdateCollectionRequestParentId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can update a collection", + "generatedName": "UpdateCollectionRequest", + "title": "Update Collection Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_contact_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateContactRequestRole", + "key": "role", + "schema": { + "generatedName": "updateContactRequestRole", + "title": "Update Contact Request Payload", + "value": { + "description": "The role of the contact.", + "schema": { + "type": "string" + }, + "generatedName": "UpdateContactRequestRole", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestExternalId", + "key": "external_id", + "schema": { + "generatedName": "updateContactRequestExternalId", + "title": "Update Contact Request Payload", + "value": { + "description": "A unique identifier for the contact which is given to Intercom", + "schema": { + "type": "string" + }, + "generatedName": "UpdateContactRequestExternalId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestEmail", + "key": "email", + "schema": { + "generatedName": "updateContactRequestEmail", + "title": "Update Contact Request Payload", + "value": { + "description": "The contacts email", + "schema": { + "example": "jdoe@example.com", + "type": "string" + }, + "generatedName": "UpdateContactRequestEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestPhone", + "key": "phone", + "schema": { + "generatedName": "updateContactRequestPhone", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestPhone", + "description": "The contacts phone", + "value": { + "description": "The contacts phone", + "schema": { + "example": "+353871234567", + "type": "string" + }, + "generatedName": "UpdateContactRequestPhone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestName", + "key": "name", + "schema": { + "generatedName": "updateContactRequestName", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestName", + "description": "The contacts name", + "value": { + "description": "The contacts name", + "schema": { + "example": "John Doe", + "type": "string" + }, + "generatedName": "UpdateContactRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestAvatar", + "key": "avatar", + "schema": { + "generatedName": "updateContactRequestAvatar", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestAvatar", + "description": "An image URL containing the avatar of a contact", + "value": { + "description": "An image URL containing the avatar of a contact", + "schema": { + "example": "https://www.example.com/avatar_image.jpg", + "type": "string" + }, + "generatedName": "UpdateContactRequestAvatar", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestSignedUpAt", + "key": "signed_up_at", + "schema": { + "generatedName": "updateContactRequestSignedUpAt", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestSignedUpAt", + "description": "The time specified for when a contact signed up", + "value": { + "description": "The time specified for when a contact signed up", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "UpdateContactRequestSignedUpAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestLastSeenAt", + "key": "last_seen_at", + "schema": { + "generatedName": "updateContactRequestLastSeenAt", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestLastSeenAt", + "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", + "value": { + "description": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", + "schema": { + "example": 1571672154, + "type": "int" + }, + "generatedName": "UpdateContactRequestLastSeenAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestOwnerId", + "key": "owner_id", + "schema": { + "generatedName": "updateContactRequestOwnerId", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestOwnerId", + "description": "The id of an admin that has been assigned account ownership of the contact", + "value": { + "description": "The id of an admin that has been assigned account ownership of the contact", + "schema": { + "example": 123, + "type": "int" + }, + "generatedName": "UpdateContactRequestOwnerId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestUnsubscribedFromEmails", + "key": "unsubscribed_from_emails", + "schema": { + "generatedName": "updateContactRequestUnsubscribedFromEmails", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestUnsubscribedFromEmails", + "description": "Whether the contact is unsubscribed from emails", + "value": { + "description": "Whether the contact is unsubscribed from emails", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateContactRequestUnsubscribedFromEmails", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateContactRequestCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "updateContactRequestCustomAttributes", + "title": "Update Contact Request Payload", + "value": { + "generatedName": "UpdateContactRequestCustomAttributes", + "description": "The custom attributes which are set for the contact", + "value": { + "description": "The custom attributes which are set for the contact", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateContactRequestCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "generatedName": "UpdateContactRequestCustomAttributesValue", + "type": "unknown" + }, + "generatedName": "UpdateContactRequestCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can update a contact", + "generatedName": "UpdateContactRequest", + "title": "Update Contact Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_conversation_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateConversationRequestRead", + "key": "read", + "schema": { + "generatedName": "updateConversationRequestRead", + "title": "Update Conversation Request", + "value": { + "description": "Mark a conversation as read within Intercom.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateConversationRequestRead", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateConversationRequestCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "updateConversationRequestCustomAttributes", + "title": "Update Conversation Request", + "value": { + "generatedName": "UpdateConversationRequestCustomAttributes", + "schema": "custom_attributes", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [], + "readonly": false + } + ], + "allOfPropertyConflicts": [], + "description": "Payload of the request to update a conversation", + "generatedName": "UpdateConversationRequest", + "title": "Update Conversation Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_data_attribute_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateDataAttributeRequestArchived", + "key": "archived", + "schema": { + "generatedName": "updateDataAttributeRequestArchived", + "title": "Update Data Attribute Request", + "value": { + "description": "Whether the attribute is to be archived or not.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateDataAttributeRequestArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateDataAttributeRequestDescription", + "key": "description", + "schema": { + "generatedName": "updateDataAttributeRequestDescription", + "title": "Update Data Attribute Request", + "value": { + "description": "The readable description you see in the UI for the attribute.", + "schema": { + "example": "My Data Attribute Description", + "type": "string" + }, + "generatedName": "UpdateDataAttributeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateDataAttributeRequestOptions", + "key": "options", + "schema": { + "generatedName": "updateDataAttributeRequestOptions", + "title": "Update Data Attribute Request", + "value": { + "description": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "value": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateDataAttributeRequestOptionsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "UpdateDataAttributeRequestOptions", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateDataAttributeRequestMessengerWritable", + "key": "messenger_writable", + "schema": { + "generatedName": "updateDataAttributeRequestMessengerWritable", + "title": "Update Data Attribute Request", + "value": { + "description": "Can this attribute be updated by the Messenger", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateDataAttributeRequestMessengerWritable", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "", + "generatedName": "UpdateDataAttributeRequest", + "title": "Update Data Attribute Request", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_ticket_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateTicketRequestTicketAttributes", + "key": "ticket_attributes", + "schema": { + "generatedName": "updateTicketRequestTicketAttributes", + "title": "Update Ticket Request Payload", + "value": { + "description": "The attributes set on the ticket.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "UpdateTicketRequestTicketAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "generatedName": "UpdateTicketRequestTicketAttributesValue", + "type": "unknown" + }, + "generatedName": "UpdateTicketRequestTicketAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestState", + "key": "state", + "schema": { + "generatedName": "updateTicketRequestState", + "title": "Update Ticket Request Payload", + "value": { + "description": "The state of the ticket.", + "generatedName": "UpdateTicketRequestState", + "values": [ + { + "generatedName": "in_progress", + "value": "in_progress", + "casing": {} + }, + { + "generatedName": "waiting_on_customer", + "value": "waiting_on_customer", + "casing": {} + }, + { + "generatedName": "resolved", + "value": "resolved", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestOpen", + "key": "open", + "schema": { + "generatedName": "updateTicketRequestOpen", + "title": "Update Ticket Request Payload", + "value": { + "description": "Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateTicketRequestOpen", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestIsShared", + "key": "is_shared", + "schema": { + "generatedName": "updateTicketRequestIsShared", + "title": "Update Ticket Request Payload", + "value": { + "description": "Specify whether the ticket is visible to users.", + "schema": { + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateTicketRequestIsShared", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestSnoozedUntil", + "key": "snoozed_until", + "schema": { + "generatedName": "updateTicketRequestSnoozedUntil", + "title": "Update Ticket Request Payload", + "value": { + "description": "The time you want the ticket to reopen.", + "schema": { + "example": 1673609604, + "type": "int" + }, + "generatedName": "UpdateTicketRequestSnoozedUntil", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestAssignment", + "key": "assignment", + "schema": { + "generatedName": "updateTicketRequestAssignment", + "title": "Update Ticket Request Payload", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateTicketRequestAssignmentAdminId", + "key": "admin_id", + "schema": { + "generatedName": "updateTicketRequestAssignmentAdminId", + "value": { + "description": "The ID of the admin performing the action.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "UpdateTicketRequestAssignmentAdminId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketRequestAssignmentAssigneeId", + "key": "assignee_id", + "schema": { + "generatedName": "updateTicketRequestAssignmentAssigneeId", + "value": { + "description": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.", + "schema": { + "example": "123", + "type": "string" + }, + "generatedName": "UpdateTicketRequestAssignmentAssigneeId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "UpdateTicketRequestAssignment", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can update a Ticket", + "generatedName": "UpdateTicketRequest", + "title": "Update Ticket Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_ticket_type_attribute_request": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestName", + "key": "name", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestName", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "The name of the ticket type attribute", + "schema": { + "example": "Bug Priority", + "type": "string" + }, + "generatedName": "UpdateTicketTypeAttributeRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestDescription", + "key": "description", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestDescription", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "The description of the attribute presented to the teammate or contact", + "schema": { + "example": "Priority level of the bug", + "type": "string" + }, + "generatedName": "UpdateTicketTypeAttributeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestRequiredToCreate", + "key": "required_to_create", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestRequiredToCreate", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestRequiredToCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestRequiredToCreateForContacts", + "key": "required_to_create_for_contacts", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestRequiredToCreateForContacts", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestRequiredToCreateForContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestVisibleOnCreate", + "key": "visible_on_create", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestVisibleOnCreate", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "schema": { + "default": true, + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestVisibleOnCreate", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestVisibleToContacts", + "key": "visible_to_contacts", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestVisibleToContacts", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "schema": { + "default": true, + "example": true, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestVisibleToContacts", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestMultiline", + "key": "multiline", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestMultiline", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestMultiline", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestListItems", + "key": "list_items", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestListItems", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "schema": { + "example": "Low Priority,Medium Priority,High Priority", + "type": "string" + }, + "generatedName": "UpdateTicketTypeAttributeRequestListItems", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestAllowMultipleValues", + "key": "allow_multiple_values", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestAllowMultipleValues", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestAllowMultipleValues", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeAttributeRequestArchived", + "key": "archived", + "schema": { + "generatedName": "updateTicketTypeAttributeRequestArchived", + "title": "Update Ticket Type Attribute Request Payload", + "value": { + "description": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeAttributeRequestArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "You can update a Ticket Type Attribute", + "generatedName": "UpdateTicketTypeAttributeRequest", + "title": "Update Ticket Type Attribute Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "update_ticket_type_request": { + "generatedName": "UpdateTicketTypeRequest", + "title": "Update Ticket Type Request Payload", + "description": "The request payload for updating a ticket type.\nYou can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestName", + "key": "name", + "schema": { + "generatedName": "updateTicketTypeRequestName", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "The name of the ticket type.", + "schema": { + "example": "Bug", + "type": "string" + }, + "generatedName": "UpdateTicketTypeRequestName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestDescription", + "key": "description", + "schema": { + "generatedName": "updateTicketTypeRequestDescription", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "The description of the ticket type.", + "schema": { + "example": "A bug has been occured", + "type": "string" + }, + "generatedName": "UpdateTicketTypeRequestDescription", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestCategory", + "key": "category", + "schema": { + "generatedName": "updateTicketTypeRequestCategory", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "Category of the Ticket Type.", + "generatedName": "UpdateTicketTypeRequestCategory", + "values": [ + { + "generatedName": "Customer", + "value": "Customer", + "casing": {} + }, + { + "generatedName": "BackOffice", + "value": "Back-office", + "casing": {} + }, + { + "generatedName": "Tracker", + "value": "Tracker", + "casing": {} + } + ], + "groupName": [], + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "enum" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestIcon", + "key": "icon", + "schema": { + "generatedName": "updateTicketTypeRequestIcon", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "The icon of the ticket type.", + "schema": { + "default": "🎟️", + "example": "🐞", + "type": "string" + }, + "generatedName": "UpdateTicketTypeRequestIcon", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestArchived", + "key": "archived", + "schema": { + "generatedName": "updateTicketTypeRequestArchived", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "The archived status of the ticket type.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeRequestArchived", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "updateTicketTypeRequestIsInternal", + "key": "is_internal", + "schema": { + "generatedName": "updateTicketTypeRequestIsInternal", + "title": "Update Ticket Type Request Payload", + "value": { + "description": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "schema": { + "default": false, + "example": false, + "type": "boolean" + }, + "generatedName": "UpdateTicketTypeRequestIsInternal", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "The request payload for updating a ticket type.\nYou can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n", + "generatedName": "UpdateTicketTypeRequest", + "title": "Update Ticket Type Request Payload", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "update_visitor_request": { + "generatedName": "UpdateVisitorRequestOne", + "type": "unknown" + }, + "visitor": { + "generatedName": "Visitor", + "nameOverride": "Visitor", + "title": "Visitor", + "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorType", + "key": "type", + "schema": { + "generatedName": "visitorType", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Value is 'visitor'", + "schema": { + "default": "visitor", + "example": "visitor", + "type": "string" + }, + "generatedName": "VisitorType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorId", + "key": "id", + "schema": { + "generatedName": "visitorId", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The Intercom defined id representing the Visitor.", + "schema": { + "example": "530370b477ad7120001d", + "type": "string" + }, + "generatedName": "VisitorId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUserId", + "key": "user_id", + "schema": { + "generatedName": "visitorUserId", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Automatically generated identifier for the Visitor.", + "schema": { + "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c", + "type": "string" + }, + "generatedName": "VisitorUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorAnonymous", + "key": "anonymous", + "schema": { + "generatedName": "visitorAnonymous", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Identifies if this visitor is anonymous.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "VisitorAnonymous", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorEmail", + "key": "email", + "schema": { + "generatedName": "visitorEmail", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The email of the visitor.", + "schema": { + "format": "email", + "example": "jane.doe@example.com", + "type": "string" + }, + "generatedName": "VisitorEmail", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorPhone", + "key": "phone", + "schema": { + "generatedName": "visitorPhone", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorPhone", + "description": "The phone number of the visitor.", + "value": { + "description": "The phone number of the visitor.", + "schema": { + "example": "555-555-5555", + "type": "string" + }, + "generatedName": "VisitorPhone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorName", + "key": "name", + "schema": { + "generatedName": "visitorName", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorName", + "description": "The name of the visitor.", + "value": { + "description": "The name of the visitor.", + "schema": { + "example": "Jane Doe", + "type": "string" + }, + "generatedName": "VisitorName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorPseudonym", + "key": "pseudonym", + "schema": { + "generatedName": "visitorPseudonym", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorPseudonym", + "description": "The pseudonym of the visitor.", + "value": { + "description": "The pseudonym of the visitor.", + "schema": { + "example": "Red Duck from Dublin", + "type": "string" + }, + "generatedName": "VisitorPseudonym", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorAvatar", + "key": "avatar", + "schema": { + "generatedName": "visitorAvatar", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorAvatarType", + "key": "type", + "schema": { + "generatedName": "visitorAvatarType", + "value": { + "description": "", + "schema": { + "default": "avatar", + "example": "avatar", + "type": "string" + }, + "generatedName": "VisitorAvatarType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorAvatarImageUrl", + "key": "image_url", + "schema": { + "generatedName": "visitorAvatarImageUrl", + "value": { + "generatedName": "VisitorAvatarImageUrl", + "description": "This object represents the avatar associated with the visitor.", + "value": { + "description": "This object represents the avatar associated with the visitor.", + "schema": { + "format": "uri", + "example": "https://example.com/avatar.png", + "type": "string" + }, + "generatedName": "VisitorAvatarImageUrl", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorAvatar", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorAppId", + "key": "app_id", + "schema": { + "generatedName": "visitorAppId", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The id of the app the visitor is associated with.", + "schema": { + "example": "hfi1bx4l", + "type": "string" + }, + "generatedName": "VisitorAppId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorCompanies", + "key": "companies", + "schema": { + "generatedName": "visitorCompanies", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorCompaniesType", + "key": "type", + "schema": { + "generatedName": "visitorCompaniesType", + "value": { + "description": "The type of the object", + "value": { + "value": "company.list", + "type": "string" + }, + "generatedName": "VisitorCompaniesType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorCompaniesCompanies", + "key": "companies", + "schema": { + "generatedName": "visitorCompaniesCompanies", + "value": { + "value": { + "generatedName": "VisitorCompaniesCompaniesItem", + "schema": "company", + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "reference" + }, + "generatedName": "VisitorCompaniesCompanies", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorCompanies", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationData", + "key": "location_data", + "schema": { + "generatedName": "visitorLocationData", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorLocationDataType", + "key": "type", + "schema": { + "generatedName": "visitorLocationDataType", + "value": { + "description": "", + "schema": { + "default": "location_data", + "example": "location_data", + "type": "string" + }, + "generatedName": "VisitorLocationDataType", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataCityName", + "key": "city_name", + "schema": { + "generatedName": "visitorLocationDataCityName", + "value": { + "description": "The city name of the visitor.", + "schema": { + "example": "Dublin", + "type": "string" + }, + "generatedName": "VisitorLocationDataCityName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataContinentCode", + "key": "continent_code", + "schema": { + "generatedName": "visitorLocationDataContinentCode", + "value": { + "description": "The continent code of the visitor.", + "schema": { + "example": "EU", + "type": "string" + }, + "generatedName": "VisitorLocationDataContinentCode", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataCountryCode", + "key": "country_code", + "schema": { + "generatedName": "visitorLocationDataCountryCode", + "value": { + "description": "The country code of the visitor.", + "schema": { + "example": "IRL", + "type": "string" + }, + "generatedName": "VisitorLocationDataCountryCode", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataCountryName", + "key": "country_name", + "schema": { + "generatedName": "visitorLocationDataCountryName", + "value": { + "description": "The country name of the visitor.", + "schema": { + "example": "Ireland", + "type": "string" + }, + "generatedName": "VisitorLocationDataCountryName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataPostalCode", + "key": "postal_code", + "schema": { + "generatedName": "visitorLocationDataPostalCode", + "value": { + "description": "The postal code of the visitor.", + "schema": { + "example": "D02 N960", + "type": "string" + }, + "generatedName": "VisitorLocationDataPostalCode", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataRegionName", + "key": "region_name", + "schema": { + "generatedName": "visitorLocationDataRegionName", + "value": { + "description": "The region name of the visitor.", + "schema": { + "example": "Leinster", + "type": "string" + }, + "generatedName": "VisitorLocationDataRegionName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLocationDataTimezone", + "key": "timezone", + "schema": { + "generatedName": "visitorLocationDataTimezone", + "value": { + "description": "The timezone of the visitor.", + "schema": { + "example": "Europe/Dublin", + "type": "string" + }, + "generatedName": "VisitorLocationDataTimezone", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorLocationData", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorLasRequestAt", + "key": "las_request_at", + "schema": { + "generatedName": "visitorLasRequestAt", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The time the Lead last recorded making a request.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "VisitorLasRequestAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorCreatedAt", + "key": "created_at", + "schema": { + "generatedName": "visitorCreatedAt", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The time the Visitor was added to Intercom.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "VisitorCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorRemoteCreatedAt", + "key": "remote_created_at", + "schema": { + "generatedName": "visitorRemoteCreatedAt", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The time the Visitor was added to Intercom.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "VisitorRemoteCreatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSignedUpAt", + "key": "signed_up_at", + "schema": { + "generatedName": "visitorSignedUpAt", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The time the Visitor signed up for your product.", + "schema": { + "example": 1663597223, + "type": "int" + }, + "generatedName": "VisitorSignedUpAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUpdatedAt", + "key": "updated_at", + "schema": { + "generatedName": "visitorUpdatedAt", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The last time the Visitor was updated.", + "schema": { + "example": 1663597260, + "type": "int" + }, + "generatedName": "VisitorUpdatedAt", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSessionCount", + "key": "session_count", + "schema": { + "generatedName": "visitorSessionCount", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The number of sessions the Visitor has had.", + "schema": { + "example": 1, + "type": "int" + }, + "generatedName": "VisitorSessionCount", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSocialProfiles", + "key": "social_profiles", + "schema": { + "generatedName": "visitorSocialProfiles", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorSocialProfilesType", + "key": "type", + "schema": { + "generatedName": "visitorSocialProfilesType", + "value": { + "description": "The type of the object", + "value": { + "value": "social_profile.list", + "type": "string" + }, + "generatedName": "VisitorSocialProfilesType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSocialProfilesSocialProfiles", + "key": "social_profiles", + "schema": { + "generatedName": "visitorSocialProfilesSocialProfiles", + "value": { + "value": { + "schema": { + "type": "string" + }, + "generatedName": "VisitorSocialProfilesSocialProfilesItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "VisitorSocialProfilesSocialProfiles", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorSocialProfiles", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorOwnerId", + "key": "owner_id", + "schema": { + "generatedName": "visitorOwnerId", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorOwnerId", + "description": "The id of the admin that owns the Visitor.", + "value": { + "description": "The id of the admin that owns the Visitor.", + "schema": { + "example": "5169261", + "type": "string" + }, + "generatedName": "VisitorOwnerId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUnsubscribedFromEmails", + "key": "unsubscribed_from_emails", + "schema": { + "generatedName": "visitorUnsubscribedFromEmails", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Whether the Visitor is unsubscribed from emails.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "VisitorUnsubscribedFromEmails", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorMarkedEmailAsSpam", + "key": "marked_email_as_spam", + "schema": { + "generatedName": "visitorMarkedEmailAsSpam", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Identifies if this visitor has marked an email as spam.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "VisitorMarkedEmailAsSpam", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorHasHardBounced", + "key": "has_hard_bounced", + "schema": { + "generatedName": "visitorHasHardBounced", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "Identifies if this visitor has had a hard bounce.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "VisitorHasHardBounced", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorTags", + "key": "tags", + "schema": { + "generatedName": "visitorTags", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorTagsType", + "key": "type", + "schema": { + "generatedName": "visitorTagsType", + "value": { + "description": "The type of the object", + "value": { + "value": "tag.list", + "type": "string" + }, + "generatedName": "VisitorTagsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorTagsTags", + "key": "tags", + "schema": { + "generatedName": "visitorTagsTags", + "value": { + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorTagsTagsItemType", + "key": "type", + "schema": { + "generatedName": "visitorTagsTagsItemType", + "value": { + "description": "The type of the object", + "value": { + "value": "tag", + "type": "string" + }, + "generatedName": "VisitorTagsTagsItemType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorTagsTagsItemId", + "key": "id", + "schema": { + "generatedName": "visitorTagsTagsItemId", + "value": { + "description": "The id of the tag.", + "schema": { + "example": "8482", + "type": "string" + }, + "generatedName": "VisitorTagsTagsItemId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorTagsTagsItemName", + "key": "name", + "schema": { + "generatedName": "visitorTagsTagsItemName", + "value": { + "description": "The name of the tag.", + "schema": { + "example": "tag_name", + "type": "string" + }, + "generatedName": "VisitorTagsTagsItemName", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorTagsTagsItem", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "generatedName": "VisitorTagsTags", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorTags", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSegments", + "key": "segments", + "schema": { + "generatedName": "visitorSegments", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorSegmentsType", + "key": "type", + "schema": { + "generatedName": "visitorSegmentsType", + "value": { + "description": "The type of the object", + "value": { + "value": "segment.list", + "type": "string" + }, + "generatedName": "VisitorSegmentsType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorSegmentsSegments", + "key": "segments", + "schema": { + "generatedName": "visitorSegmentsSegments", + "value": { + "value": { + "schema": { + "type": "string" + }, + "generatedName": "VisitorSegmentsSegmentsItem", + "groupName": [], + "type": "primitive" + }, + "generatedName": "VisitorSegmentsSegments", + "groupName": [], + "type": "array" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "generatedName": "VisitorSegments", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorCustomAttributes", + "key": "custom_attributes", + "schema": { + "generatedName": "visitorCustomAttributes", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "description": "The custom attributes you have set on the Visitor.", + "key": { + "schema": { + "type": "string" + }, + "generatedName": "VisitorCustomAttributesKey", + "groupName": [], + "type": "primitive" + }, + "value": { + "schema": { + "type": "string" + }, + "generatedName": "VisitorCustomAttributesValue", + "groupName": [], + "type": "primitive" + }, + "generatedName": "VisitorCustomAttributes", + "groupName": [], + "type": "map" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorReferrer", + "key": "referrer", + "schema": { + "generatedName": "visitorReferrer", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorReferrer", + "description": "The referer of the visitor.", + "value": { + "description": "The referer of the visitor.", + "schema": { + "example": "https://www.google.com/", + "type": "string" + }, + "generatedName": "VisitorReferrer", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUtmCampaign", + "key": "utm_campaign", + "schema": { + "generatedName": "visitorUtmCampaign", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorUtmCampaign", + "description": "The utm_campaign of the visitor.", + "value": { + "description": "The utm_campaign of the visitor.", + "schema": { + "example": "intercom-link", + "type": "string" + }, + "generatedName": "VisitorUtmCampaign", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUtmContent", + "key": "utm_content", + "schema": { + "generatedName": "visitorUtmContent", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorUtmContent", + "description": "The utm_content of the visitor.", + "value": { + "description": "The utm_content of the visitor.", + "schema": { + "example": "banner", + "type": "string" + }, + "generatedName": "VisitorUtmContent", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUtmMedium", + "key": "utm_medium", + "schema": { + "generatedName": "visitorUtmMedium", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorUtmMedium", + "description": "The utm_medium of the visitor.", + "value": { + "description": "The utm_medium of the visitor.", + "schema": { + "example": "email", + "type": "string" + }, + "generatedName": "VisitorUtmMedium", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUtmSource", + "key": "utm_source", + "schema": { + "generatedName": "visitorUtmSource", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorUtmSource", + "description": "The utm_source of the visitor.", + "value": { + "description": "The utm_source of the visitor.", + "schema": { + "example": "Intercom", + "type": "string" + }, + "generatedName": "VisitorUtmSource", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorUtmTerm", + "key": "utm_term", + "schema": { + "generatedName": "visitorUtmTerm", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorUtmTerm", + "description": "The utm_term of the visitor.", + "value": { + "description": "The utm_term of the visitor.", + "schema": { + "example": "messenger", + "type": "string" + }, + "generatedName": "VisitorUtmTerm", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorDoNotTrack", + "key": "do_not_track", + "schema": { + "generatedName": "visitorDoNotTrack", + "nameOverride": "Visitor", + "title": "Visitor", + "value": { + "generatedName": "VisitorDoNotTrack", + "description": "Identifies if this visitor has do not track enabled.", + "value": { + "description": "Identifies if this visitor has do not track enabled.", + "schema": { + "example": false, + "type": "boolean" + }, + "generatedName": "VisitorDoNotTrack", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "nullable" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "generatedName": "Visitor", + "nameOverride": "Visitor", + "title": "Visitor", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + }, + "groupName": [], + "type": "nullable" + }, + "visitor_deleted_object": { + "allOf": [], + "properties": [ + { + "conflict": {}, + "generatedName": "visitorDeletedObjectId", + "key": "id", + "schema": { + "generatedName": "visitorDeletedObjectId", + "title": "Visitor Deleted Object", + "value": { + "description": "The unique identifier for the visitor which is given by Intercom.", + "schema": { + "example": "530370b477ad7120001d", + "type": "string" + }, + "generatedName": "VisitorDeletedObjectId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorDeletedObjectType", + "key": "type", + "schema": { + "generatedName": "visitorDeletedObjectType", + "title": "Visitor Deleted Object", + "value": { + "description": "The type of object which was deleted", + "value": { + "value": "visitor", + "type": "string" + }, + "generatedName": "VisitorDeletedObjectType", + "groupName": [], + "type": "literal" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + }, + { + "conflict": {}, + "generatedName": "visitorDeletedObjectUserId", + "key": "user_id", + "schema": { + "generatedName": "visitorDeletedObjectUserId", + "title": "Visitor Deleted Object", + "value": { + "description": "Automatically generated identifier for the Visitor.", + "schema": { + "example": "8a88a590-e1c3-41e2-a502-e0649dbf721c", + "type": "string" + }, + "generatedName": "VisitorDeletedObjectUserId", + "groupName": [], + "type": "primitive" + }, + "groupName": [], + "type": "optional" + }, + "audiences": [] + } + ], + "allOfPropertyConflicts": [], + "description": "Response returned when an object is deleted", + "generatedName": "VisitorDeletedObject", + "title": "Visitor Deleted Object", + "groupName": [], + "additionalProperties": false, + "source": { + "file": "../openapi.yml", + "type": "openapi" + }, + "type": "object" + } + }, + "namespacedSchemas": {} + }, + "variables": {}, + "nonRequestReferencedSchemas": {}, + "securitySchemes": { + "bearerAuth": { + "type": "bearer" + } + }, + "globalHeaders": [], + "idempotencyHeaders": [], + "groups": {} +} \ No newline at end of file diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json new file mode 100644 index 00000000000..2c3ecc545a3 --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json @@ -0,0 +1,48486 @@ +{ + "absoluteFilePath": "/DUMMY_PATH", + "importedDefinitions": {}, + "namedDefinitionFiles": { + "__package__.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "errors": { + "BadRequestError": { + "docs": "Bad Request", + "examples": [ + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "author_id must be in the main body or default locale translated_content object", + }, + ], + "request_id": "e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "Name is a required parameter.", + }, + ], + "request_id": "1f4fd741-8681-4c21-911a-47d7bb39d080", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "bad_request", + "message": "bad 'test' parameter", + }, + ], + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Bad Request", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "company not specified", + }, + ], + "request_id": "9297dcfc-1896-43a3-a3f9-131238422ed2", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Bad request", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Ticket type is not a customer ticket type", + }, + ], + "request_id": "74656c1a-0a17-4c80-a7b9-66fa45c6d71b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Same name already exists", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new people data, use a different name.", + }, + ], + "request_id": "bcd93885-3f01-4b92-9918-c96a3f4492e8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Invalid name", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Your name for this attribute must only contain alphanumeric characters, currency symbols, and hyphens", + }, + ], + "request_id": "7420c5e3-22c3-46be-8a23-72fef8f8ec0e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Attribute already exists", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "You already have 'The One Ring' in your company data. To save this as new company data, use a different name.", + }, + ], + "request_id": "c844551a-05d3-4f8c-931a-32e96bf3a508", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Invalid Data Type", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Data Type isn't an option", + }, + ], + "request_id": "b8c58b81-8445-473d-8fe3-7880c04f9547", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Too few options for list", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "The Data Attribute model field must be either contact or company", + }, + ], + "request_id": "119e3822-3a45-48cf-b5ab-037f27a948c8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Too few options in list", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Options isn't an array", + }, + ], + "request_id": "6615f20c-01df-443c-9ea1-c954ba6b09d6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "No body supplied for message", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required", + }, + ], + "request_id": "4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "No body supplied for email message", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Body is required", + }, + ], + "request_id": "7d54191b-c0fc-4860-a01c-9da6b4e45b7f", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "bad request - exception sending sms", + "value": { + "error_key": "sms_failed", + "message": "SMS was not sent due to an unknown error", + }, + }, + { + "docs": undefined, + "name": "bad request - invalid number", + "value": { + "error_key": "invalid_phone_number", + "message": "Invalid phone number", + }, + }, + { + "docs": undefined, + "name": "Invalid parameters", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "invalid tag parameters", + }, + ], + "request_id": "a7afe3c5-be52-4b69-9268-50ef1d917a1b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag has dependent objects", + "value": { + "errors": [ + { + "code": "tag_has_dependent_objects", + "message": "Unable to delete Tag with dependent objects. Segments: Seg 1.", + }, + ], + "request_id": "41086388-9b3b-4e07-9633-502b9b10c926", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "User reply", + "value": { + "errors": [ + { + "code": "parameter_mismatch", + "message": "User replies are not allowed on Backoffice tickets", + }, + ], + "request_id": "b8b42c55-347c-4704-b4c1-92220c01f4ac", + "type": "error.list", + }, + }, + ], + "status-code": 400, + "type": "unknown", + }, + "ForbiddenError": { + "docs": "API plan restricted", + "examples": [ + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "a91eac55-8d70-454d-a01d-c6bb875aaa35", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "c7a35217-6720-48bd-a2ae-c2acb5adea30", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "c7b0a10f-d482-4352-8d7b-1ad26b902473", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "cf6fb162-88c9-45ec-9f97-c3fcad93b7c1", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "9fe5809c-cf0b-4a0f-af80-9913d3beb1eb", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "a7e069bb-f013-45bc-8e0a-f58c3de4e034", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "037980c4-84cb-4d3a-ad64-66e4e563a275", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "3d1c3371-6ba4-4d5a-9368-ac983292136d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "d30f18d4-2e0a-4528-a66b-4590b733713c", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "API plan restricted", + "value": { + "errors": [ + { + "code": "api_plan_restricted", + "message": "Active subscription needed.", + }, + ], + "request_id": "fab7034a-78bd-4413-a652-8f38783e7bf1", + "type": "error.list", + }, + }, + ], + "status-code": 403, + "type": "Error", + }, + "NotFoundError": { + "docs": "Admin not found", + "examples": [ + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "admin_not_found", + "message": "Admin for admin_id not found", + }, + ], + "request_id": "9818bd03-9cc6-4ab8-8e7c-20a45ac58e97", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "admin_not_found", + "message": "Admin not found", + }, + ], + "request_id": "989bdb0b-1e8c-46cc-8953-9733dad40562", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Article not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "99c73902-e8ea-4872-b412-1d55ce4582fb", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Article Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "891b6ff4-181f-4b98-861b-d34ef16bfc4b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Article Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "60da5f23-613c-4f84-84bd-e9dbd3d67187", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Collection not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "2970f0f3-7020-4382-8892-eac24818ca88", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Collection Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "35e7f185-f547-4ae1-a23d-afc9027fc5a6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "collection Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a35712b4-90b6-47fb-843d-757d9fdd81e6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Collection not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "c6e7d3f6-8a46-460e-8264-e07c2e7302aa", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "c97dd75f-a434-4c83-a8e8-c4d1887d6c48", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "b49593ed-49a6-4497-8fb7-220ff74527f6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "b1ce72df-630f-4925-b212-fca6e833eb8d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "35a9b551-331e-499e-a63f-20396bfd29f5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "a6381081-a166-4e8e-952d-38bb2cd1c2b4", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "22add598-fd33-4c34-971f-cf215117aab3", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "b9d7374d-1780-4668-bb62-0e1ff9cdab45", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "32d121d8-fcbf-4c59-9c60-204f7d602f36", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company Not Found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "cd4f1648-724c-45f0-b6e1-72a1bc6479ee", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "d316defc-0a2f-49e7-b8ff-4cb6ccf46c90", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "e93f90a6-4c85-4dbf-b063-96b649318371", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "d7c69ce6-3195-46be-b2cb-0dce355d2919", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "3f481052-cf49-4b95-a492-734223865981", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "cf0f6fd6-7c5e-492b-909d-f60b35eea1c4", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "3f852f45-1a80-4ade-9bc6-72b377d2bbd8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "7bc429e4-e887-4f53-b69c-94e6e55d2125", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "66ebc1f5-5e02-4584-8028-f2559a41e8df", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "2b513026-b78c-4c67-b073-da0266f62cc7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "1bbd7e4b-718e-46f4-b682-a429aea78f01", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a1a28017-728a-423b-adc0-2705d375f533", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "6f735483-c309-4e94-b9ab-143aedc0c691", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "9e780671-29b3-4913-b4be-15234ea0bc6a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Conversation not found", + }, + ], + "request_id": "840d35aa-2414-402a-b3c6-763a410e0d16", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Conversation not found", + }, + ], + "request_id": "f78f63ba-911d-47b8-a389-b33e3ccbe77e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found", + }, + ], + "request_id": "0d00d069-2cf1-496f-b887-a4db74ee320d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "ed0ab0c5-57b8-4413-a7a9-bbc134b40876", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "978c1e65-1eba-4995-9acb-ff8f33b283e3", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "e4c692dd-cccd-46bf-834a-cda7a3a9029c", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "8193a639-aba8-4b0e-9fdd-ee48807e3ee7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "1bfc14e1-07ef-4999-9448-f029b112cf1b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "9d88a5a7-6df9-42ff-b324-2387db7be984", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "1fd64942-5bf0-4a51-a6cb-db4a778bb1f4", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Conversation not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "579f0f7a-d773-41d6-9d36-8cc0b3fbcc41", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Contact not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "44531412-2973-4b92-b14d-80abac5c1b4d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "conversation_part_or_message_not_found", + "message": "Conversation part or message not found", + }, + ], + "request_id": "0c016386-49f4-431f-92dc-7e739cbf98e1", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Attribute Not Found", + "value": { + "errors": [ + { + "code": "field_not_found", + "message": "We couldn't find that data attribute to update", + }, + ], + "request_id": "2680a225-4f79-4098-8438-8db993c639fe", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "0f4b439e-9b57-4019-886e-15cc08582914", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "fe6e217d-70bc-4090-b33a-b32ec0e6a391", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "News Item Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "a191b999-6f71-4676-a8db-1a79ccc4f114", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Note not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "7e37eb4e-9f1e-47fa-a393-8d9b2c20983a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Segment not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "fe79fa5e-c8eb-40a6-be76-d618833c2840", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Company not found", + "value": { + "errors": [ + { + "code": "company_not_found", + "message": "Company Not Found", + }, + ], + "request_id": "f0f84d9b-3c51-4904-9c21-34faba76ebf5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "User not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "User Not Found", + }, + ], + "request_id": "786848c6-5b9f-4e9b-aa78-2bdec45a09f5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "20b89fb6-f224-4f81-98ca-4cb4b36df959", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Resource not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "111586bb-ad78-43b9-b0a0-bf864d9a3744", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Team not found", + "value": { + "errors": [ + { + "code": "team_not_found", + "message": "Team not found", + }, + ], + "request_id": "4745dfce-7275-4864-abfd-44e0d84bf52a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Resource Not Found", + }, + ], + "request_id": "c23e8dab-6102-483c-bb1b-c62923be35ab", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Ticket not found", + "value": { + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found", + }, + ], + "request_id": "e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Ticket not found", + "value": { + "errors": [ + { + "code": "ticket_not_found", + "message": "Ticket not found", + }, + ], + "request_id": "ffa08bb4-3994-4132-b9e3-14837e0723e8", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Tag not found", + "value": { + "errors": [ + { + "code": "tag_not_found", + "message": "Tag not found", + }, + ], + "request_id": "d2385995-502c-4c03-bf4b-93ef3d24037b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Admin not found", + "value": { + "errors": [ + { + "code": "assignee_not_found", + "message": "Assignee not found", + }, + ], + "request_id": "809aceaa-c073-4e2a-96c3-a25e15576946", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Assignee not found", + "value": { + "errors": [ + { + "code": "assignee_not_found", + "message": "Assignee not found", + }, + ], + "request_id": "639b5b51-1eb9-4c06-8de4-d9b0e30fff05", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Visitor not found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found", + }, + ], + "request_id": "7359afef-98f5-4b22-9de7-902f7a214729", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "visitor Not Found", + "value": { + "errors": [ + { + "code": "not_found", + "message": "Visitor Not Found", + }, + ], + "request_id": "1f35dc86-17d2-4bfe-8cb1-9afa74adc24c", + "type": "error.list", + }, + }, + ], + "status-code": 404, + "type": "unknown", + }, + "UnauthorizedError": { + "docs": "Unauthorized", + "examples": [ + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "18722269-a019-46c4-87d7-50d0f6f8a990", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "06d9eefd-2b3a-48f7-938a-5a10383a4ebf", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4ba8121e-4a4a-4668-adb2-363c561f3c52", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "83978032-1473-4696-b755-b497d46a23cf", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "86d69044-5966-428e-9a40-2b39fba3f823", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f223a1d9-5377-4337-92bb-00fb39157f11", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "62ab4791-7e4d-4400-a56b-b06a0ce3ba1a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "15b4f214-c670-43d7-ad8f-648791fddf9b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "85d43c53-f28f-4295-b937-9a43ea71d0c3", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "626c6766-ee1a-489d-b87a-230d9b980c7d", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ccedcb48-7d08-4cc9-bcff-0622f70daf74", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bf1acd76-8c6e-45f4-8dbe-54391843270a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "67002700-07f8-4a56-a9bc-464254c3a5bd", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "794a475b-0155-40b2-a288-ba0d48fdbd3f", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c96a4779-a06d-45bb-aa39-eb96c587c2c7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "9b0d6fb9-d2d7-4904-a13c-97557a802323", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3f26a216-ddff-4782-9529-514f5bad56ea", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0a1a5065-69fe-47a4-9804-4cb2347671ef", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "fe20b681-f988-4154-bec9-a5087fe0842e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "66fcc654-48ed-4f53-824e-831b5c96c9dc", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6f8cb4ca-9a95-43bd-aee1-597b85d1d13f", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d211ec8c-df9b-420c-86df-23c27ad54bc5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "99739bbd-2dbe-4ce3-ae91-af23379b5cd7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d8c1ab2d-4044-4c4f-98f0-176860747112", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d2927c64-9c5a-4593-997b-381f8c2356ea", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "82a95655-569d-4e5d-b0d9-f8a6c7a379f3", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "377d162e-82a5-4148-a26f-29c9c760dadc", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "99fba0c6-2252-4658-abd2-1d2ff16a508b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "97383559-0fb0-4084-8a9a-8e3407c46108", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "63a2828f-107e-4d51-9398-a220b81a7bce", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e97d9f1b-8c9e-4caf-b473-3bce411c697e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f70085f1-f655-43ee-9585-d2061b260fcd", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b1b88e2d-938c-4a26-b65d-26ff65a0af36", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0bce3945-d2ec-4b8e-a790-b16fd52d9f11", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "57b64228-0e60-4e35-833d-39c4e4067dde", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d5bac7ff-7961-4fe5-8aed-6f1b031b38af", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c18ca0d4-ad2c-41e7-9a71-1df806f9c954", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "95cacea0-4744-4de8-a2bf-da4419f75732", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f083d6b1-e9d2-43b3-86df-67539007fc3e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "18db64a8-7a08-4967-9ec6-0416178306f9", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "af9757fc-4e1d-463c-ac9d-788503f04a95", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b1f6adfd-f7da-4880-8d11-d842235126ae", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "58e6b9ee-4a28-4597-9c20-faf34b6894dc", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7435aa28-13bd-40b1-ba99-66009e92a1ba", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ae0581d2-199e-437c-bf51-1eb9fe2e12fc", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "4f00c4c6-a8f7-436e-bf95-d1adfa315906", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d35f1b37-765c-4afe-8738-81c0560710a6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "1b830d07-a249-4ff8-a7bf-41bf83fd53b2", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6e76e914-a34d-4125-8310-62fdfc4e651e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b74d8980-6e99-44db-a3d8-2a65a63fe590", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0cfc97c0-32be-4e68-aef2-f5744e4e85f7", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bfdcc6de-2dcb-4725-acc7-232c10838586", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c6b3dcbd-33be-4a80-abb4-c5b3315250d0", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "110801d1-2f7b-436f-8f03-2245545a1432", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "ee3ea56e-d0ce-47db-871a-57740e165e5c", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7b27151d-7bb0-402e-87fe-5780690d9f32", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c36202f1-6bf3-4ea6-9442-192123f506b0", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "cc6af01d-81e3-4a74-8a62-807a3239e1ad", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "f780a591-4aa2-4382-80c4-e0f2d655bf2e", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d00f8d67-1e7c-464b-b0b7-b2409d706076", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "185ce494-34e2-4cda-85cb-c51ad7281292", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b29ebc05-ba35-4db8-aac6-d74617769643", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "d70c184d-852a-4f67-8298-3cf9a327adb3", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "a9c190ff-16eb-43f9-94fc-7c22da2766af", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "5fb6b003-d6a6-4641-b71b-c5c468c87448", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "5da7a3e7-dcb0-4378-8575-0a0e9bae3862", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "c83a3efe-433a-4555-a5e2-e393588be29f", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3609e8b1-a6aa-4c57-a994-3d95743f20a2", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "76a1d79d-3f0d-49bb-8d15-38d1ae6df738", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3dcedf54-ed30-4337-8992-94e36900e695", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "006b2c8f-9a29-463e-be69-ad213576aee6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "110ad8e4-99ed-461a-bd93-92a5cdbaa6b2", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "3bc672fa-e051-4ede-b6e9-79f518231ba9", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "6e45414c-e627-4769-bdbd-d51f2c19e1e9", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "50823491-2ab1-4b84-9700-2d92c4f367fd", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "7c4784fe-d3e4-4182-b9c4-918bdf253eef", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "b0100f38-119c-4e30-8560-a25561d97c66", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "2b0554fe-ba10-41d4-ab7b-715c2b7b8e47", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "bb012854-cca8-4fa7-972e-6c38204e8294", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "a502f48f-c80d-48fd-bea5-cafe7e24d9f9", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "745c921a-7c5a-40d4-ab28-6d28a8d2ed47", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e7ba89f2-3bc8-4fc3-97bc-56f62f342680", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "e5202025-e8f9-400a-9107-192ae8bfd50c", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "25dace4f-4916-492c-823b-f0cca227dff0", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "82df3971-fb7c-410d-a919-e8bc1b3d991a", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Unauthorized", + "value": { + "errors": [ + { + "code": "unauthorized", + "message": "Access Token Invalid", + }, + ], + "request_id": "fe1a587a-e682-4a96-bd30-ea08b726e6fa", + "type": "error.list", + }, + }, + ], + "status-code": 401, + "type": "Error", + }, + "UnprocessableEntityError": { + "docs": "Last customer", + "examples": [ + { + "docs": undefined, + "name": "Last customer", + "value": { + "errors": [ + { + "code": "parameter_invalid", + "message": "Removing the last customer is not allowed", + }, + ], + "request_id": "35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "Has Dependant Object", + "value": { + "errors": [ + { + "code": "data_invalid", + "message": "The Data Attribute you are trying to archive has a dependant object", + }, + ], + "request_id": "fbc508f1-9cbf-4134-90ea-baa1065760d2", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "No subject supplied for email message", + "value": { + "errors": [ + { + "code": "parameter_not_found", + "message": "No subject supplied for email message", + }, + ], + "request_id": "f54ba906-3255-4fc6-a660-0dab0043ff2b", + "type": "error.list", + }, + }, + { + "docs": undefined, + "name": "unprocessable entity", + "value": { + "error_key": "some_error", + }, + }, + ], + "status-code": 422, + "type": "unknown", + }, + }, + "imports": { + "admins": "admins.yml", + "aiContentSource": "aiContentSource.yml", + "articles": "articles.yml", + "companies": "companies.yml", + "contacts": "contacts.yml", + "conversations": "conversations.yml", + "customObjectInstances": "customObjectInstances.yml", + "dataAttributes": "dataAttributes.yml", + "dataEvents": "dataEvents.yml", + "helpCenter": "helpCenter.yml", + "news": "news.yml", + "notes": "notes.yml", + "segments": "segments.yml", + "subscriptionTypes": "subscriptionTypes.yml", + "tags": "tags.yml", + "teams": "teams.yml", + "tickets": "tickets.yml", + }, + "types": { + "ActivityLog": { + "docs": "Activities performed by Admins.", + "properties": { + "activity_description": { + "docs": "A sentence or two describing the activity.", + "type": "optional", + }, + "activity_type": { + "type": "optional", + }, + "created_at": { + "docs": "The time the activity was created.", + "type": "optional", + }, + "id": { + "docs": "The id representing the activity.", + "type": "optional", + }, + "metadata": { + "type": "optional", + }, + "performed_by": { + "docs": "Details about the Admin involved in the activity.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogActivityType": { + "enum": [ + "admin_assignment_limit_change", + "admin_away_mode_change", + "admin_deletion", + "admin_deprovisioned", + "admin_impersonation_end", + "admin_impersonation_start", + "admin_invite_change", + "admin_invite_creation", + "admin_invite_deletion", + "admin_login_failure", + "admin_login_success", + "admin_logout", + "admin_password_reset_request", + "admin_password_reset_success", + "admin_permission_change", + "admin_provisioned", + "admin_two_factor_auth_change", + "admin_unauthorized_sign_in_method", + "app_admin_join", + "app_authentication_method_change", + "app_data_deletion", + "app_data_export", + "app_google_sso_domain_change", + "app_identity_verification_change", + "app_name_change", + "app_outbound_address_change", + "app_package_installation", + "app_package_token_regeneration", + "app_package_uninstallation", + "app_team_creation", + "app_team_deletion", + "app_team_membership_modification", + "app_timezone_change", + "app_webhook_creation", + "app_webhook_deletion", + "articles_in_messenger_enabled_change", + "bulk_delete", + "bulk_export", + "campaign_deletion", + "campaign_state_change", + "conversation_part_deletion", + "conversation_topic_change", + "conversation_topic_creation", + "conversation_topic_deletion", + "help_center_settings_change", + "inbound_conversations_change", + "inbox_access_change", + "message_deletion", + "message_state_change", + "messenger_look_and_feel_change", + "messenger_search_required_change", + "messenger_spaces_change", + "office_hours_change", + "role_change", + "role_creation", + "role_deletion", + "ruleset_activation_title_preview", + "ruleset_creation", + "ruleset_deletion", + "search_browse_enabled_change", + "search_browse_required_change", + "seat_change", + "seat_revoke", + "security_settings_change", + "temporary_expectation_change", + "upfront_email_collection_change", + "welcome_message_change", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogList": { + "docs": "A paginated list of activity logs.", + "properties": { + "activity_logs": { + "docs": "An array of activity logs", + "type": "optional>>", + }, + "pages": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `activity_log.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogMetadata": { + "docs": "Additional data provided about Admin activity.", + "properties": { + "auto_changed": { + "docs": "Indicates if the status was changed automatically or manually.", + "type": "optional", + }, + "away_mode": { + "docs": "The away mode status which is set to true when away and false when returned.", + "type": "optional", + }, + "away_status_reason": { + "docs": "The reason the Admin is away.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "reassign_conversations": { + "docs": "Indicates if conversations should be reassigned while an Admin is away.", + "type": "optional", + }, + "sign_in_method": { + "docs": "The way the admin signed in.", + "type": "optional", + }, + "source": { + "docs": "The action that initiated the status change.", + "type": "optional", + }, + "update_by": { + "docs": "The ID of the Admin who initiated the activity.", + "type": "optional", + }, + "update_by_name": { + "docs": "The name of the Admin who initiated the activity.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ActivityLogPerformedBy": { + "docs": "Details about the Admin involved in the activity.", + "properties": { + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "ip": { + "docs": "The IP address of the admin.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AddressableList": { + "docs": "A list used to access other resources from a parent model.", + "properties": { + "id": { + "docs": "The id of the addressable object", + "type": "optional", + }, + "type": { + "docs": "The addressable object type", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Admin": { + "docs": "Admins are the teammate accounts that have access to a workspace", + "properties": { + "app": { + "docs": "App that the admin belongs to.", + "type": "optional", + }, + "avatar": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional", + }, + "away_mode_enabled": { + "docs": "Identifies if this admin is currently set in away mode.", + "type": "optional", + }, + "away_mode_reassign": { + "docs": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "type": "optional", + }, + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "email_verified": { + "docs": "Identifies if this admin's email is verified.", + "type": "optional", + }, + "has_inbox_seat": { + "docs": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "job_title": { + "docs": "The job title of the admin.", + "type": "optional", + }, + "name": { + "docs": "The name of the admin.", + "type": "optional", + }, + "team_ids": { + "docs": "This is a list of ids of the teams that this admin is part of.", + "type": "optional>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminPriorityLevel": { + "docs": "Admin priority levels for the team", + "properties": { + "primary_admin_ids": { + "docs": "The primary admin ids for the team", + "type": "optional>", + }, + "secondary_admin_ids": { + "docs": "The secondary admin ids for the team", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyConversationRequest": { + "docs": "Payload of the request to reply on behalf of an admin", + "properties": { + "admin_id": { + "docs": "The id of the admin who is authoring the comment.", + "type": "string", + }, + "attachment_files": { + "docs": "A list of files that will be added as attachments. You can include up to 10 files", + "type": "optional>", + }, + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "type": "optional", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "AdminReplyConversationRequestMessageType", + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyConversationRequestMessageType": { + "enum": [ + "comment", + "note", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequest": { + "docs": "Payload of the request to reply on behalf of an admin", + "properties": { + "admin_id": { + "docs": "The id of the admin who is authoring the comment.", + "type": "string", + }, + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the reply. Notes accept some HTML formatting. Must be present for comment and note message types.", + "type": "optional", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "AdminReplyTicketRequestMessageType", + "reply_options": { + "docs": "The quick reply options to display. Must be present for quick_reply message types.", + "type": "optional>", + }, + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequestMessageType": { + "enum": [ + "comment", + "note", + "quick_reply", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminReplyTicketRequestReplyOptionsItem": { + "docs": undefined, + "properties": { + "text": { + "docs": "The text to display in this quick reply option.", + "type": "string", + }, + "uuid": { + "docs": "A unique identifier for this quick reply option. This value will be available within the metadata of the comment ticket part that is created when a user clicks on this reply option.", + "type": "string", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AdminWithAppAvatar": { + "docs": "This object represents the avatar associated with the admin.", + "properties": { + "image_url": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "default": "avatar", + "docs": "This is a string that identifies the type of the object. It will always have the value `avatar`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Admins": { + "docs": "A list of admins associated with a given workspace.", + "properties": { + "admins": { + "docs": "A list of admins associated with a given workspace.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "App": { + "docs": "App is a workspace on Intercom", + "properties": { + "created_at": { + "docs": "When the app was created.", + "type": "optional", + }, + "id_code": { + "docs": "The id of the app.", + "type": "optional", + }, + "identity_verification": { + "docs": "Whether or not the app uses identity verification.", + "type": "optional", + }, + "name": { + "docs": "The name of the app.", + "type": "optional", + }, + "region": { + "docs": "The Intercom region the app is located in.", + "type": "optional", + }, + "timezone": { + "docs": "The timezone of the region where the app is located.", + "type": "optional", + }, + "type": { + "default": "app", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleContent": { + "docs": "The Content of an Article.", + "properties": { + "author_id": { + "docs": "The ID of the author of the article.", + "type": "optional", + }, + "body": { + "docs": "The body of the article.", + "type": "optional", + }, + "created_at": { + "docs": "The time when the article was created (seconds).", + "type": "optional", + }, + "description": { + "docs": "The description of the article.", + "type": "optional", + }, + "state": { + "docs": "Whether the article is `published` or is a `draft` .", + "type": "optional", + }, + "title": { + "docs": "The title of the article.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `article_content` .", + "type": "optional", + }, + "updated_at": { + "docs": "The time when the article was last updated (seconds).", + "type": "optional", + }, + "url": { + "docs": "The URL of the article.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleContentState": { + "docs": "Whether the article is `published` or is a `draft` .", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleStatistics": { + "docs": "The statistics of an article.", + "properties": { + "conversions": { + "docs": "The number of conversations started from the article.", + "type": "optional", + }, + "happy_reaction_percentage": { + "docs": "The percentage of happy reactions the article has received against other types of reaction.", + "type": "optional", + }, + "neutral_reaction_percentage": { + "docs": "The percentage of neutral reactions the article has received against other types of reaction.", + "type": "optional", + }, + "reactions": { + "docs": "The number of total reactions the article has received.", + "type": "optional", + }, + "sad_reaction_percentage": { + "docs": "The percentage of sad reactions the article has received against other types of reaction.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `article_statistics`.", + "type": "optional>", + }, + "views": { + "docs": "The number of total views the article has received.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleTranslatedContent": { + "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "properties": { + "ar": { + "docs": "The content of the article in Arabic", + "type": "optional", + }, + "bg": { + "docs": "The content of the article in Bulgarian", + "type": "optional", + }, + "bs": { + "docs": "The content of the article in Bosnian", + "type": "optional", + }, + "ca": { + "docs": "The content of the article in Catalan", + "type": "optional", + }, + "cs": { + "docs": "The content of the article in Czech", + "type": "optional", + }, + "da": { + "docs": "The content of the article in Danish", + "type": "optional", + }, + "de": { + "docs": "The content of the article in German", + "type": "optional", + }, + "el": { + "docs": "The content of the article in Greek", + "type": "optional", + }, + "en": { + "docs": "The content of the article in English", + "type": "optional", + }, + "es": { + "docs": "The content of the article in Spanish", + "type": "optional", + }, + "et": { + "docs": "The content of the article in Estonian", + "type": "optional", + }, + "fi": { + "docs": "The content of the article in Finnish", + "type": "optional", + }, + "fr": { + "docs": "The content of the article in French", + "type": "optional", + }, + "he": { + "docs": "The content of the article in Hebrew", + "type": "optional", + }, + "hr": { + "docs": "The content of the article in Croatian", + "type": "optional", + }, + "hu": { + "docs": "The content of the article in Hungarian", + "type": "optional", + }, + "id": { + "docs": "The content of the article in Indonesian", + "type": "optional", + }, + "it": { + "docs": "The content of the article in Italian", + "type": "optional", + }, + "ja": { + "docs": "The content of the article in Japanese", + "type": "optional", + }, + "ko": { + "docs": "The content of the article in Korean", + "type": "optional", + }, + "lt": { + "docs": "The content of the article in Lithuanian", + "type": "optional", + }, + "lv": { + "docs": "The content of the article in Latvian", + "type": "optional", + }, + "mn": { + "docs": "The content of the article in Mongolian", + "type": "optional", + }, + "nb": { + "docs": "The content of the article in Norwegian", + "type": "optional", + }, + "nl": { + "docs": "The content of the article in Dutch", + "type": "optional", + }, + "pl": { + "docs": "The content of the article in Polish", + "type": "optional", + }, + "pt": { + "docs": "The content of the article in Portuguese (Portugal)", + "type": "optional", + }, + "pt-BR": { + "docs": "The content of the article in Portuguese (Brazil)", + "type": "optional", + }, + "ro": { + "docs": "The content of the article in Romanian", + "type": "optional", + }, + "ru": { + "docs": "The content of the article in Russian", + "type": "optional", + }, + "sl": { + "docs": "The content of the article in Slovenian", + "type": "optional", + }, + "sr": { + "docs": "The content of the article in Serbian", + "type": "optional", + }, + "sv": { + "docs": "The content of the article in Swedish", + "type": "optional", + }, + "tr": { + "docs": "The content of the article in Turkish", + "type": "optional", + }, + "type": { + "docs": "The type of object - article_translated_content.", + "type": "optional", + }, + "vi": { + "docs": "The content of the article in Vietnamese", + "type": "optional", + }, + "zh-CN": { + "docs": "The content of the article in Chinese (China)", + "type": "optional", + }, + "zh-TW": { + "docs": "The content of the article in Chinese (Taiwan)", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Articles": { + "docs": "This will return a list of articles for the App.", + "properties": { + "data": { + "docs": "An array of Article objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of articles.", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AssignConversationRequest": { + "docs": "Payload of the request to assign a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "assignee_id": { + "docs": "The `id` of the `admin` or `team` which will be assigned the conversation. A conversation can be assigned both an admin and a team.\nSet `0` if you want this assign to no admin or team (ie. Unassigned).", + "type": "string", + }, + "body": { + "docs": "Optionally you can send a response in the conversation when it is assigned.", + "type": "optional", + }, + "type": "AssignConversationRequestType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AssignConversationRequestType": { + "enum": [ + "admin", + "team", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CloseConversationRequest": { + "docs": "Payload of the request to close a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "body": { + "docs": "Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.", + "type": "optional", + }, + "type": "literal<"admin">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Collections": { + "docs": "This will return a list of Collections for the App.", + "properties": { + "data": { + "docs": "An array of collection objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of collections.", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Companies": { + "docs": "This will return a list of companies for the App.", + "properties": { + "data": { + "docs": "An array containing Company Objects.", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyAttachedContacts": { + "docs": "A list of Contact Objects", + "properties": { + "data": { + "docs": "An array containing Contact Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of contacts", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyAttachedSegments": { + "docs": "A list of Segment Objects", + "properties": { + "data": { + "docs": "An array containing Segment Objects", + "type": "optional>", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyScroll": { + "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "properties": { + "data": { + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "scroll_param": { + "docs": "The scroll parameter to use in the next request to fetch the next page of results.", + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies", + "type": "optional", + }, + "type": { + "docs": "The type of object - `list`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactArchived": { + "docs": "archived contact object", + "properties": { + "archived": { + "docs": "Whether the contact is archived or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactAttachedCompanies": { + "docs": "A list of Company Objects", + "properties": { + "companies": { + "docs": "An array containing Company Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of companies associated to this contact", + "type": "optional", + }, + "type": { + "docs": "The type of object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactCompanies": { + "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of companyies attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactDeleted": { + "docs": "deleted contact object", + "properties": { + "deleted": { + "docs": "Whether the contact is deleted or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactList": { + "docs": "Contacts are your users in Intercom.", + "properties": { + "data": { + "docs": "The list of contact objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactLocation": { + "docs": "An object containing location meta data about a Intercom contact.", + "properties": { + "city": { + "docs": "The city that the contact is located in", + "type": "optional", + }, + "country": { + "docs": "The country that the contact is located in", + "type": "optional", + }, + "region": { + "docs": "The overal region that the contact is located in", + "type": "optional", + }, + "type": { + "docs": "Always location", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactNotes": { + "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "data": { + "docs": "This object represents the notes attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of companyies attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more company resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReference": { + "docs": "reference to contact object", + "properties": { + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyBaseRequest": { + "docs": undefined, + "properties": { + "attachment_urls": { + "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", + "type": "optional>", + }, + "body": { + "docs": "The text body of the comment.", + "type": "string", + }, + "created_at": { + "docs": "The time the reply was created. If not provided, the current time will be used.", + "type": "optional", + }, + "message_type": "literal<"comment">", + "type": "literal<"user">", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyConversationRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyIntercomUserIdRequest", + }, + { + "type": "Email", + }, + { + "type": "ContactReplyUserIdRequest", + }, + ], + }, + "ContactReplyIntercomUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "attachment_files": { + "docs": "A list of files that will be added as attachments.", + "type": "optional>", + }, + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyTicketIntercomUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `intercom_user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyTicketRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyTicketIntercomUserIdRequest", + }, + { + "type": "ContactReplyTicketUserIdRequest", + }, + { + "type": "Email", + }, + ], + }, + "ContactReplyTicketUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "user_id": { + "docs": "The external_id you have defined for the contact.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactReplyUserIdRequest": { + "docs": "Payload of the request to reply on behalf of a contact using their `user_id`", + "extends": [ + "ContactReplyBaseRequest", + ], + "properties": { + "attachment_files": { + "docs": "A list of files that will be added as attachments. You can include up to 10 files.", + "type": "optional>", + }, + "user_id": { + "docs": "The external_id you have defined for the contact.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactSocialProfiles": { + "docs": "An object containing social profiles that a contact has.", + "properties": { + "data": { + "docs": "A list of social profiles objects associated with the contact.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactSubscriptionTypes": { + "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", + "properties": { + "data": { + "docs": "This object represents the subscriptions attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of subscription types attached to this contact", + "type": "optional", + }, + "url": { + "docs": "Url to get more subscription type resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactTags": { + "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "properties": { + "data": { + "docs": "This object represents the tags attached to a contact.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", + "type": "optional", + }, + "total_count": { + "docs": "Int representing the total number of tags attached to this contact", + "type": "optional", + }, + "url": { + "docs": "url to get more tag resources for this contact", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactUnarchived": { + "docs": "unarchived contact object", + "properties": { + "archived": { + "docs": "Whether the contact is archived or not.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "always contact", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Contacts": { + "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "properties": { + "contacts": { + "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "type": "optional>", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContentSourcesList": { + "docs": undefined, + "properties": { + "content_sources": { + "docs": "The content sources used by AI Agent in the conversation.", + "type": "optional>", + }, + "total_count": { + "docs": "The total number of content sources used by AI Agent in the conversation.", + "type": "optional", + }, + "type": { + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationAttachmentFiles": { + "docs": "Properties of the attachment files in a conversation part", + "properties": { + "content_type": { + "docs": "The content type of the file", + "type": "optional", + }, + "data": { + "docs": "The base64 encoded file data.", + "type": "optional", + }, + "name": { + "docs": "The name of the file.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationFirstContactReply": { + "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "properties": { + "created_at": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + "url": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationList": { + "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "properties": { + "conversations": { + "docs": "The list of conversation objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always conversation.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPart": { + "docs": "A Conversation Part represents a message in the conversation.", + "properties": { + "assigned_to": { + "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", + "type": "optional", + }, + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation part was created.", + "type": "optional", + }, + "external_id": { + "docs": "The external id of the conversation part", + "type": "optional", + }, + "id": { + "docs": "The id representing the conversation part.", + "type": "optional", + }, + "notified_at": { + "docs": "The time the user was notified with the conversation part.", + "type": "optional", + }, + "part_type": { + "docs": "The type of conversation part.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the conversation part has been redacted.", + "type": "optional", + }, + "type": { + "docs": "Always conversation_part", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the conversation part was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPartAuthor": { + "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "properties": { + "email": { + "docs": "The email of the author", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "id": { + "docs": "The id of the author", + "type": "optional", + }, + "name": { + "docs": "The name of the author", + "type": "optional", + }, + "type": { + "docs": "The type of the author", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationParts": { + "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "properties": { + "conversation_parts": { + "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "type": "optional>", + }, + "total_count": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationRating": { + "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "properties": { + "contact": { + "type": "optional", + }, + "created_at": { + "docs": "The time the rating was requested in the conversation being rated.", + "type": "optional", + }, + "rating": { + "docs": "The rating, between 1 and 5, for the conversation.", + "type": "optional", + }, + "remark": { + "docs": "An optional field to add a remark to correspond to the number rating", + "type": "optional", + }, + "teammate": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationSource": { + "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "properties": { + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.", + "type": "optional", + }, + "delivered_as": { + "docs": "The conversation's initiation type. Possible values are customer_initiated, campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), automated (Series and other outbounds with dynamic audience message) and admin_initiated (fixed audience message, ticket initiated by an admin, group email).", + "type": "optional", + }, + "id": { + "docs": "The id representing the message.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the source message has been redacted. Only applicable for contact initiated messages.", + "type": "optional", + }, + "subject": { + "docs": "Optional. The message subject. For Twitter, this will show a generic message regarding why the subject is obscured.", + "type": "optional", + }, + "type": { + "docs": "This includes conversation, email, facebook, instagram, phone_call, phone_switch, push, sms, twitter and whatsapp.", + "type": "optional", + }, + "url": { + "docs": "The URL where the conversation was started. For Twitter, Email, and Bots, this will be blank.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationStatistics": { + "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "properties": { + "count_assignments": { + "docs": "Number of assignments after first_contact_reply_at.", + "type": "optional", + }, + "count_conversation_parts": { + "docs": "Total number of conversation parts.", + "type": "optional", + }, + "count_reopens": { + "docs": "Number of reopens after first_contact_reply_at.", + "type": "optional", + }, + "first_admin_reply_at": { + "docs": "Time of first admin reply after first_contact_reply_at.", + "type": "optional", + }, + "first_assignment_at": { + "docs": "Time of first assignment after first_contact_reply_at.", + "type": "optional", + }, + "first_close_at": { + "docs": "Time of first close after first_contact_reply_at.", + "type": "optional", + }, + "first_contact_reply_at": { + "docs": "Time of first text conversation part from a contact.", + "type": "optional", + }, + "last_admin_reply_at": { + "docs": "Time of the last conversation part from an admin.", + "type": "optional", + }, + "last_assignment_admin_reply_at": { + "docs": "Time of first admin reply since most recent assignment.", + "type": "optional", + }, + "last_assignment_at": { + "docs": "Time of last assignment after first_contact_reply_at.", + "type": "optional", + }, + "last_close_at": { + "docs": "Time of the last conversation close.", + "type": "optional", + }, + "last_closed_by_id": { + "docs": "The last admin who closed the conversation. Returns a reference to an Admin object.", + "type": "optional", + }, + "last_contact_reply_at": { + "docs": "Time of the last conversation part from a contact.", + "type": "optional", + }, + "median_time_to_reply": { + "docs": "Median based on all admin replies after a contact reply. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_admin_reply": { + "docs": "Duration until first admin reply. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_assignment": { + "docs": "Duration until last assignment before first admin reply. In seconds.", + "type": "optional", + }, + "time_to_first_close": { + "docs": "Duration until conversation was closed first time. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "time_to_last_close": { + "docs": "Duration until conversation was closed last time. Subtracts out of business hours. In seconds.", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationTeammates": { + "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "properties": { + "teammates": { + "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - `admin.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateArticleRequest": { + "docs": "You can create an Article", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "integer", + }, + "body": { + "docs": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "type": "string", + }, + "translated_content": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateArticleRequestState": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateContactRequestTwo": "unknown", + "CreateDataEventRequestTwo": "unknown", + "CreateMessageRequestOne": "unknown", + "CreateOrUpdateCompanyRequest": { + "docs": "You can create or update a Company", + "properties": { + "company_id": { + "docs": "The company id you have defined for the company. Can't be updated", + "type": "optional", + }, + "custom_attributes": { + "docs": "A hash of key/value pairs containing any other data about the company you want Intercom to store.", + "type": "optional>", + }, + "industry": { + "docs": "The industry that this company operates in.", + "type": "optional", + }, + "monthly_spend": { + "docs": "How much revenue the company generates for your business. Note that this will truncate floats. i.e. it only allow for whole integers, 155.98 will be truncated to 155. Note that this has an upper limit of 2**31-1 or 2147483647..", + "type": "optional", + }, + "name": { + "docs": "The name of the Company", + "type": "optional", + }, + "plan": { + "docs": "The name of the plan you have associated with the company.", + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the company was created by you.", + "type": "optional", + }, + "size": { + "docs": "The number of employees in this company.", + "type": "optional", + }, + "website": { + "docs": "The URL for this company's website. Please note that the value specified here is not validated. Accepts any string.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateOrUpdateTagRequest": { + "docs": "You can create or update an existing tag.", + "properties": { + "id": { + "docs": "The id of tag to updates.", + "type": "optional", + }, + "name": { + "docs": "The name of the tag, which will be created if not found, or the new name for the tag if this is an update request. Names are case insensitive.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreatePhoneSwitchRequest": { + "docs": "You can create an phone switch", + "properties": { + "custom_attributes": { + "type": "optional", + }, + "phone": { + "docs": "Phone number in E.164 format, that will receive the SMS to continue the conversation in the Messenger.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketReplyWithCommentRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyTicketRequest", + }, + { + "type": "AdminReplyTicketRequest", + }, + ], + }, + "CreateTicketTypeRequest": { + "docs": "The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "properties": { + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type.", + "type": "optional", + }, + "icon": { + "default": "🎟️", + "docs": "The icon of the ticket type.", + "type": "optional", + }, + "is_internal": { + "default": false, + "docs": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketTypeRequestCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CursorPages": { + "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. +A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. +", + "properties": { + "next": { + "type": "optional", + }, + "page": { + "docs": "The current page", + "type": "optional", + }, + "per_page": { + "docs": "Number of results per page", + "type": "optional", + }, + "total_pages": { + "docs": "Total number of pages", + "type": "optional", + }, + "type": { + "docs": "the type of object `pages`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CustomAttributes": { + "docs": "An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.", + "type": "map", + }, + "CustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "string", + { + "type": "optional", + }, + ], + }, + "CustomerRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "CustomerRequestIntercomUserId", + }, + { + "type": "CustomerRequestUserId", + }, + { + "type": "Email", + }, + ], + }, + "CustomerRequestIntercomUserId": { + "docs": undefined, + "properties": { + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CustomerRequestUserId": { + "docs": undefined, + "properties": { + "user_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeList": { + "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "properties": { + "data": { + "docs": "A list of data attributes", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventList": { + "docs": "This will return a list of data events for the App.", + "properties": { + "events": { + "docs": "A list of data events", + "type": "optional>", + }, + "pages": { + "docs": "Pagination", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventListPages": { + "docs": "Pagination", + "properties": { + "next": "optional", + "since": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventSummary": { + "docs": "This will return a summary of data events for the App.", + "properties": { + "email": { + "docs": "The email address of the user", + "type": "optional", + }, + "events": { + "docs": "A summary of data events", + "type": "optional>>", + }, + "intercom_user_id": { + "docs": "The Intercom user ID of the user", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + "user_id": { + "docs": "The user ID of the user", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEventSummaryItem": { + "docs": "This will return a summary of a data event for the App.", + "properties": { + "count": { + "docs": "The number of times the event was sent", + "type": "optional", + }, + "description": { + "docs": "The description of the event", + "type": "optional", + }, + "first": { + "docs": "The first time the event was sent", + "type": "optional", + }, + "last": { + "docs": "The last time the event was sent", + "type": "optional", + }, + "name": { + "docs": "The name of the event", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataExportCsv": { + "docs": "A CSV output file", + "properties": { + "company_id": { + "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", + "type": "optional", + }, + "content_id": { + "docs": "The specific content that was received. In an A/B test each version has its own Content ID.", + "type": "optional", + }, + "content_title": { + "docs": "The title of the content you see in your Intercom workspace.", + "type": "optional", + }, + "content_type": { + "docs": "Email, Chat, Post etc.", + "type": "optional", + }, + "email": { + "docs": "The users email who was sent the message.", + "type": "optional", + }, + "first_click": { + "docs": "The first time the series the user clicked on a link within this message.", + "type": "optional", + }, + "first_completion": { + "docs": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.", + "type": "optional", + }, + "first_dismisall": { + "docs": "The first time the series the user dismissed this message.", + "type": "optional", + }, + "first_goal_success": { + "docs": "The first time the user met this messages associated goal if one exists.", + "type": "optional", + }, + "first_hard_bounce": { + "docs": "The first time this message hard bounced for this user", + "type": "optional", + }, + "first_open": { + "docs": "The first time the user opened this message.", + "type": "optional", + }, + "first_reply": { + "docs": "The first time a user replied to this message if the content was able to receive replies.", + "type": "optional", + }, + "first_series_completion": { + "docs": "The first time the series this message was a part of was completed by the user.", + "type": "optional", + }, + "first_series_disengagement": { + "docs": "The first time the series this message was a part of was disengaged by the user.", + "type": "optional", + }, + "first_series_exit": { + "docs": "The first time the series this message was a part of was exited by the user.", + "type": "optional", + }, + "first_unsubscribe": { + "docs": "The first time the user unsubscribed from this message.", + "type": "optional", + }, + "name": { + "docs": "The full name of the user receiving the message", + "type": "optional", + }, + "node_id": { + "docs": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.", + "type": "optional", + }, + "receipt_id": { + "docs": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.", + "type": "optional", + }, + "received_at": { + "docs": "Timestamp for when the receipt was recorded.", + "type": "optional", + }, + "ruleset_id": { + "docs": "The id of the message.", + "type": "optional", + }, + "ruleset_version_id": { + "docs": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.", + "type": "optional", + }, + "series_id": { + "docs": "The id of the series that this content is part of. Will return -1 if not part of a series.", + "type": "optional", + }, + "series_title": { + "docs": "The title of the series that this content is part of.", + "type": "optional", + }, + "user_external_id": { + "docs": "The external_user_id of the user who was sent the message", + "type": "optional", + }, + "user_id": { + "docs": "The user_id of the user who was sent the message.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedArticleObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the article was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the article which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - article", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedCollectionObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the collection was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the collection which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - `collection`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedCompanyObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the company was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the company which is given by Intercom.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted. - `company`", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeletedObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "deleted": { + "docs": "Whether the news item was deleted successfully or not.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the news item which you provided in the URL.", + "type": "optional", + }, + "object": { + "docs": "The type of object which was deleted - news-item.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "email": { + "docs": "The email you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Error": { + "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "properties": { + "errors": { + "docs": "An array of one or more error objects", + "type": "list", + }, + "request_id": { + "docs": "", + "type": "optional", + "validation": { + "format": "uuid", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "docs": "The type is error.list", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ErrorErrorsItem": { + "docs": undefined, + "properties": { + "code": { + "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", + "type": "string", + }, + "field": { + "docs": "Optional. Used to identify a particular field or query parameter that was in error.", + "type": "optional", + }, + "message": { + "docs": "Optional. Human readable description of the error.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "File": { + "docs": "The value describing a file upload set for a custom attribute", + "properties": { + "content_type": { + "docs": "The type of file", + "type": "optional", + }, + "filesize": { + "docs": "The size of the file in bytes", + "type": "optional", + }, + "height": { + "docs": "The height of the file in pixels, if applicable", + "type": "optional", + }, + "name": { + "docs": "The name of the file", + "type": "optional", + }, + "type": { + "type": "optional", + }, + "url": { + "docs": "The url of the file. This is a temporary URL and will expire after 30 minutes.", + "type": "optional", + }, + "width": { + "docs": "The width of the file in pixels, if applicable", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "GroupContent": { + "docs": "The Content of a Group.", + "properties": { + "description": { + "docs": "The description of the collection. Only available for collections.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection or section.", + "type": "optional", + }, + "type": { + "docs": "The type of object - `group_content` .", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "GroupTranslatedContent": { + "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "properties": { + "ar": { + "docs": "The content of the group in Arabic", + "type": "optional", + }, + "bg": { + "docs": "The content of the group in Bulgarian", + "type": "optional", + }, + "bs": { + "docs": "The content of the group in Bosnian", + "type": "optional", + }, + "ca": { + "docs": "The content of the group in Catalan", + "type": "optional", + }, + "cs": { + "docs": "The content of the group in Czech", + "type": "optional", + }, + "da": { + "docs": "The content of the group in Danish", + "type": "optional", + }, + "de": { + "docs": "The content of the group in German", + "type": "optional", + }, + "el": { + "docs": "The content of the group in Greek", + "type": "optional", + }, + "en": { + "docs": "The content of the group in English", + "type": "optional", + }, + "es": { + "docs": "The content of the group in Spanish", + "type": "optional", + }, + "et": { + "docs": "The content of the group in Estonian", + "type": "optional", + }, + "fi": { + "docs": "The content of the group in Finnish", + "type": "optional", + }, + "fr": { + "docs": "The content of the group in French", + "type": "optional", + }, + "he": { + "docs": "The content of the group in Hebrew", + "type": "optional", + }, + "hr": { + "docs": "The content of the group in Croatian", + "type": "optional", + }, + "hu": { + "docs": "The content of the group in Hungarian", + "type": "optional", + }, + "id": { + "docs": "The content of the group in Indonesian", + "type": "optional", + }, + "it": { + "docs": "The content of the group in Italian", + "type": "optional", + }, + "ja": { + "docs": "The content of the group in Japanese", + "type": "optional", + }, + "ko": { + "docs": "The content of the group in Korean", + "type": "optional", + }, + "lt": { + "docs": "The content of the group in Lithuanian", + "type": "optional", + }, + "lv": { + "docs": "The content of the group in Latvian", + "type": "optional", + }, + "mn": { + "docs": "The content of the group in Mongolian", + "type": "optional", + }, + "nb": { + "docs": "The content of the group in Norwegian", + "type": "optional", + }, + "nl": { + "docs": "The content of the group in Dutch", + "type": "optional", + }, + "pl": { + "docs": "The content of the group in Polish", + "type": "optional", + }, + "pt": { + "docs": "The content of the group in Portuguese (Portugal)", + "type": "optional", + }, + "pt-BR": { + "docs": "The content of the group in Portuguese (Brazil)", + "type": "optional", + }, + "ro": { + "docs": "The content of the group in Romanian", + "type": "optional", + }, + "ru": { + "docs": "The content of the group in Russian", + "type": "optional", + }, + "sl": { + "docs": "The content of the group in Slovenian", + "type": "optional", + }, + "sr": { + "docs": "The content of the group in Serbian", + "type": "optional", + }, + "sv": { + "docs": "The content of the group in Swedish", + "type": "optional", + }, + "tr": { + "docs": "The content of the group in Turkish", + "type": "optional", + }, + "type": { + "docs": "The type of object - group_translated_content.", + "type": "optional", + }, + "vi": { + "docs": "The content of the group in Vietnamese", + "type": "optional", + }, + "zh-CN": { + "docs": "The content of the group in Chinese (China)", + "type": "optional", + }, + "zh-TW": { + "docs": "The content of the group in Chinese (Taiwan)", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "IntercomVersion": { + "default": "2.11", + "docs": "Intercom API version.
By default, it's equal to the version set in the app package.", + "enum": [ + { + "name": "One0", + "value": "1.0", + }, + { + "name": "One1", + "value": "1.1", + }, + { + "name": "One2", + "value": "1.2", + }, + { + "name": "One3", + "value": "1.3", + }, + { + "name": "One4", + "value": "1.4", + }, + { + "name": "Two0", + "value": "2.0", + }, + { + "name": "Two1", + "value": "2.1", + }, + { + "name": "Two2", + "value": "2.2", + }, + { + "name": "Two3", + "value": "2.3", + }, + { + "name": "Two4", + "value": "2.4", + }, + { + "name": "Two5", + "value": "2.5", + }, + { + "name": "Two6", + "value": "2.6", + }, + { + "name": "Two7", + "value": "2.7", + }, + { + "name": "Two8", + "value": "2.8", + }, + { + "name": "Two9", + "value": "2.9", + }, + { + "name": "Two10", + "value": "2.10", + }, + { + "name": "Two11", + "value": "2.11", + }, + "Unstable", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObject": { + "docs": "A linked conversation or ticket.", + "properties": { + "category": { + "docs": "Category of the Linked Ticket Object.", + "type": "optional", + }, + "id": { + "docs": "The ID of the linked object", + "type": "optional", + }, + "type": { + "docs": "ticket or conversation", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObjectList": { + "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "properties": { + "data": { + "docs": "An array containing the linked conversations and linked tickets.", + "type": "optional>", + }, + "has_more": { + "docs": "Whether or not there are more linked objects than returned.", + "type": "optional", + }, + "total_count": { + "docs": "The total number of linked objects.", + "type": "optional", + }, + "type": { + "docs": "Always list.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LinkedObjectType": { + "docs": "ticket or conversation", + "enum": [ + "ticket", + "conversation", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequest": { + "docs": "Search using Intercoms Search APIs with more than one filter.", + "properties": { + "operator": { + "docs": "An operator to allow boolean inspection between multiple fields.", + "type": "optional", + }, + "value": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequestOperator": { + "docs": "An operator to allow boolean inspection between multiple fields.", + "enum": [ + "AND", + "OR", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "MultipleFilterSearchRequestValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "docs": "Add mutiple filters.", + "type": "list", + }, + { + "docs": "Add a single filter field.", + "type": "list", + }, + ], + }, + "NewsItemRequest": { + "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "properties": { + "body": { + "docs": "The news item body, which may contain HTML.", + "type": "optional", + }, + "deliver_silently": { + "docs": "When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.", + "type": "optional", + }, + "labels": { + "docs": "Label names displayed to users to categorize the news item.", + "type": "optional>", + }, + "newsfeed_assignments": { + "docs": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "type": "optional>", + }, + "reactions": { + "docs": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "type": "optional>>", + }, + "sender_id": { + "docs": "The id of the sender of the news item. Must be a teammate on the workspace.", + "type": "integer", + }, + "state": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "type": "optional", + }, + "title": { + "docs": "The title of the news item.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsItemRequestState": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "enum": [ + "draft", + "live", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "NoteList": { + "docs": "A paginated list of notes associated with a contact.", + "properties": { + "data": { + "docs": "An array of notes.", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of notes.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "OpenConversationRequest": { + "docs": "Payload of the request to open a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PagesLink": { + "docs": "The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + +Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. +", + "properties": { + "next": { + "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "page": { + "type": "optional", + }, + "per_page": { + "type": "optional", + }, + "total_pages": { + "type": "optional", + }, + "type": { + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PaginatedResponse": { + "docs": "Paginated Response", + "properties": { + "data": { + "docs": "An array of Objects", + "type": "optional>", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "The type of object", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PaginatedResponseDataItem": { + "availability": undefined, + "base-properties": {}, + "discriminant": "type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "news-item": { + "type": "news.NewsItem", + }, + "newsfeed": { + "type": "news.Newsfeed", + }, + }, + }, + "PaginatedResponseType": { + "docs": "The type of object", + "enum": [ + "list", + { + "name": "ConversationList", + "value": "conversation.list", + }, + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "PartAttachment": { + "docs": "The file attached to a part", + "properties": { + "content_type": { + "docs": "The content type of the attachment", + "type": "optional", + }, + "filesize": { + "docs": "The size of the attachment", + "type": "optional", + }, + "height": { + "docs": "The height of the attachment", + "type": "optional", + }, + "name": { + "docs": "The name of the attachment", + "type": "optional", + }, + "type": { + "docs": "The type of attachment", + "type": "optional", + }, + "url": { + "docs": "The URL of the attachment", + "type": "optional", + }, + "width": { + "docs": "The width of the attachment", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "PhoneSwitch": { + "docs": "Phone Switch Response", + "properties": { + "phone": { + "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RedactConversationRequest": { + "availability": undefined, + "base-properties": {}, + "discriminant": "type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "conversation_part": { + "docs": "Payload of the request to redact a conversation part", + "type": "RedactConversationRequestConversationPart", + }, + "source": { + "docs": "Payload of the request to redact a conversation source", + "type": "RedactConversationRequestSource", + }, + }, + }, + "RedactConversationRequestConversationPart": { + "docs": "Payload of the request to redact a conversation part", + "properties": { + "conversation_id": { + "docs": "The id of the conversation.", + "type": "string", + }, + "conversation_part_id": { + "docs": "The id of the conversation_part.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RedactConversationRequestSource": { + "docs": "Payload of the request to redact a conversation source", + "properties": { + "conversation_id": { + "docs": "The id of the conversation.", + "type": "string", + }, + "source_id": { + "docs": "The id of the source.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Reference": { + "docs": "reference to another object", + "properties": { + "id": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ReplyConversationRequest": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ContactReplyConversationRequest", + }, + { + "type": "AdminReplyConversationRequest", + }, + ], + }, + "SearchRequest": { + "docs": "Search using Intercoms Search APIs.", + "properties": { + "pagination": { + "type": "optional", + }, + "query": "SearchRequestQuery", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SearchRequestQuery": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "SingleFilterSearchRequest", + }, + { + "type": "MultipleFilterSearchRequest", + }, + ], + }, + "SegmentList": { + "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "properties": { + "pages": { + "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", + "type": "optional>", + }, + "segments": { + "docs": "A list of Segment objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Segments": { + "docs": "A list of segments objects attached to a specific contact.", + "properties": { + "data": { + "docs": "Segment objects associated with the contact.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SingleFilterSearchRequest": { + "docs": "Search using Intercoms Search APIs with a single filter.", + "properties": { + "field": { + "docs": "The accepted field that you want to search on.", + "type": "optional", + }, + "operator": { + "docs": "The accepted operators you can use to define how you want to search for the value.", + "type": "optional", + }, + "value": { + "docs": "The value that you want to search on.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SingleFilterSearchRequestOperator": { + "docs": "The accepted operators you can use to define how you want to search for the value.", + "enum": [ + { + "name": "EQUAL_TO", + "value": "=", + }, + { + "name": "NOT_EQUALS", + "value": "!=", + }, + "IN", + "NIN", + { + "name": "LESS_THAN", + "value": "<", + }, + { + "name": "GREATER_THAN", + "value": ">", + }, + { + "name": "", + "value": "~", + }, + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SlaApplied": { + "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. +Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. +", + "properties": { + "sla_name": { + "docs": "The name of the SLA as given by the teammate when it was created.", + "type": "optional", + }, + "sla_status": { + "docs": "SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", + "type": "optional", + }, + "type": { + "docs": "object type", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SlaAppliedSlaStatus": { + "docs": "SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.", + "enum": [ + "hit", + "missed", + "cancelled", + "active", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SnoozeConversationRequest": { + "docs": "Payload of the request to snooze a conversation", + "properties": { + "admin_id": { + "docs": "The id of the admin who is performing the action.", + "type": "string", + }, + "snoozed_until": { + "docs": "The time you want the conversation to reopen.", + "type": "integer", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SocialProfile": { + "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "properties": { + "name": { + "docs": "The name of the Social media profile", + "type": "optional", + }, + "type": { + "docs": "value is "social_profile"", + "type": "optional", + }, + "url": { + "docs": "The name of the Social media profile", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "StartingAfterPaging": { + "docs": undefined, + "properties": { + "per_page": { + "docs": "The number of results to fetch per page.", + "type": "optional", + }, + "starting_after": { + "docs": "The cursor to use in the next request to get the next page of results.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeList": { + "docs": "A list of subscription type objects.", + "properties": { + "data": { + "docs": "A list of subscription type objects associated with the workspace .", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagCompanyRequest": { + "docs": "You can tag a single company or a list of companies.", + "properties": { + "companies": { + "docs": "The id or company_id of the company can be passed as input parameters.", + "type": "list", + }, + "name": { + "docs": "The name of the tag, which will be created if not found.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagCompanyRequestCompaniesItem": { + "docs": undefined, + "properties": { + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagMultipleUsersRequest": { + "docs": "You can tag a list of users.", + "properties": { + "name": { + "docs": "The name of the tag, which will be created if not found.", + "type": "string", + }, + "users": "list", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TagMultipleUsersRequestUsersItem": { + "docs": undefined, + "properties": { + "id": { + "docs": "The Intercom defined id representing the user.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Tags": { + "docs": "A list of tags objects associated with a conversation", + "properties": { + "tags": { + "docs": "A list of tags objects associated with the conversation.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TeamList": { + "docs": "This will return a list of team objects for the App.", + "properties": { + "teams": { + "docs": "A list of team objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TeamPriorityLevel": { + "docs": "Admin priority levels for teams", + "properties": { + "primary_team_ids": { + "docs": "The primary team ids for the team", + "type": "optional>", + }, + "secondary_team_ids": { + "docs": "The secondary team ids for the team", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketCustomAttributes": { + "docs": "An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are `_default_title_` and `_default_description_`.", + "type": "map", + }, + "TicketCustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "optional", + "double", + "boolean", + "list", + { + "type": "File", + }, + ], + }, + "TicketList": { + "docs": "Tickets are how you track requests from your users.", + "properties": { + "pages": { + "type": "optional", + }, + "tickets": { + "docs": "The list of ticket objects", + "type": "optional>>", + }, + "total_count": { + "docs": "A count of the total number of objects.", + "type": "optional", + }, + "type": { + "docs": "Always ticket.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartAuthor": { + "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "properties": { + "email": { + "docs": "The email of the author", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "id": { + "docs": "The id of the author", + "type": "optional", + }, + "name": { + "docs": "The name of the author", + "type": "optional", + }, + "type": { + "docs": "The type of the author", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartAuthorType": { + "docs": "The type of the author", + "enum": [ + "admin", + "bot", + "team", + "user", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketParts": { + "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "properties": { + "ticket_parts": { + "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", + "type": "optional>", + }, + "total_count": { + "docs": "", + "type": "optional", + }, + "type": { + "docs": "", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketReply": { + "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "properties": { + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML.", + "type": "optional", + }, + "created_at": { + "docs": "The time the note was created.", + "type": "optional", + }, + "id": { + "docs": "The id representing the part.", + "type": "optional", + }, + "part_type": { + "docs": "Type of the part", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the ticket part has been redacted.", + "type": "optional", + }, + "type": { + "docs": "Always ticket_part", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the note was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketReplyPartType": { + "docs": "Type of the part", + "enum": [ + "note", + "comment", + "quick_reply", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketRequestCustomAttributes": { + "docs": "The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are `_default_title_` and `_default_description_`. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). For example, if the ticket type has an attribute called `priority` of type `list`, the key should be `priority` and the value of the attribute should be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`).", + "type": "map", + }, + "TicketRequestCustomAttributesValue": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + "optional", + "double", + "boolean", + "list", + ], + }, + "TicketTypeAttribute": { + "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "properties": { + "archived": { + "docs": "Whether the ticket type attribute is archived or not.", + "type": "optional", + }, + "created_at": { + "docs": "The date and time the ticket type attribute was created.", + "type": "optional", + }, + "data_type": { + "docs": "The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")", + "type": "optional", + }, + "default": { + "docs": "Whether the attribute is built in or not.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type attribute", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket type attribute.", + "type": "optional", + }, + "input_options": { + "docs": "Input options for the attribute", + "type": "optional>", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "optional", + }, + "order": { + "docs": "The order of the attribute against other attributes", + "type": "optional", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required or not for teammates.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required or not for contacts.", + "type": "optional", + }, + "ticket_type_id": { + "docs": "The id of the ticket type that the attribute belongs to.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type_attribute`.", + "type": "optional", + }, + "updated_at": { + "docs": "The date and time the ticket type attribute was last updated.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible or not to teammates.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible or not to contacts.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace that the ticket type attribute belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeAttributeList": { + "docs": "A list of attributes associated with a given ticket type.", + "properties": { + "ticket_type_attributes": { + "docs": "A list of ticket type attributes associated with a given ticket type.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type_attributes.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeList": { + "docs": "A list of ticket types associated with a given workspace.", + "properties": { + "ticket_types": { + "docs": "A list of ticket_types associated with a given workspace.", + "type": "optional>>", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type.list`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Translation": { + "docs": "A translation object contains the localised details of a subscription type.", + "properties": { + "description": { + "docs": "The localised description of the subscription type.", + "type": "optional", + }, + "locale": { + "docs": "The two character identifier for the language of the translation object.", + "type": "optional", + }, + "name": { + "docs": "The localised name of the subscription type.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UntagCompanyRequest": { + "docs": "You can tag a single company or a list of companies.", + "properties": { + "companies": { + "docs": "The id or company_id of the company can be passed as input parameters.", + "type": "list", + }, + "name": { + "docs": "The name of the tag which will be untagged from the company", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UntagCompanyRequestCompaniesItem": { + "docs": undefined, + "properties": { + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + "untag": { + "docs": "Always set to true", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateArticleRequest": { + "docs": "You can Update an Article", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "optional", + }, + "body": { + "docs": "The content of the article. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article.For multilingual articles, this will be the title of the default language's content.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateArticleRequestState": { + "docs": "Whether the article will be `published` or will be a `draft`. Defaults to draft. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketTypeRequest": { + "docs": "The request payload for updating a ticket type. +You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "properties": { + "archived": { + "docs": "The archived status of the ticket type.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type.", + "type": "optional", + }, + "icon": { + "default": "🎟️", + "docs": "The icon of the ticket type.", + "type": "optional", + }, + "is_internal": { + "default": false, + "docs": "Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketTypeRequestCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateVisitorRequestOne": "unknown", + "Visitor": { + "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "properties": { + "anonymous": { + "docs": "Identifies if this visitor is anonymous.", + "type": "optional", + }, + "app_id": { + "docs": "The id of the app the visitor is associated with.", + "type": "optional", + }, + "avatar": { + "type": "optional", + }, + "companies": { + "type": "optional", + }, + "created_at": { + "docs": "The time the Visitor was added to Intercom.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes you have set on the Visitor.", + "type": "optional>", + }, + "do_not_track": { + "docs": "Identifies if this visitor has do not track enabled.", + "type": "optional", + }, + "email": { + "docs": "The email of the visitor.", + "type": "optional", + "validation": { + "format": "email", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "has_hard_bounced": { + "docs": "Identifies if this visitor has had a hard bounce.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the Visitor.", + "type": "optional", + }, + "las_request_at": { + "docs": "The time the Lead last recorded making a request.", + "type": "optional", + }, + "location_data": { + "type": "optional", + }, + "marked_email_as_spam": { + "docs": "Identifies if this visitor has marked an email as spam.", + "type": "optional", + }, + "name": { + "docs": "The name of the visitor.", + "type": "optional", + }, + "owner_id": { + "docs": "The id of the admin that owns the Visitor.", + "type": "optional", + }, + "phone": { + "docs": "The phone number of the visitor.", + "type": "optional", + }, + "pseudonym": { + "docs": "The pseudonym of the visitor.", + "type": "optional", + }, + "referrer": { + "docs": "The referer of the visitor.", + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the Visitor was added to Intercom.", + "type": "optional", + }, + "segments": { + "type": "optional", + }, + "session_count": { + "docs": "The number of sessions the Visitor has had.", + "type": "optional", + }, + "signed_up_at": { + "docs": "The time the Visitor signed up for your product.", + "type": "optional", + }, + "social_profiles": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "type": { + "default": "visitor", + "docs": "Value is 'visitor'", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the Visitor is unsubscribed from emails.", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the Visitor was updated.", + "type": "optional", + }, + "user_id": { + "docs": "Automatically generated identifier for the Visitor.", + "type": "optional", + }, + "utm_campaign": { + "docs": "The utm_campaign of the visitor.", + "type": "optional", + }, + "utm_content": { + "docs": "The utm_content of the visitor.", + "type": "optional", + }, + "utm_medium": { + "docs": "The utm_medium of the visitor.", + "type": "optional", + }, + "utm_source": { + "docs": "The utm_source of the visitor.", + "type": "optional", + }, + "utm_term": { + "docs": "The utm_term of the visitor.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorAvatar": { + "docs": undefined, + "properties": { + "image_url": { + "docs": "This object represents the avatar associated with the visitor.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "default": "avatar", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorCompanies": { + "docs": undefined, + "properties": { + "companies": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorDeletedObject": { + "docs": "Response returned when an object is deleted", + "properties": { + "id": { + "docs": "The unique identifier for the visitor which is given by Intercom.", + "type": "optional", + }, + "type": { + "docs": "The type of object which was deleted", + "type": "optional>", + }, + "user_id": { + "docs": "Automatically generated identifier for the Visitor.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorLocationData": { + "docs": undefined, + "properties": { + "city_name": { + "docs": "The city name of the visitor.", + "type": "optional", + }, + "continent_code": { + "docs": "The continent code of the visitor.", + "type": "optional", + }, + "country_code": { + "docs": "The country code of the visitor.", + "type": "optional", + }, + "country_name": { + "docs": "The country name of the visitor.", + "type": "optional", + }, + "postal_code": { + "docs": "The postal code of the visitor.", + "type": "optional", + }, + "region_name": { + "docs": "The region name of the visitor.", + "type": "optional", + }, + "timezone": { + "docs": "The timezone of the visitor.", + "type": "optional", + }, + "type": { + "default": "location_data", + "docs": "", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorSegments": { + "docs": undefined, + "properties": { + "segments": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorSocialProfiles": { + "docs": undefined, + "properties": { + "social_profiles": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorTags": { + "docs": undefined, + "properties": { + "tags": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "VisitorTagsTagsItem": { + "docs": undefined, + "properties": { + "id": { + "docs": "The id of the tag.", + "type": "optional", + }, + "name": { + "docs": "The name of the tag.", + "type": "optional", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "errors: + UnauthorizedError: + status-code: 401 + type: Error + docs: Unauthorized + examples: + - value: + type: error.list + request_id: 18722269-a019-46c4-87d7-50d0f6f8a990 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 06d9eefd-2b3a-48f7-938a-5a10383a4ebf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 4ba8121e-4a4a-4668-adb2-363c561f3c52 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 83978032-1473-4696-b755-b497d46a23cf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 86d69044-5966-428e-9a40-2b39fba3f823 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: f223a1d9-5377-4337-92bb-00fb39157f11 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 62ab4791-7e4d-4400-a56b-b06a0ce3ba1a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 15b4f214-c670-43d7-ad8f-648791fddf9b + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 85d43c53-f28f-4295-b937-9a43ea71d0c3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 626c6766-ee1a-489d-b87a-230d9b980c7d + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: ccedcb48-7d08-4cc9-bcff-0622f70daf74 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: bf1acd76-8c6e-45f4-8dbe-54391843270a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 67002700-07f8-4a56-a9bc-464254c3a5bd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 794a475b-0155-40b2-a288-ba0d48fdbd3f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c96a4779-a06d-45bb-aa39-eb96c587c2c7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 9b0d6fb9-d2d7-4904-a13c-97557a802323 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 3f26a216-ddff-4782-9529-514f5bad56ea + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 0a1a5065-69fe-47a4-9804-4cb2347671ef + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: fe20b681-f988-4154-bec9-a5087fe0842e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 66fcc654-48ed-4f53-824e-831b5c96c9dc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 6f8cb4ca-9a95-43bd-aee1-597b85d1d13f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d211ec8c-df9b-420c-86df-23c27ad54bc5 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 99739bbd-2dbe-4ce3-ae91-af23379b5cd7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d8c1ab2d-4044-4c4f-98f0-176860747112 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d2927c64-9c5a-4593-997b-381f8c2356ea + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 82a95655-569d-4e5d-b0d9-f8a6c7a379f3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 377d162e-82a5-4148-a26f-29c9c760dadc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 99fba0c6-2252-4658-abd2-1d2ff16a508b + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 97383559-0fb0-4084-8a9a-8e3407c46108 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 63a2828f-107e-4d51-9398-a220b81a7bce + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: e97d9f1b-8c9e-4caf-b473-3bce411c697e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: f70085f1-f655-43ee-9585-d2061b260fcd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: b1b88e2d-938c-4a26-b65d-26ff65a0af36 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 0bce3945-d2ec-4b8e-a790-b16fd52d9f11 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 57b64228-0e60-4e35-833d-39c4e4067dde + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d5bac7ff-7961-4fe5-8aed-6f1b031b38af + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c18ca0d4-ad2c-41e7-9a71-1df806f9c954 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 95cacea0-4744-4de8-a2bf-da4419f75732 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: f083d6b1-e9d2-43b3-86df-67539007fc3e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 18db64a8-7a08-4967-9ec6-0416178306f9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: af9757fc-4e1d-463c-ac9d-788503f04a95 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: b1f6adfd-f7da-4880-8d11-d842235126ae + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 58e6b9ee-4a28-4597-9c20-faf34b6894dc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 7435aa28-13bd-40b1-ba99-66009e92a1ba + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: ae0581d2-199e-437c-bf51-1eb9fe2e12fc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 4f00c4c6-a8f7-436e-bf95-d1adfa315906 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d35f1b37-765c-4afe-8738-81c0560710a6 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 1b830d07-a249-4ff8-a7bf-41bf83fd53b2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 6e76e914-a34d-4125-8310-62fdfc4e651e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: b74d8980-6e99-44db-a3d8-2a65a63fe590 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 0cfc97c0-32be-4e68-aef2-f5744e4e85f7 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: bfdcc6de-2dcb-4725-acc7-232c10838586 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c6b3dcbd-33be-4a80-abb4-c5b3315250d0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 110801d1-2f7b-436f-8f03-2245545a1432 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: ee3ea56e-d0ce-47db-871a-57740e165e5c + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 7b27151d-7bb0-402e-87fe-5780690d9f32 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c36202f1-6bf3-4ea6-9442-192123f506b0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: cc6af01d-81e3-4a74-8a62-807a3239e1ad + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: f780a591-4aa2-4382-80c4-e0f2d655bf2e + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d00f8d67-1e7c-464b-b0b7-b2409d706076 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 185ce494-34e2-4cda-85cb-c51ad7281292 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: b29ebc05-ba35-4db8-aac6-d74617769643 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: d70c184d-852a-4f67-8298-3cf9a327adb3 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: a9c190ff-16eb-43f9-94fc-7c22da2766af + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 5fb6b003-d6a6-4641-b71b-c5c468c87448 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 5da7a3e7-dcb0-4378-8575-0a0e9bae3862 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: c83a3efe-433a-4555-a5e2-e393588be29f + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 3609e8b1-a6aa-4c57-a994-3d95743f20a2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 76a1d79d-3f0d-49bb-8d15-38d1ae6df738 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 3dcedf54-ed30-4337-8992-94e36900e695 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 006b2c8f-9a29-463e-be69-ad213576aee6 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 110ad8e4-99ed-461a-bd93-92a5cdbaa6b2 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 3bc672fa-e051-4ede-b6e9-79f518231ba9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 6e45414c-e627-4769-bdbd-d51f2c19e1e9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 50823491-2ab1-4b84-9700-2d92c4f367fd + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 7c4784fe-d3e4-4182-b9c4-918bdf253eef + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: b0100f38-119c-4e30-8560-a25561d97c66 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 2b0554fe-ba10-41d4-ab7b-715c2b7b8e47 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: bb012854-cca8-4fa7-972e-6c38204e8294 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: a502f48f-c80d-48fd-bea5-cafe7e24d9f9 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 745c921a-7c5a-40d4-ab28-6d28a8d2ed47 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: e7ba89f2-3bc8-4fc3-97bc-56f62f342680 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: e5202025-e8f9-400a-9107-192ae8bfd50c + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 25dace4f-4916-492c-823b-f0cca227dff0 + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: 82df3971-fb7c-410d-a919-e8bc1b3d991a + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + - value: + type: error.list + request_id: fe1a587a-e682-4a96-bd30-ea08b726e6fa + errors: + - code: unauthorized + message: Access Token Invalid + name: Unauthorized + NotFoundError: + status-code: 404 + type: unknown + docs: Admin not found + examples: + - value: + type: error.list + request_id: 9818bd03-9cc6-4ab8-8e7c-20a45ac58e97 + errors: + - code: admin_not_found + message: Admin for admin_id not found + name: Admin not found + - value: + type: error.list + request_id: 989bdb0b-1e8c-46cc-8953-9733dad40562 + errors: + - code: admin_not_found + message: Admin not found + name: Admin not found + - value: + type: error.list + request_id: 99c73902-e8ea-4872-b412-1d55ce4582fb + errors: + - code: not_found + message: Resource Not Found + name: Article not found + - value: + type: error.list + request_id: 891b6ff4-181f-4b98-861b-d34ef16bfc4b + errors: + - code: not_found + message: Resource Not Found + name: Article Not Found + - value: + type: error.list + request_id: 60da5f23-613c-4f84-84bd-e9dbd3d67187 + errors: + - code: not_found + message: Resource Not Found + name: Article Not Found + - value: + type: error.list + request_id: 2970f0f3-7020-4382-8892-eac24818ca88 + errors: + - code: not_found + message: Resource Not Found + name: Collection not found + - value: + type: error.list + request_id: 35e7f185-f547-4ae1-a23d-afc9027fc5a6 + errors: + - code: not_found + message: Resource Not Found + name: Collection Not Found + - value: + type: error.list + request_id: a35712b4-90b6-47fb-843d-757d9fdd81e6 + errors: + - code: not_found + message: Resource Not Found + name: collection Not Found + - value: + type: error.list + request_id: c6e7d3f6-8a46-460e-8264-e07c2e7302aa + errors: + - code: not_found + message: Resource Not Found + name: Collection not found + - value: + type: error.list + request_id: c97dd75f-a434-4c83-a8e8-c4d1887d6c48 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: b49593ed-49a6-4497-8fb7-220ff74527f6 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: b1ce72df-630f-4925-b212-fca6e833eb8d + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: 35a9b551-331e-499e-a63f-20396bfd29f5 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: a6381081-a166-4e8e-952d-38bb2cd1c2b4 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: 22add598-fd33-4c34-971f-cf215117aab3 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: b9d7374d-1780-4668-bb62-0e1ff9cdab45 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 32d121d8-fcbf-4c59-9c60-204f7d602f36 + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: cd4f1648-724c-45f0-b6e1-72a1bc6479ee + errors: + - code: company_not_found + message: Company Not Found + name: Company Not Found + - value: + type: error.list + request_id: d316defc-0a2f-49e7-b8ff-4cb6ccf46c90 + errors: + - code: not_found + message: User Not Found + name: Contact Not Found + - value: + type: error.list + request_id: e93f90a6-4c85-4dbf-b063-96b649318371 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: d7c69ce6-3195-46be-b2cb-0dce355d2919 + errors: + - code: not_found + message: Resource Not Found + name: Admin not found + - value: + type: error.list + request_id: 2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 3f481052-cf49-4b95-a492-734223865981 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: cf0f6fd6-7c5e-492b-909d-f60b35eea1c4 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 3f852f45-1a80-4ade-9bc6-72b377d2bbd8 + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + - value: + type: error.list + request_id: 7bc429e4-e887-4f53-b69c-94e6e55d2125 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 66ebc1f5-5e02-4584-8028-f2559a41e8df + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + - value: + type: error.list + request_id: 2b513026-b78c-4c67-b073-da0266f62cc7 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 1bbd7e4b-718e-46f4-b682-a429aea78f01 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: a1a28017-728a-423b-adc0-2705d375f533 + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + - value: + type: error.list + request_id: 6f735483-c309-4e94-b9ab-143aedc0c691 + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 9e780671-29b3-4913-b4be-15234ea0bc6a + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + - value: + type: error.list + request_id: 840d35aa-2414-402a-b3c6-763a410e0d16 + errors: + - code: not_found + message: Conversation not found + name: Conversation not found + - value: + type: error.list + request_id: f78f63ba-911d-47b8-a389-b33e3ccbe77e + errors: + - code: not_found + message: Conversation not found + name: Conversation not found + - value: + type: error.list + request_id: 0d00d069-2cf1-496f-b887-a4db74ee320d + errors: + - code: tag_not_found + message: Tag not found + name: Tag not found + - value: + type: error.list + request_id: ed0ab0c5-57b8-4413-a7a9-bbc134b40876 + errors: + - code: not_found + message: User Not Found + name: Contact Not Found + - value: + type: error.list + request_id: 978c1e65-1eba-4995-9acb-ff8f33b283e3 + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: e4c692dd-cccd-46bf-834a-cda7a3a9029c + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: 8193a639-aba8-4b0e-9fdd-ee48807e3ee7 + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: 1bfc14e1-07ef-4999-9448-f029b112cf1b + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984 + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: 1fd64942-5bf0-4a51-a6cb-db4a778bb1f4 + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: 579f0f7a-d773-41d6-9d36-8cc0b3fbcc41 + errors: + - code: not_found + message: Resource Not Found + name: Conversation not found + - value: + type: error.list + request_id: 44531412-2973-4b92-b14d-80abac5c1b4d + errors: + - code: not_found + message: User Not Found + name: Contact not found + - value: + type: error.list + request_id: 0c016386-49f4-431f-92dc-7e739cbf98e1 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + name: Not found + - value: + type: error.list + request_id: 2680a225-4f79-4098-8438-8db993c639fe + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + name: Attribute Not Found + - value: + type: error.list + request_id: 0f4b439e-9b57-4019-886e-15cc08582914 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + - value: + type: error.list + request_id: fe6e217d-70bc-4090-b33a-b32ec0e6a391 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + - value: + type: error.list + request_id: a191b999-6f71-4676-a8db-1a79ccc4f114 + errors: + - code: not_found + message: Resource Not Found + name: News Item Not Found + - value: + type: error.list + request_id: 7e37eb4e-9f1e-47fa-a393-8d9b2c20983a + errors: + - code: not_found + message: Resource Not Found + name: Note not found + - value: + type: error.list + request_id: fe79fa5e-c8eb-40a6-be76-d618833c2840 + errors: + - code: not_found + message: Resource Not Found + name: Segment not found + - value: + type: error.list + request_id: f0f84d9b-3c51-4904-9c21-34faba76ebf5 + errors: + - code: company_not_found + message: Company Not Found + name: Company not found + - value: + type: error.list + request_id: 786848c6-5b9f-4e9b-aa78-2bdec45a09f5 + errors: + - code: not_found + message: User Not Found + name: User not found + - value: + type: error.list + request_id: 20b89fb6-f224-4f81-98ca-4cb4b36df959 + errors: + - code: not_found + message: Resource Not Found + name: Tag not found + - value: + type: error.list + request_id: 111586bb-ad78-43b9-b0a0-bf864d9a3744 + errors: + - code: not_found + message: Resource Not Found + name: Resource not found + - value: + type: error.list + request_id: 4745dfce-7275-4864-abfd-44e0d84bf52a + errors: + - code: team_not_found + message: Team not found + name: Team not found + - value: + type: error.list + request_id: c23e8dab-6102-483c-bb1b-c62923be35ab + errors: + - code: not_found + message: Resource Not Found + name: Not found + - value: + type: error.list + request_id: e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9 + errors: + - code: ticket_not_found + message: Ticket not found + name: Ticket not found + - value: + type: error.list + request_id: ffa08bb4-3994-4132-b9e3-14837e0723e8 + errors: + - code: ticket_not_found + message: Ticket not found + name: Ticket not found + - value: + type: error.list + request_id: d2385995-502c-4c03-bf4b-93ef3d24037b + errors: + - code: tag_not_found + message: Tag not found + name: Tag not found + - value: + type: error.list + request_id: 809aceaa-c073-4e2a-96c3-a25e15576946 + errors: + - code: assignee_not_found + message: Assignee not found + name: Admin not found + - value: + type: error.list + request_id: 639b5b51-1eb9-4c06-8de4-d9b0e30fff05 + errors: + - code: assignee_not_found + message: Assignee not found + name: Assignee not found + - value: + type: error.list + request_id: 7359afef-98f5-4b22-9de7-902f7a214729 + errors: + - code: not_found + message: Visitor Not Found + name: Visitor not found + - value: + type: error.list + request_id: 1f35dc86-17d2-4bfe-8cb1-9afa74adc24c + errors: + - code: not_found + message: Visitor Not Found + name: visitor Not Found + BadRequestError: + status-code: 400 + type: unknown + docs: Bad Request + examples: + - value: + type: error.list + request_id: e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd + errors: + - code: parameter_not_found + message: >- + author_id must be in the main body or default locale + translated_content object + name: Bad Request + - value: + type: error.list + request_id: 1f4fd741-8681-4c21-911a-47d7bb39d080 + errors: + - code: parameter_not_found + message: Name is a required parameter. + name: Bad Request + - value: + type: error.list + errors: + - code: bad_request + message: bad 'test' parameter + name: Bad Request + - value: + type: error.list + request_id: 9297dcfc-1896-43a3-a3f9-131238422ed2 + errors: + - code: parameter_not_found + message: company not specified + name: Bad Request + - value: + type: error.list + request_id: 74656c1a-0a17-4c80-a7b9-66fa45c6d71b + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + name: Bad request + - value: + type: error.list + request_id: bcd93885-3f01-4b92-9918-c96a3f4492e8 + errors: + - code: parameter_invalid + message: >- + You already have 'The One Ring' in your company data. To save + this as new people data, use a different name. + name: Same name already exists + - value: + type: error.list + request_id: 7420c5e3-22c3-46be-8a23-72fef8f8ec0e + errors: + - code: parameter_invalid + message: >- + Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + name: Invalid name + - value: + type: error.list + request_id: c844551a-05d3-4f8c-931a-32e96bf3a508 + errors: + - code: parameter_invalid + message: >- + You already have 'The One Ring' in your company data. To save + this as new company data, use a different name. + name: Attribute already exists + - value: + type: error.list + request_id: b8c58b81-8445-473d-8fe3-7880c04f9547 + errors: + - code: parameter_invalid + message: Data Type isn't an option + name: Invalid Data Type + - value: + type: error.list + request_id: 119e3822-3a45-48cf-b5ab-037f27a948c8 + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact or company + name: Too few options for list + - value: + type: error.list + request_id: 6615f20c-01df-443c-9ea1-c954ba6b09d6 + errors: + - code: parameter_invalid + message: Options isn't an array + name: Too few options in list + - value: + type: error.list + request_id: 4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1 + errors: + - code: parameter_invalid + message: Body is required + name: No body supplied for message + - value: + type: error.list + request_id: 7d54191b-c0fc-4860-a01c-9da6b4e45b7f + errors: + - code: parameter_invalid + message: Body is required + name: No body supplied for email message + - value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + name: bad request - exception sending sms + - value: + error_key: invalid_phone_number + message: Invalid phone number + name: bad request - invalid number + - value: + type: error.list + request_id: a7afe3c5-be52-4b69-9268-50ef1d917a1b + errors: + - code: parameter_invalid + message: invalid tag parameters + name: Invalid parameters + - value: + type: error.list + request_id: 41086388-9b3b-4e07-9633-502b9b10c926 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: Seg 1.' + name: Tag has dependent objects + - value: + type: error.list + request_id: b8b42c55-347c-4704-b4c1-92220c01f4ac + errors: + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets + name: User reply + ForbiddenError: + status-code: 403 + type: Error + docs: API plan restricted + examples: + - value: + type: error.list + request_id: a91eac55-8d70-454d-a01d-c6bb875aaa35 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: c7a35217-6720-48bd-a2ae-c2acb5adea30 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: c7b0a10f-d482-4352-8d7b-1ad26b902473 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: cf6fb162-88c9-45ec-9f97-c3fcad93b7c1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: 9fe5809c-cf0b-4a0f-af80-9913d3beb1eb + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: a7e069bb-f013-45bc-8e0a-f58c3de4e034 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: 037980c4-84cb-4d3a-ad64-66e4e563a275 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: 3d1c3371-6ba4-4d5a-9368-ac983292136d + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: d30f18d4-2e0a-4528-a66b-4590b733713c + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + - value: + type: error.list + request_id: fab7034a-78bd-4413-a652-8f38783e7bf1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + name: API plan restricted + UnprocessableEntityError: + status-code: 422 + type: unknown + docs: Last customer + examples: + - value: + type: error.list + request_id: 35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + name: Last customer + - value: + type: error.list + request_id: fbc508f1-9cbf-4134-90ea-baa1065760d2 + errors: + - code: data_invalid + message: >- + The Data Attribute you are trying to archive has a dependant + object + name: Has Dependant Object + - value: + type: error.list + request_id: f54ba906-3255-4fc6-a660-0dab0043ff2b + errors: + - code: parameter_not_found + message: No subject supplied for email message + name: No subject supplied for email message + - value: + error_key: some_error + name: unprocessable entity +types: + ActivityLogPerformedBy: + docs: Details about the Admin involved in the activity. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + email: + type: optional + docs: The email of the admin. + ip: + type: optional + docs: The IP address of the admin. + source: + openapi: ../openapi.yml + ActivityLogActivityType: + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + source: + openapi: ../openapi.yml + ActivityLog: + docs: Activities performed by Admins. + properties: + id: + type: optional + docs: The id representing the activity. + performed_by: + type: optional + docs: Details about the Admin involved in the activity. + metadata: + type: optional + created_at: + type: optional + docs: The time the activity was created. + activity_type: + type: optional + activity_description: + type: optional + docs: A sentence or two describing the activity. + source: + openapi: ../openapi.yml + ActivityLogList: + docs: A paginated list of activity logs. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `activity_log.list`. + pages: + type: optional + activity_logs: + type: optional>> + docs: An array of activity logs + source: + openapi: ../openapi.yml + ActivityLogMetadata: + docs: Additional data provided about Admin activity. + properties: + sign_in_method: + type: optional + docs: The way the admin signed in. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + away_mode: + type: optional + docs: >- + The away mode status which is set to true when away and false when + returned. + away_status_reason: + type: optional + docs: The reason the Admin is away. + reassign_conversations: + type: optional + docs: >- + Indicates if conversations should be reassigned while an Admin is + away. + source: + type: optional + docs: The action that initiated the status change. + auto_changed: + type: optional + docs: Indicates if the status was changed automatically or manually. + update_by: + type: optional + docs: The ID of the Admin who initiated the activity. + update_by_name: + type: optional + docs: The name of the Admin who initiated the activity. + source: + openapi: ../openapi.yml + AddressableList: + docs: A list used to access other resources from a parent model. + properties: + type: + type: optional + docs: The addressable object type + validation: + format: uri + id: + type: optional + docs: The id of the addressable object + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + source: + openapi: ../openapi.yml + Admins: + docs: A list of admins associated with a given workspace. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `admin.list`. + admins: + type: optional>> + docs: A list of admins associated with a given workspace. + source: + openapi: ../openapi.yml + AdminPriorityLevel: + docs: Admin priority levels for the team + properties: + primary_admin_ids: + type: optional> + docs: The primary admin ids for the team + secondary_admin_ids: + type: optional> + docs: The secondary admin ids for the team + source: + openapi: ../openapi.yml + AdminReplyConversationRequestMessageType: + enum: + - comment + - note + source: + openapi: ../openapi.yml + AdminReplyConversationRequest: + docs: Payload of the request to reply on behalf of an admin + properties: + message_type: AdminReplyConversationRequestMessageType + type: literal<"admin"> + body: + type: optional + docs: >- + The text body of the reply. Notes accept some HTML formatting. Must be + present for comment and note message types. + admin_id: + type: string + docs: The id of the admin who is authoring the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + attachment_files: + type: optional> + docs: >- + A list of files that will be added as attachments. You can include up + to 10 files + source: + openapi: ../openapi.yml + AdminReplyTicketRequestMessageType: + enum: + - comment + - note + - quick_reply + source: + openapi: ../openapi.yml + AdminReplyTicketRequestReplyOptionsItem: + properties: + text: + type: string + docs: The text to display in this quick reply option. + uuid: + type: string + docs: >- + A unique identifier for this quick reply option. This value will be + available within the metadata of the comment ticket part that is + created when a user clicks on this reply option. + validation: + format: uuid + source: + openapi: ../openapi.yml + AdminReplyTicketRequest: + docs: Payload of the request to reply on behalf of an admin + properties: + message_type: AdminReplyTicketRequestMessageType + type: literal<"admin"> + body: + type: optional + docs: >- + The text body of the reply. Notes accept some HTML formatting. Must be + present for comment and note message types. + admin_id: + type: string + docs: The id of the admin who is authoring the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + reply_options: + type: optional> + docs: >- + The quick reply options to display. Must be present for quick_reply + message types. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + source: + openapi: ../openapi.yml + AdminWithAppAvatar: + docs: This object represents the avatar associated with the admin. + properties: + type: + type: optional + docs: >- + This is a string that identifies the type of the object. It will + always have the value `avatar`. + default: avatar + image_url: + type: optional + docs: This object represents the avatar associated with the admin. + validation: + format: uri + source: + openapi: ../openapi.yml + Admin: + docs: Admins are the teammate accounts that have access to a workspace + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + name: + type: optional + docs: The name of the admin. + email: + type: optional + docs: The email of the admin. + job_title: + type: optional + docs: The job title of the admin. + away_mode_enabled: + type: optional + docs: Identifies if this admin is currently set in away mode. + away_mode_reassign: + type: optional + docs: >- + Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + has_inbox_seat: + type: optional + docs: >- + Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + team_ids: + type: optional> + docs: This is a list of ids of the teams that this admin is part of. + avatar: + type: optional + docs: This object represents the avatar associated with the admin. + email_verified: + type: optional + docs: Identifies if this admin's email is verified. + app: + type: optional + docs: App that the admin belongs to. + source: + openapi: ../openapi.yml + App: + docs: App is a workspace on Intercom + properties: + type: + type: optional + docs: '' + default: app + id_code: + type: optional + docs: The id of the app. + name: + type: optional + docs: The name of the app. + region: + type: optional + docs: The Intercom region the app is located in. + timezone: + type: optional + docs: The timezone of the region where the app is located. + created_at: + type: optional + docs: When the app was created. + identity_verification: + type: optional + docs: Whether or not the app uses identity verification. + source: + openapi: ../openapi.yml + ArticleContentState: + enum: + - published + - draft + docs: Whether the article is `published` or is a `draft` . + source: + openapi: ../openapi.yml + ArticleContent: + docs: The Content of an Article. + properties: + type: + type: optional + docs: The type of object - `article_content` . + title: + type: optional + docs: The title of the article. + description: + type: optional + docs: The description of the article. + body: + type: optional + docs: The body of the article. + author_id: + type: optional + docs: The ID of the author of the article. + state: + type: optional + docs: Whether the article is `published` or is a `draft` . + created_at: + type: optional + docs: The time when the article was created (seconds). + updated_at: + type: optional + docs: The time when the article was last updated (seconds). + url: + type: optional + docs: The URL of the article. + source: + openapi: ../openapi.yml + Articles: + docs: This will return a list of articles for the App. + properties: + type: + type: optional> + docs: The type of the object - `list`. + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of articles. + data: + type: optional> + docs: An array of Article objects + source: + openapi: ../openapi.yml + ArticleStatistics: + docs: The statistics of an article. + properties: + type: + type: optional> + docs: The type of object - `article_statistics`. + views: + type: optional + docs: The number of total views the article has received. + conversions: + type: optional + docs: The number of conversations started from the article. + reactions: + type: optional + docs: The number of total reactions the article has received. + happy_reaction_percentage: + type: optional + docs: >- + The percentage of happy reactions the article has received against + other types of reaction. + neutral_reaction_percentage: + type: optional + docs: >- + The percentage of neutral reactions the article has received against + other types of reaction. + sad_reaction_percentage: + type: optional + docs: >- + The percentage of sad reactions the article has received against other + types of reaction. + source: + openapi: ../openapi.yml + ArticleTranslatedContent: + docs: >- + The Translated Content of an Article. The keys are the locale codes and + the values are the translated content of the article. + properties: + type: + type: optional + docs: The type of object - article_translated_content. + ar: + type: optional + docs: The content of the article in Arabic + bg: + type: optional + docs: The content of the article in Bulgarian + bs: + type: optional + docs: The content of the article in Bosnian + ca: + type: optional + docs: The content of the article in Catalan + cs: + type: optional + docs: The content of the article in Czech + da: + type: optional + docs: The content of the article in Danish + de: + type: optional + docs: The content of the article in German + el: + type: optional + docs: The content of the article in Greek + en: + type: optional + docs: The content of the article in English + es: + type: optional + docs: The content of the article in Spanish + et: + type: optional + docs: The content of the article in Estonian + fi: + type: optional + docs: The content of the article in Finnish + fr: + type: optional + docs: The content of the article in French + he: + type: optional + docs: The content of the article in Hebrew + hr: + type: optional + docs: The content of the article in Croatian + hu: + type: optional + docs: The content of the article in Hungarian + id: + type: optional + docs: The content of the article in Indonesian + it: + type: optional + docs: The content of the article in Italian + ja: + type: optional + docs: The content of the article in Japanese + ko: + type: optional + docs: The content of the article in Korean + lt: + type: optional + docs: The content of the article in Lithuanian + lv: + type: optional + docs: The content of the article in Latvian + mn: + type: optional + docs: The content of the article in Mongolian + nb: + type: optional + docs: The content of the article in Norwegian + nl: + type: optional + docs: The content of the article in Dutch + pl: + type: optional + docs: The content of the article in Polish + pt: + type: optional + docs: The content of the article in Portuguese (Portugal) + ro: + type: optional + docs: The content of the article in Romanian + ru: + type: optional + docs: The content of the article in Russian + sl: + type: optional + docs: The content of the article in Slovenian + sr: + type: optional + docs: The content of the article in Serbian + sv: + type: optional + docs: The content of the article in Swedish + tr: + type: optional + docs: The content of the article in Turkish + vi: + type: optional + docs: The content of the article in Vietnamese + pt-BR: + type: optional + docs: The content of the article in Portuguese (Brazil) + zh-CN: + type: optional + docs: The content of the article in Chinese (China) + zh-TW: + type: optional + docs: The content of the article in Chinese (Taiwan) + source: + openapi: ../openapi.yml + AssignConversationRequestType: + enum: + - admin + - team + source: + openapi: ../openapi.yml + AssignConversationRequest: + docs: Payload of the request to assign a conversation + properties: + type: AssignConversationRequestType + admin_id: + type: string + docs: The id of the admin who is performing the action. + assignee_id: + type: string + docs: >- + The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a + team.\nSet `0` if you want this assign to no admin or team (ie. + Unassigned). + body: + type: optional + docs: >- + Optionally you can send a response in the conversation when it is + assigned. + source: + openapi: ../openapi.yml + CloseConversationRequest: + docs: Payload of the request to close a conversation + properties: + type: literal<"admin"> + admin_id: + type: string + docs: The id of the admin who is performing the action. + body: + type: optional + docs: >- + Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + source: + openapi: ../openapi.yml + Collections: + docs: This will return a list of Collections for the App. + properties: + type: + type: optional> + docs: The type of the object - `list`. + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of collections. + data: + type: optional> + docs: An array of collection objects + source: + openapi: ../openapi.yml + CompanyAttachedContacts: + docs: A list of Contact Objects + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + docs: An array containing Contact Objects + total_count: + type: optional + docs: The total number of contacts + pages: + type: optional + source: + openapi: ../openapi.yml + CompanyAttachedSegments: + docs: A list of Segment Objects + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + docs: An array containing Segment Objects + source: + openapi: ../openapi.yml + Companies: + docs: This will return a list of companies for the App. + properties: + type: + type: optional> + docs: The type of object - `list`. + pages: + type: optional + total_count: + type: optional + docs: The total number of companies. + data: + type: optional> + docs: An array containing Company Objects. + source: + openapi: ../openapi.yml + CompanyScroll: + docs: >- + Companies allow you to represent organizations using your product. Each + company will have its own description and be associated with contacts. You + can fetch, create, update and list companies. + properties: + type: + type: optional> + docs: The type of object - `list` + data: + type: optional> + pages: + type: optional + total_count: + type: optional + docs: The total number of companies + scroll_param: + type: optional + docs: >- + The scroll parameter to use in the next request to fetch the next page + of results. + source: + openapi: ../openapi.yml + ContactArchived: + docs: archived contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + archived: + type: optional + docs: Whether the contact is archived or not. + source: + openapi: ../openapi.yml + ContactAttachedCompanies: + docs: A list of Company Objects + properties: + type: + type: optional> + docs: The type of object + companies: + type: optional> + docs: An array containing Company Objects + total_count: + type: optional + docs: The total number of companies associated to this contact + pages: + type: optional + source: + openapi: ../openapi.yml + ContactCompanies: + docs: >- + An object containing companies meta data about the companies that a + contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of companyies attached to this + contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactDeleted: + docs: deleted contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + deleted: + type: optional + docs: Whether the contact is deleted or not. + source: + openapi: ../openapi.yml + ContactList: + docs: Contacts are your users in Intercom. + properties: + type: + type: optional> + docs: Always list + data: + type: optional> + docs: The list of contact objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + ContactLocation: + docs: An object containing location meta data about a Intercom contact. + properties: + type: + type: optional + docs: Always location + country: + type: optional + docs: The country that the contact is located in + region: + type: optional + docs: The overal region that the contact is located in + city: + type: optional + docs: The city that the contact is located in + source: + openapi: ../openapi.yml + ContactNotes: + docs: >- + An object containing notes meta data about the notes that a contact has. + Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: optional> + docs: This object represents the notes attached to a contact. + url: + type: optional + docs: Url to get more company resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of companyies attached to this + contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactReference: + docs: reference to contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + source: + openapi: ../openapi.yml + ContactReplyBaseRequest: + properties: + message_type: literal<"comment"> + type: literal<"user"> + body: + type: string + docs: The text body of the comment. + created_at: + type: optional + docs: >- + The time the reply was created. If not provided, the current time will + be used. + attachment_urls: + type: optional> + docs: >- + A list of image URLs that will be added as attachments. You can + include up to 10 URLs. + source: + openapi: ../openapi.yml + ContactReplyConversationRequest: + discriminated: false + union: + - type: ContactReplyIntercomUserIdRequest + - type: Email + - type: ContactReplyUserIdRequest + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. + source: + openapi: ../openapi.yml + ContactReplyIntercomUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + attachment_files: + type: optional> + docs: A list of files that will be added as attachments. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyTicketIntercomUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyTicketRequest: + discriminated: false + union: + - type: ContactReplyTicketIntercomUserIdRequest + - type: ContactReplyTicketUserIdRequest + - type: Email + source: + openapi: ../openapi.yml + ContactReplyTicketUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `user_id` + properties: + user_id: + type: string + docs: The external_id you have defined for the contact. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + ContactReplyUserIdRequest: + docs: >- + Payload of the request to reply on behalf of a contact using their + `user_id` + properties: + user_id: + type: string + docs: The external_id you have defined for the contact. + attachment_files: + type: optional> + docs: >- + A list of files that will be added as attachments. You can include up + to 10 files. + extends: + - ContactReplyBaseRequest + source: + openapi: ../openapi.yml + Segments: + docs: A list of segments objects attached to a specific contact. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: Segment objects associated with the contact. + source: + openapi: ../openapi.yml + ContactSocialProfiles: + docs: An object containing social profiles that a contact has. + properties: + data: + type: optional> + docs: A list of social profiles objects associated with the contact. + source: + openapi: ../openapi.yml + ContactSubscriptionTypes: + docs: >- + An object containing Subscription Types meta data about the + SubscriptionTypes that a contact has. + properties: + data: + type: optional> + docs: This object represents the subscriptions attached to a contact. + url: + type: optional + docs: Url to get more subscription type resources for this contact + validation: + format: uri + total_count: + type: optional + docs: >- + Int representing the total number of subscription types attached to + this contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactTags: + docs: >- + An object containing tags meta data about the tags that a contact has. Up + to 10 will be displayed here. Use the url to get more. + properties: + data: + type: optional> + docs: This object represents the tags attached to a contact. + url: + type: optional + docs: url to get more tag resources for this contact + validation: + format: uri + total_count: + type: optional + docs: Int representing the total number of tags attached to this contact + has_more: + type: optional + docs: >- + Whether there's more Addressable Objects to be viewed. If true, use + the url to view all + source: + openapi: ../openapi.yml + ContactUnarchived: + docs: unarchived contact object + properties: + type: + type: optional> + docs: always contact + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + archived: + type: optional + docs: Whether the contact is archived or not. + source: + openapi: ../openapi.yml + ContentSourcesList: + properties: + type: + type: optional> + total_count: + type: optional + docs: >- + The total number of content sources used by AI Agent in the + conversation. + content_sources: + type: optional> + docs: The content sources used by AI Agent in the conversation. + source: + openapi: ../openapi.yml + ConversationAttachmentFiles: + docs: Properties of the attachment files in a conversation part + properties: + content_type: + type: optional + docs: The content type of the file + data: + type: optional + docs: The base64 encoded file data. + name: + type: optional + docs: The name of the file. + source: + openapi: ../openapi.yml + Contacts: + docs: >- + The list of contacts (users or leads) involved in this conversation. This + will only contain one customer unless more were added via the group + conversation feature. + properties: + type: + type: optional> + docs: '' + contacts: + type: optional> + docs: >- + The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the + group conversation feature. + source: + openapi: ../openapi.yml + ConversationFirstContactReply: + docs: >- + An object containing information on the first users message. For a contact + initiated message this will represent the users original message. + properties: + created_at: + type: optional + docs: '' + type: + type: optional + docs: '' + url: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ConversationList: + docs: >- + Conversations are how you can communicate with users in Intercom. They are + created when a contact replies to an outbound message, or when one admin + directly sends a message to a single contact. + properties: + type: + type: optional> + docs: Always conversation.list + conversations: + type: optional> + docs: The list of conversation objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + ConversationPart: + docs: A Conversation Part represents a message in the conversation. + properties: + type: + type: optional + docs: Always conversation_part + id: + type: optional + docs: The id representing the conversation part. + part_type: + type: optional + docs: The type of conversation part. + body: + type: optional + docs: >- + The message body, which may contain HTML. For Twitter, this will show + a generic message regarding why the body is obscured. + created_at: + type: optional + docs: The time the conversation part was created. + updated_at: + type: optional + docs: The last time the conversation part was updated. + notified_at: + type: optional + docs: The time the user was notified with the conversation part. + assigned_to: + type: optional + docs: >- + The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + external_id: + type: optional + docs: The external id of the conversation part + redacted: + type: optional + docs: Whether or not the conversation part has been redacted. + source: + openapi: ../openapi.yml + ConversationPartAuthor: + docs: >- + The object who initiated the conversation, which can be a Contact, Admin + or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: optional + docs: The type of the author + id: + type: optional + docs: The id of the author + name: + type: optional + docs: The name of the author + email: + type: optional + docs: The email of the author + validation: + format: email + source: + openapi: ../openapi.yml + ConversationParts: + docs: >- + A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and + ignored when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: optional> + docs: '' + conversation_parts: + type: optional> + docs: >- + A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 + parts. + total_count: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ConversationRating: + docs: >- + The Conversation Rating object which contains information on the rating + and/or remark added by a Contact and the Admin assigned to the + conversation. + properties: + rating: + type: optional + docs: The rating, between 1 and 5, for the conversation. + remark: + type: optional + docs: An optional field to add a remark to correspond to the number rating + created_at: + type: optional + docs: The time the rating was requested in the conversation being rated. + contact: + type: optional + teammate: + type: optional + source: + openapi: ../openapi.yml + ConversationSource: + docs: >- + The Conversation Part that originated this conversation, which can be + Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: optional + docs: >- + This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + id: + type: optional + docs: The id representing the message. + delivered_as: + type: optional + docs: >- + The conversation's initiation type. Possible values are + customer_initiated, campaigns_initiated (legacy campaigns), + operator_initiated (Custom bot), automated (Series and other outbounds + with dynamic audience message) and admin_initiated (fixed audience + message, ticket initiated by an admin, group email). + subject: + type: optional + docs: >- + Optional. The message subject. For Twitter, this will show a generic + message regarding why the subject is obscured. + body: + type: optional + docs: >- + The message body, which may contain HTML. For Twitter, this will show + a generic message regarding why the body is obscured. + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + url: + type: optional + docs: >- + The URL where the conversation was started. For Twitter, Email, and + Bots, this will be blank. + redacted: + type: optional + docs: >- + Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + source: + openapi: ../openapi.yml + ConversationStatistics: + docs: >- + A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: optional + docs: '' + time_to_assignment: + type: optional + docs: Duration until last assignment before first admin reply. In seconds. + time_to_admin_reply: + type: optional + docs: >- + Duration until first admin reply. Subtracts out of business hours. In + seconds. + time_to_first_close: + type: optional + docs: >- + Duration until conversation was closed first time. Subtracts out of + business hours. In seconds. + time_to_last_close: + type: optional + docs: >- + Duration until conversation was closed last time. Subtracts out of + business hours. In seconds. + median_time_to_reply: + type: optional + docs: >- + Median based on all admin replies after a contact reply. Subtracts out + of business hours. In seconds. + first_contact_reply_at: + type: optional + docs: Time of first text conversation part from a contact. + first_assignment_at: + type: optional + docs: Time of first assignment after first_contact_reply_at. + first_admin_reply_at: + type: optional + docs: Time of first admin reply after first_contact_reply_at. + first_close_at: + type: optional + docs: Time of first close after first_contact_reply_at. + last_assignment_at: + type: optional + docs: Time of last assignment after first_contact_reply_at. + last_assignment_admin_reply_at: + type: optional + docs: Time of first admin reply since most recent assignment. + last_contact_reply_at: + type: optional + docs: Time of the last conversation part from a contact. + last_admin_reply_at: + type: optional + docs: Time of the last conversation part from an admin. + last_close_at: + type: optional + docs: Time of the last conversation close. + last_closed_by_id: + type: optional + docs: >- + The last admin who closed the conversation. Returns a reference to an + Admin object. + count_reopens: + type: optional + docs: Number of reopens after first_contact_reply_at. + count_assignments: + type: optional + docs: Number of assignments after first_contact_reply_at. + count_conversation_parts: + type: optional + docs: Total number of conversation parts. + source: + openapi: ../openapi.yml + ConversationTeammates: + docs: >- + The list of teammates who participated in the conversation (wrote at least + one conversation part). + properties: + type: + type: optional + docs: The type of the object - `admin.list`. + teammates: + type: optional> + docs: >- + The list of teammates who participated in the conversation (wrote at + least one conversation part). + source: + openapi: ../openapi.yml + CreateArticleRequestState: + enum: + - published + - draft + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults to + draft. For multilingual articles, this will be the state of the default + language's content. + source: + openapi: ../openapi.yml + CreateArticleRequest: + docs: You can create an Article + properties: + title: + type: string + docs: >- + The title of the article.For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The content of the article. For multilingual articles, this will be + the body of the default language's content. + author_id: + type: integer + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults + to draft. For multilingual articles, this will be the state of the + default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + translated_content: + type: optional + source: + openapi: ../openapi.yml + CreateContactRequestTwo: unknown + CreateDataEventRequestTwo: unknown + CreateMessageRequestOne: unknown + CreateOrUpdateCompanyRequest: + docs: You can create or update a Company + properties: + name: + type: optional + docs: The name of the Company + company_id: + type: optional + docs: The company id you have defined for the company. Can't be updated + plan: + type: optional + docs: The name of the plan you have associated with the company. + size: + type: optional + docs: The number of employees in this company. + website: + type: optional + docs: >- + The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + industry: + type: optional + docs: The industry that this company operates in. + custom_attributes: + type: optional> + docs: >- + A hash of key/value pairs containing any other data about the company + you want Intercom to store. + remote_created_at: + type: optional + docs: The time the company was created by you. + monthly_spend: + type: optional + docs: >- + How much revenue the company generates for your business. Note that + this will truncate floats. i.e. it only allow for whole integers, + 155.98 will be truncated to 155. Note that this has an upper limit of + 2**31-1 or 2147483647.. + source: + openapi: ../openapi.yml + CreateOrUpdateTagRequest: + docs: You can create or update an existing tag. + properties: + name: + type: string + docs: >- + The name of the tag, which will be created if not found, or the new + name for the tag if this is an update request. Names are case + insensitive. + id: + type: optional + docs: The id of tag to updates. + source: + openapi: ../openapi.yml + CreatePhoneSwitchRequest: + docs: You can create an phone switch + properties: + phone: + type: string + docs: >- + Phone number in E.164 format, that will receive the SMS to continue + the conversation in the Messenger. + custom_attributes: + type: optional + source: + openapi: ../openapi.yml + CreateTicketReplyWithCommentRequest: + discriminated: false + union: + - type: ContactReplyTicketRequest + - type: AdminReplyTicketRequest + source: + openapi: ../openapi.yml + CreateTicketTypeRequestCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + CreateTicketTypeRequest: + docs: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + properties: + name: + type: string + docs: The name of the ticket type. + description: + type: optional + docs: The description of the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + icon: + type: optional + docs: The icon of the ticket type. + default: 🎟️ + is_internal: + type: optional + docs: >- + Whether the tickets associated with this ticket type are intended for + internal use only or will be shared with customers. This is currently + a limited attribute. + default: false + source: + openapi: ../openapi.yml + CursorPages: + docs: > + Cursor-based pagination is a technique used in the Intercom API to + navigate through large amounts of data. + + A "cursor" or pointer is used to keep track of the current position in the + result set, allowing the API to return the data in small chunks or "pages" + as needed. + properties: + type: + type: optional> + docs: the type of object `pages`. + page: + type: optional + docs: The current page + next: + type: optional + per_page: + type: optional + docs: Number of results per page + total_pages: + type: optional + docs: Total number of pages + source: + openapi: ../openapi.yml + CustomAttributesValue: + discriminated: false + union: + - string + - type: optional + source: + openapi: ../openapi.yml + CustomAttributes: + type: map + docs: >- + An object containing the different custom attributes associated to the + conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + CustomerRequestIntercomUserId: + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + source: + openapi: ../openapi.yml + CustomerRequestUserId: + properties: + user_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + source: + openapi: ../openapi.yml + CustomerRequest: + discriminated: false + union: + - type: CustomerRequestIntercomUserId + - type: CustomerRequestUserId + - type: Email + source: + openapi: ../openapi.yml + DataAttributeList: + docs: >- + A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: A list of data attributes + source: + openapi: ../openapi.yml + DataEventListPages: + docs: Pagination + properties: + next: optional + since: optional + source: + openapi: ../openapi.yml + DataEventList: + docs: This will return a list of data events for the App. + properties: + type: + type: optional> + docs: The type of the object + events: + type: optional> + docs: A list of data events + pages: + type: optional + docs: Pagination + source: + openapi: ../openapi.yml + DataEventSummary: + docs: This will return a summary of data events for the App. + properties: + type: + type: optional> + docs: The type of the object + email: + type: optional + docs: The email address of the user + intercom_user_id: + type: optional + docs: The Intercom user ID of the user + user_id: + type: optional + docs: The user ID of the user + events: + type: optional>> + docs: A summary of data events + source: + openapi: ../openapi.yml + DataEventSummaryItem: + docs: This will return a summary of a data event for the App. + properties: + name: + type: optional + docs: The name of the event + first: + type: optional + docs: The first time the event was sent + last: + type: optional + docs: The last time the event was sent + count: + type: optional + docs: The number of times the event was sent + description: + type: optional + docs: The description of the event + source: + openapi: ../openapi.yml + DataExportCsv: + docs: A CSV output file + properties: + user_id: + type: optional + docs: The user_id of the user who was sent the message. + user_external_id: + type: optional + docs: The external_user_id of the user who was sent the message + company_id: + type: optional + docs: >- + The company ID of the user in relation to the message that was sent. + Will return -1 if no company is present. + email: + type: optional + docs: The users email who was sent the message. + name: + type: optional + docs: The full name of the user receiving the message + ruleset_id: + type: optional + docs: The id of the message. + content_id: + type: optional + docs: >- + The specific content that was received. In an A/B test each version + has its own Content ID. + content_type: + type: optional + docs: Email, Chat, Post etc. + content_title: + type: optional + docs: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: optional + docs: >- + As you edit content we record new versions. This ID can help you + determine which version of a piece of content that was received. + receipt_id: + type: optional + docs: >- + ID for this receipt. Will be included with any related stats in other + files to identify this specific delivery of a message. + received_at: + type: optional + docs: Timestamp for when the receipt was recorded. + series_id: + type: optional + docs: >- + The id of the series that this content is part of. Will return -1 if + not part of a series. + series_title: + type: optional + docs: The title of the series that this content is part of. + node_id: + type: optional + docs: >- + The id of the series node that this ruleset is associated with. Each + block in a series has a corresponding node_id. + first_reply: + type: optional + docs: >- + The first time a user replied to this message if the content was able + to receive replies. + first_completion: + type: optional + docs: >- + The first time a user completed this message if the content was able + to be completed e.g. Tours, Surveys. + first_series_completion: + type: optional + docs: >- + The first time the series this message was a part of was completed by + the user. + first_series_disengagement: + type: optional + docs: >- + The first time the series this message was a part of was disengaged by + the user. + first_series_exit: + type: optional + docs: >- + The first time the series this message was a part of was exited by the + user. + first_goal_success: + type: optional + docs: >- + The first time the user met this messages associated goal if one + exists. + first_open: + type: optional + docs: The first time the user opened this message. + first_click: + type: optional + docs: >- + The first time the series the user clicked on a link within this + message. + first_dismisall: + type: optional + docs: The first time the series the user dismissed this message. + first_unsubscribe: + type: optional + docs: The first time the user unsubscribed from this message. + first_hard_bounce: + type: optional + docs: The first time this message hard bounced for this user + source: + openapi: ../openapi.yml + DeletedArticleObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the article which you provided in the URL. + object: + type: optional> + docs: The type of object which was deleted. - article + deleted: + type: optional + docs: Whether the article was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedCollectionObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: >- + The unique identifier for the collection which you provided in the + URL. + object: + type: optional> + docs: The type of object which was deleted. - `collection` + deleted: + type: optional + docs: Whether the collection was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedCompanyObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the company which is given by Intercom. + object: + type: optional> + docs: The type of object which was deleted. - `company` + deleted: + type: optional + docs: Whether the company was deleted successfully or not. + source: + openapi: ../openapi.yml + DeletedObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the news item which you provided in the URL. + object: + type: optional> + docs: The type of object which was deleted - news-item. + deleted: + type: optional + docs: Whether the news item was deleted successfully or not. + source: + openapi: ../openapi.yml + ErrorErrorsItem: + properties: + code: + type: string + docs: >- + A string indicating the kind of error, used to further qualify the + HTTP response code + message: + type: optional + docs: Optional. Human readable description of the error. + field: + type: optional + docs: >- + Optional. Used to identify a particular field or query parameter that + was in error. + source: + openapi: ../openapi.yml + Error: + docs: >- + The API will return an Error List for a failed request, which will contain + one or more Error objects. + properties: + type: + type: string + docs: The type is error.list + request_id: + type: optional + docs: '' + validation: + format: uuid + errors: + docs: An array of one or more error objects + type: list + source: + openapi: ../openapi.yml + File: + docs: The value describing a file upload set for a custom attribute + properties: + type: + type: optional + name: + type: optional + docs: The name of the file + url: + type: optional + docs: >- + The url of the file. This is a temporary URL and will expire after 30 + minutes. + content_type: + type: optional + docs: The type of file + filesize: + type: optional + docs: The size of the file in bytes + width: + type: optional + docs: The width of the file in pixels, if applicable + height: + type: optional + docs: The height of the file in pixels, if applicable + source: + openapi: ../openapi.yml + GroupContent: + docs: The Content of a Group. + properties: + type: + type: optional + docs: The type of object - `group_content` . + name: + type: optional + docs: The name of the collection or section. + description: + type: optional + docs: The description of the collection. Only available for collections. + source: + openapi: ../openapi.yml + GroupTranslatedContent: + docs: >- + The Translated Content of an Group. The keys are the locale codes and the + values are the translated content of the Group. + properties: + type: + type: optional + docs: The type of object - group_translated_content. + ar: + type: optional + docs: The content of the group in Arabic + bg: + type: optional + docs: The content of the group in Bulgarian + bs: + type: optional + docs: The content of the group in Bosnian + ca: + type: optional + docs: The content of the group in Catalan + cs: + type: optional + docs: The content of the group in Czech + da: + type: optional + docs: The content of the group in Danish + de: + type: optional + docs: The content of the group in German + el: + type: optional + docs: The content of the group in Greek + en: + type: optional + docs: The content of the group in English + es: + type: optional + docs: The content of the group in Spanish + et: + type: optional + docs: The content of the group in Estonian + fi: + type: optional + docs: The content of the group in Finnish + fr: + type: optional + docs: The content of the group in French + he: + type: optional + docs: The content of the group in Hebrew + hr: + type: optional + docs: The content of the group in Croatian + hu: + type: optional + docs: The content of the group in Hungarian + id: + type: optional + docs: The content of the group in Indonesian + it: + type: optional + docs: The content of the group in Italian + ja: + type: optional + docs: The content of the group in Japanese + ko: + type: optional + docs: The content of the group in Korean + lt: + type: optional + docs: The content of the group in Lithuanian + lv: + type: optional + docs: The content of the group in Latvian + mn: + type: optional + docs: The content of the group in Mongolian + nb: + type: optional + docs: The content of the group in Norwegian + nl: + type: optional + docs: The content of the group in Dutch + pl: + type: optional + docs: The content of the group in Polish + pt: + type: optional + docs: The content of the group in Portuguese (Portugal) + ro: + type: optional + docs: The content of the group in Romanian + ru: + type: optional + docs: The content of the group in Russian + sl: + type: optional + docs: The content of the group in Slovenian + sr: + type: optional + docs: The content of the group in Serbian + sv: + type: optional + docs: The content of the group in Swedish + tr: + type: optional + docs: The content of the group in Turkish + vi: + type: optional + docs: The content of the group in Vietnamese + pt-BR: + type: optional + docs: The content of the group in Portuguese (Brazil) + zh-CN: + type: optional + docs: The content of the group in Chinese (China) + zh-TW: + type: optional + docs: The content of the group in Chinese (Taiwan) + source: + openapi: ../openapi.yml + IntercomVersion: + enum: + - value: '1.0' + name: One0 + - value: '1.1' + name: One1 + - value: '1.2' + name: One2 + - value: '1.3' + name: One3 + - value: '1.4' + name: One4 + - value: '2.0' + name: Two0 + - value: '2.1' + name: Two1 + - value: '2.2' + name: Two2 + - value: '2.3' + name: Two3 + - value: '2.4' + name: Two4 + - value: '2.5' + name: Two5 + - value: '2.6' + name: Two6 + - value: '2.7' + name: Two7 + - value: '2.8' + name: Two8 + - value: '2.9' + name: Two9 + - value: '2.10' + name: Two10 + - value: '2.11' + name: Two11 + - Unstable + docs: >- + Intercom API version.
By default, it's equal to the version set in the + app package. + default: '2.11' + source: + openapi: ../openapi.yml + LinkedObjectType: + enum: + - ticket + - conversation + docs: ticket or conversation + source: + openapi: ../openapi.yml + LinkedObject: + docs: A linked conversation or ticket. + properties: + type: + type: optional + docs: ticket or conversation + id: + type: optional + docs: The ID of the linked object + category: + type: optional + docs: Category of the Linked Ticket Object. + source: + openapi: ../openapi.yml + LinkedObjectList: + docs: >- + An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: optional> + docs: Always list. + total_count: + type: optional + docs: The total number of linked objects. + has_more: + type: optional + docs: Whether or not there are more linked objects than returned. + data: + type: optional> + docs: An array containing the linked conversations and linked tickets. + source: + openapi: ../openapi.yml + MultipleFilterSearchRequestOperator: + enum: + - AND + - OR + docs: An operator to allow boolean inspection between multiple fields. + source: + openapi: ../openapi.yml + MultipleFilterSearchRequestValue: + discriminated: false + union: + - docs: Add mutiple filters. + type: list + - docs: Add a single filter field. + type: list + source: + openapi: ../openapi.yml + MultipleFilterSearchRequest: + docs: Search using Intercoms Search APIs with more than one filter. + properties: + operator: + type: optional + docs: An operator to allow boolean inspection between multiple fields. + value: + type: optional + source: + openapi: ../openapi.yml + NewsItemRequestState: + enum: + - draft + - live + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + source: + openapi: ../openapi.yml + NewsItemRequest: + docs: >- + A News Item is a content type in Intercom enabling you to announce product + updates, company news, promotions, events and more with your customers. + properties: + title: + type: string + docs: The title of the news item. + body: + type: optional + docs: The news item body, which may contain HTML. + sender_id: + type: integer + docs: >- + The id of the sender of the news item. Must be a teammate on the + workspace. + state: + type: optional + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + deliver_silently: + type: optional + docs: >- + When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + labels: + type: optional> + docs: Label names displayed to users to categorize the news item. + reactions: + type: optional>> + docs: >- + Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + newsfeed_assignments: + type: optional> + docs: A list of newsfeed_assignments to assign to the specified newsfeed. + source: + openapi: ../openapi.yml + NoteList: + docs: A paginated list of notes associated with a contact. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `list`. + data: + type: optional> + docs: An array of notes. + total_count: + type: optional + docs: A count of the total number of notes. + pages: + type: optional + source: + openapi: ../openapi.yml + OpenConversationRequest: + docs: Payload of the request to open a conversation + properties: + admin_id: + type: string + docs: The id of the admin who is performing the action. + source: + openapi: ../openapi.yml + PagesLink: + docs: > + The majority of list resources in the API are paginated to allow clients + to traverse data over multiple requests. + + + Their responses are likely to contain a pages object that hosts pagination + links which a client can use to paginate through the data without having + to construct a query. The link relations for the pages field are as + follows. + properties: + type: + type: optional> + page: + type: optional + next: + type: optional + docs: >- + A link to the next page of results. A response that does not contain a + next link does not have further data to fetch. + validation: + format: uri + per_page: + type: optional + total_pages: + type: optional + source: + openapi: ../openapi.yml + PaginatedResponseType: + enum: + - list + - value: conversation.list + name: ConversationList + docs: The type of object + source: + openapi: ../openapi.yml + PaginatedResponseDataItem: + discriminant: type + base-properties: {} + union: + news-item: + type: news.NewsItem + newsfeed: + type: news.Newsfeed + source: + openapi: ../openapi.yml + PaginatedResponse: + docs: Paginated Response + properties: + type: + type: optional + docs: The type of object + pages: + type: optional + total_count: + type: optional + docs: A count of the total number of objects. + data: + type: optional> + docs: An array of Objects + source: + openapi: ../openapi.yml + PartAttachment: + docs: The file attached to a part + properties: + type: + type: optional + docs: The type of attachment + name: + type: optional + docs: The name of the attachment + url: + type: optional + docs: The URL of the attachment + content_type: + type: optional + docs: The content type of the attachment + filesize: + type: optional + docs: The size of the attachment + width: + type: optional + docs: The width of the attachment + height: + type: optional + docs: The height of the attachment + source: + openapi: ../openapi.yml + PhoneSwitch: + docs: Phone Switch Response + properties: + type: + type: optional> + docs: '' + phone: + type: optional + docs: >- + Phone number in E.164 format, that has received the SMS to continue + the conversation in the Messenger. + source: + openapi: ../openapi.yml + RedactConversationRequestConversationPart: + docs: Payload of the request to redact a conversation part + properties: + conversation_id: + type: string + docs: The id of the conversation. + conversation_part_id: + type: string + docs: The id of the conversation_part. + source: + openapi: ../openapi.yml + RedactConversationRequestSource: + docs: Payload of the request to redact a conversation source + properties: + conversation_id: + type: string + docs: The id of the conversation. + source_id: + type: string + docs: The id of the source. + source: + openapi: ../openapi.yml + RedactConversationRequest: + discriminant: type + base-properties: {} + union: + conversation_part: + type: RedactConversationRequestConversationPart + docs: Payload of the request to redact a conversation part + source: + type: RedactConversationRequestSource + docs: Payload of the request to redact a conversation source + source: + openapi: ../openapi.yml + Reference: + docs: reference to another object + properties: + type: + type: optional + docs: '' + id: + type: optional + docs: '' + source: + openapi: ../openapi.yml + ReplyConversationRequest: + discriminated: false + union: + - type: ContactReplyConversationRequest + - type: AdminReplyConversationRequest + source: + openapi: ../openapi.yml + SearchRequestQuery: + discriminated: false + union: + - type: SingleFilterSearchRequest + - type: MultipleFilterSearchRequest + source: + openapi: ../openapi.yml + SearchRequest: + docs: Search using Intercoms Search APIs. + properties: + query: SearchRequestQuery + pagination: + type: optional + source: + openapi: ../openapi.yml + SegmentList: + docs: >- + This will return a list of Segment Objects. The result may also have a + pages object if the response is paginated. + properties: + type: + type: optional> + docs: The type of the object + segments: + type: optional> + docs: A list of Segment objects + pages: + type: optional> + docs: >- + A pagination object, which may be empty, indicating no further pages + to fetch. + source: + openapi: ../openapi.yml + SingleFilterSearchRequestOperator: + enum: + - value: '=' + name: EQUAL_TO + - value: '!=' + name: NOT_EQUALS + - IN + - NIN + - value: < + name: LESS_THAN + - value: '>' + name: GREATER_THAN + - value: '~' + name: '' + docs: >- + The accepted operators you can use to define how you want to search for + the value. + source: + openapi: ../openapi.yml + SingleFilterSearchRequest: + docs: Search using Intercoms Search APIs with a single filter. + properties: + field: + type: optional + docs: The accepted field that you want to search on. + operator: + type: optional + docs: >- + The accepted operators you can use to define how you want to search + for the value. + value: + type: optional + docs: The value that you want to search on. + source: + openapi: ../openapi.yml + SlaAppliedSlaStatus: + enum: + - hit + - missed + - cancelled + - active + docs: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + source: + openapi: ../openapi.yml + SlaApplied: + docs: > + The SLA Applied object contains the details for which SLA has been applied + to this conversation. + + Important: if there are any canceled sla_events for the conversation - + meaning an SLA has been manually removed from a conversation, the + sla_status will always be returned as null. + properties: + type: + type: optional + docs: object type + sla_name: + type: optional + docs: The name of the SLA as given by the teammate when it was created. + sla_status: + type: optional + docs: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + source: + openapi: ../openapi.yml + SnoozeConversationRequest: + docs: Payload of the request to snooze a conversation + properties: + admin_id: + type: string + docs: The id of the admin who is performing the action. + snoozed_until: + type: integer + docs: The time you want the conversation to reopen. + source: + openapi: ../openapi.yml + SocialProfile: + docs: >- + A Social Profile allows you to label your contacts, companies, and + conversations and list them using that Social Profile. + properties: + type: + type: optional + docs: value is "social_profile" + name: + type: optional + docs: The name of the Social media profile + url: + type: optional + docs: The name of the Social media profile + validation: + format: uri + source: + openapi: ../openapi.yml + StartingAfterPaging: + properties: + per_page: + type: optional + docs: The number of results to fetch per page. + starting_after: + type: optional + docs: The cursor to use in the next request to get the next page of results. + source: + openapi: ../openapi.yml + SubscriptionTypeList: + docs: A list of subscription type objects. + properties: + type: + type: optional> + docs: The type of the object + data: + type: optional> + docs: A list of subscription type objects associated with the workspace . + source: + openapi: ../openapi.yml + TagCompanyRequestCompaniesItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the company. + company_id: + type: optional + docs: The company id you have defined for the company. + source: + openapi: ../openapi.yml + TagCompanyRequest: + docs: You can tag a single company or a list of companies. + properties: + name: + type: string + docs: The name of the tag, which will be created if not found. + companies: + docs: The id or company_id of the company can be passed as input parameters. + type: list + source: + openapi: ../openapi.yml + Tags: + docs: A list of tags objects associated with a conversation + properties: + type: + type: optional> + docs: The type of the object + tags: + type: optional> + docs: A list of tags objects associated with the conversation. + source: + openapi: ../openapi.yml + TagMultipleUsersRequestUsersItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the user. + source: + openapi: ../openapi.yml + TagMultipleUsersRequest: + docs: You can tag a list of users. + properties: + name: + type: string + docs: The name of the tag, which will be created if not found. + users: list + source: + openapi: ../openapi.yml + TeamList: + docs: This will return a list of team objects for the App. + properties: + type: + type: optional> + docs: The type of the object + teams: + type: optional> + docs: A list of team objects + source: + openapi: ../openapi.yml + TeamPriorityLevel: + docs: Admin priority levels for teams + properties: + primary_team_ids: + type: optional> + docs: The primary team ids for the team + secondary_team_ids: + type: optional> + docs: The secondary team ids for the team + source: + openapi: ../openapi.yml + TicketCustomAttributesValue: + discriminated: false + union: + - optional + - double + - boolean + - list + - type: File + source: + openapi: ../openapi.yml + TicketCustomAttributes: + type: map + docs: >- + An object containing the different attributes associated to the ticket as + key-value pairs. For the default title and description attributes, the + keys are `_default_title_` and `_default_description_`. + TicketList: + docs: Tickets are how you track requests from your users. + properties: + type: + type: optional> + docs: Always ticket.list + tickets: + type: optional>> + docs: The list of ticket objects + total_count: + type: optional + docs: A count of the total number of objects. + pages: + type: optional + source: + openapi: ../openapi.yml + TicketPartAuthorType: + enum: + - admin + - bot + - team + - user + docs: The type of the author + source: + openapi: ../openapi.yml + TicketPartAuthor: + docs: >- + The author that wrote or triggered the part. Can be a bot, admin, team or + user. + properties: + type: + type: optional + docs: The type of the author + id: + type: optional + docs: The id of the author + name: + type: optional + docs: The name of the author + email: + type: optional + docs: The email of the author + validation: + format: email + source: + openapi: ../openapi.yml + TicketParts: + docs: >- + A list of Ticket Part objects for each note and event in the ticket. There + is a limit of 500 parts. + properties: + type: + type: optional> + docs: '' + ticket_parts: + type: optional> + docs: >- + A list of Ticket Part objects for each ticket. There is a limit of 500 + parts. + total_count: + type: optional + docs: '' + source: + openapi: ../openapi.yml + TicketReplyPartType: + enum: + - note + - comment + - quick_reply + docs: Type of the part + source: + openapi: ../openapi.yml + TicketReply: + docs: A Ticket Part representing a note, comment, or quick_reply on a ticket + properties: + type: + type: optional> + docs: Always ticket_part + id: + type: optional + docs: The id representing the part. + part_type: + type: optional + docs: Type of the part + body: + type: optional + docs: The message body, which may contain HTML. + created_at: + type: optional + docs: The time the note was created. + updated_at: + type: optional + docs: The last time the note was updated. + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + redacted: + type: optional + docs: Whether or not the ticket part has been redacted. + source: + openapi: ../openapi.yml + TicketRequestCustomAttributesValue: + discriminated: false + union: + - optional + - double + - boolean + - list + source: + openapi: ../openapi.yml + TicketRequestCustomAttributes: + type: map + docs: >- + The attributes set on the ticket. When setting the default title and + description attributes, the attribute keys that should be used are + `_default_title_` and `_default_description_`. When setting ticket type + attributes of the list attribute type, the key should be the attribute + name and the value of the attribute should be the list item id, obtainable + by [listing the ticket type](ref:get_ticket-types). For example, if the + ticket type has an attribute called `priority` of type `list`, the key + should be `priority` and the value of the attribute should be the guid of + the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + TicketTypeAttribute: + docs: >- + Ticket type attribute, used to define each data field to be captured in a + ticket. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type_attribute`. + id: + type: optional + docs: The id representing the ticket type attribute. + workspace_id: + type: optional + docs: The id of the workspace that the ticket type attribute belongs to. + name: + type: optional + docs: The name of the ticket type attribute + description: + type: optional + docs: The description of the ticket type attribute + data_type: + type: optional + docs: >- + The type of the data attribute (allowed values: "string list integer + decimal boolean datetime files") + input_options: + type: optional> + docs: Input options for the attribute + order: + type: optional + docs: The order of the attribute against other attributes + required_to_create: + type: optional + docs: Whether the attribute is required or not for teammates. + default: false + required_to_create_for_contacts: + type: optional + docs: Whether the attribute is required or not for contacts. + default: false + visible_on_create: + type: optional + docs: Whether the attribute is visible or not to teammates. + default: true + visible_to_contacts: + type: optional + docs: Whether the attribute is visible or not to contacts. + default: true + default: + type: optional + docs: Whether the attribute is built in or not. + ticket_type_id: + type: optional + docs: The id of the ticket type that the attribute belongs to. + archived: + type: optional + docs: Whether the ticket type attribute is archived or not. + created_at: + type: optional + docs: The date and time the ticket type attribute was created. + updated_at: + type: optional + docs: The date and time the ticket type attribute was last updated. + source: + openapi: ../openapi.yml + TicketTypeAttributeList: + docs: A list of attributes associated with a given ticket type. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: optional>> + docs: A list of ticket type attributes associated with a given ticket type. + source: + openapi: ../openapi.yml + TicketTypeList: + docs: A list of ticket types associated with a given workspace. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: optional>> + docs: A list of ticket_types associated with a given workspace. + source: + openapi: ../openapi.yml + Translation: + docs: >- + A translation object contains the localised details of a subscription + type. + properties: + name: + type: optional + docs: The localised name of the subscription type. + description: + type: optional + docs: The localised description of the subscription type. + locale: + type: optional + docs: >- + The two character identifier for the language of the translation + object. + source: + openapi: ../openapi.yml + UntagCompanyRequestCompaniesItem: + properties: + id: + type: optional + docs: The Intercom defined id representing the company. + company_id: + type: optional + docs: The company id you have defined for the company. + untag: + type: optional + docs: Always set to true + source: + openapi: ../openapi.yml + UntagCompanyRequest: + docs: You can tag a single company or a list of companies. + properties: + name: + type: string + docs: The name of the tag which will be untagged from the company + companies: + docs: The id or company_id of the company can be passed as input parameters. + type: list + source: + openapi: ../openapi.yml + UpdateArticleRequestState: + enum: + - published + - draft + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults to + draft. For multilingual articles, this will be the state of the default + language's content. + source: + openapi: ../openapi.yml + UpdateArticleRequest: + docs: You can Update an Article + properties: + title: + type: optional + docs: >- + The title of the article.For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The content of the article. For multilingual articles, this will be + the body of the default language's content. + author_id: + type: optional + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article will be `published` or will be a `draft`. Defaults + to draft. For multilingual articles, this will be the state of the + default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + translated_content: + type: optional + source: + openapi: ../openapi.yml + UpdateTicketTypeRequestCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + UpdateTicketTypeRequest: + docs: > + The request payload for updating a ticket type. + + You can copy the `icon` property for your ticket type from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + properties: + name: + type: optional + docs: The name of the ticket type. + description: + type: optional + docs: The description of the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + icon: + type: optional + docs: The icon of the ticket type. + default: 🎟️ + archived: + type: optional + docs: The archived status of the ticket type. + is_internal: + type: optional + docs: >- + Whether the tickets associated with this ticket type are intended for + internal use only or will be shared with customers. This is currently + a limited attribute. + default: false + source: + openapi: ../openapi.yml + UpdateVisitorRequestOne: unknown + VisitorAvatar: + properties: + type: + type: optional + docs: '' + default: avatar + image_url: + type: optional + docs: This object represents the avatar associated with the visitor. + validation: + format: uri + source: + openapi: ../openapi.yml + VisitorCompanies: + properties: + type: + type: optional> + docs: The type of the object + companies: optional> + source: + openapi: ../openapi.yml + VisitorLocationData: + properties: + type: + type: optional + docs: '' + default: location_data + city_name: + type: optional + docs: The city name of the visitor. + continent_code: + type: optional + docs: The continent code of the visitor. + country_code: + type: optional + docs: The country code of the visitor. + country_name: + type: optional + docs: The country name of the visitor. + postal_code: + type: optional + docs: The postal code of the visitor. + region_name: + type: optional + docs: The region name of the visitor. + timezone: + type: optional + docs: The timezone of the visitor. + source: + openapi: ../openapi.yml + VisitorSocialProfiles: + properties: + type: + type: optional> + docs: The type of the object + social_profiles: optional> + source: + openapi: ../openapi.yml + VisitorTagsTagsItem: + properties: + type: + type: optional> + docs: The type of the object + id: + type: optional + docs: The id of the tag. + name: + type: optional + docs: The name of the tag. + source: + openapi: ../openapi.yml + VisitorTags: + properties: + type: + type: optional> + docs: The type of the object + tags: optional> + source: + openapi: ../openapi.yml + VisitorSegments: + properties: + type: + type: optional> + docs: The type of the object + segments: optional> + source: + openapi: ../openapi.yml + Visitor: + docs: >- + Visitors are useful for representing anonymous people that have not yet + been identified. They usually represent website visitors. Visitors are not + visible in Intercom platform. The Visitors resource provides methods to + fetch, update, convert and delete. + properties: + type: + type: optional + docs: Value is 'visitor' + default: visitor + id: + type: optional + docs: The Intercom defined id representing the Visitor. + user_id: + type: optional + docs: Automatically generated identifier for the Visitor. + anonymous: + type: optional + docs: Identifies if this visitor is anonymous. + email: + type: optional + docs: The email of the visitor. + validation: + format: email + phone: + type: optional + docs: The phone number of the visitor. + name: + type: optional + docs: The name of the visitor. + pseudonym: + type: optional + docs: The pseudonym of the visitor. + avatar: + type: optional + app_id: + type: optional + docs: The id of the app the visitor is associated with. + companies: + type: optional + location_data: + type: optional + las_request_at: + type: optional + docs: The time the Lead last recorded making a request. + created_at: + type: optional + docs: The time the Visitor was added to Intercom. + remote_created_at: + type: optional + docs: The time the Visitor was added to Intercom. + signed_up_at: + type: optional + docs: The time the Visitor signed up for your product. + updated_at: + type: optional + docs: The last time the Visitor was updated. + session_count: + type: optional + docs: The number of sessions the Visitor has had. + social_profiles: + type: optional + owner_id: + type: optional + docs: The id of the admin that owns the Visitor. + unsubscribed_from_emails: + type: optional + docs: Whether the Visitor is unsubscribed from emails. + marked_email_as_spam: + type: optional + docs: Identifies if this visitor has marked an email as spam. + has_hard_bounced: + type: optional + docs: Identifies if this visitor has had a hard bounce. + tags: + type: optional + segments: + type: optional + custom_attributes: + type: optional> + docs: The custom attributes you have set on the Visitor. + referrer: + type: optional + docs: The referer of the visitor. + utm_campaign: + type: optional + docs: The utm_campaign of the visitor. + utm_content: + type: optional + docs: The utm_content of the visitor. + utm_medium: + type: optional + docs: The utm_medium of the visitor. + utm_source: + type: optional + docs: The utm_source of the visitor. + utm_term: + type: optional + docs: The utm_term of the visitor. + do_not_track: + type: optional + docs: Identifies if this visitor has do not track enabled. + source: + openapi: ../openapi.yml + VisitorDeletedObject: + docs: Response returned when an object is deleted + properties: + id: + type: optional + docs: The unique identifier for the visitor which is given by Intercom. + type: + type: optional> + docs: The type of object which was deleted + user_id: + type: optional + docs: Automatically generated identifier for the Visitor. + source: + openapi: ../openapi.yml +imports: + admins: admins.yml + articles: articles.yml + helpCenter: helpCenter.yml + contacts: contacts.yml + segments: segments.yml + companies: companies.yml + aiContentSource: aiContentSource.yml + conversations: conversations.yml + customObjectInstances: customObjectInstances.yml + dataAttributes: dataAttributes.yml + dataEvents: dataEvents.yml + news: news.yml + notes: notes.yml + subscriptionTypes: subscriptionTypes.yml + tags: tags.yml + teams: teams.yml + tickets: tickets.yml +", + }, + "admins.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Admins", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Admins", + "endpoints": { + "identifyAdmin": { + "auth": true, + "display-name": "Identify an admin", + "docs": " +You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology). + +> 🚧 Single Sign On +> +> If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk. +", + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "app": { + "created_at": 1719492696, + "id_code": "this_is_an_id1_that_should_be_at_least_40", + "identity_verification": false, + "name": "MyApp 1", + "region": "US", + "timezone": "America/Los_Angeles", + "type": "app", + }, + "avatar": { + "image_url": "https://static.intercomassets.com/assets/default-avatars/admins/128.png", + "type": "avatar", + }, + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin1@email.com", + "email_verified": true, + "has_inbox_seat": true, + "id": "991267390", + "job_title": "Philosopher", + "name": "Ciaran1 Lee", + "team_ids": [ + 814865, + ], + "type": "admin", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/me", + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listActivityLogs": { + "auth": true, + "display-name": "List all activity logs", + "docs": "You can get a log of activities by all admins in an app.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "query-parameters": { + "created_at_after": "1677253093", + "created_at_before": "1677861493", + }, + "response": { + "body": { + "activity_logs": [ + { + "activity_description": "Ciaran5 Lee changed your Initial message title message from Initial message title to Eventual message title.", + "activity_type": "message_state_change", + "created_at": 1719492702, + "id": "ddee3a18-0032-4061-b9b9-26230c3dd5f7", + "performed_by": { + "email": "admin5@email.com", + "id": "991267395", + "ip": "127.0.0.1", + "type": "admin", + }, + }, + { + "activity_description": "Ciaran5 Lee changed your app name from before to after.", + "activity_type": "app_name_change", + "created_at": 1719492702, + "id": "5eec951b-db7a-4b5b-add5-95ffc90969b6", + "performed_by": { + "email": "admin5@email.com", + "id": "991267395", + "ip": "127.0.0.1", + "type": "admin", + }, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "type": "activity_log.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins/activity_logs", + "request": { + "name": "ListActivityLogsRequest", + "query-parameters": { + "created_at_after": { + "docs": "The start date that you request data for. It must be formatted as a UNIX timestamp.", + "type": "string", + }, + "created_at_before": { + "docs": "The end date that you request data for. It must be formatted as a UNIX timestamp.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.ActivityLogList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAdmins": { + "auth": true, + "display-name": "List all admins", + "docs": "You can fetch a list of admins for a given workspace.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "admins": [ + { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin7@email.com", + "has_inbox_seat": true, + "id": "991267397", + "job_title": "Philosopher", + "name": "Ciaran7 Lee", + "team_ids": [ + 814865, + ], + "type": "admin", + }, + ], + "type": "admin.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins", + "response": { + "docs": "Successful response", + "type": "root.Admins", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveAdmin": { + "auth": true, + "display-name": "Retrieve an admin", + "docs": "You can retrieve the details of a single admin.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Admin found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin9@email.com", + "has_inbox_seat": true, + "id": "991267399", + "job_title": "Philosopher", + "name": "Ciaran9 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/admins/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given admin", + "type": "integer", + }, + }, + "response": { + "docs": "Admin found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "setAwayAdmin": { + "auth": true, + "display-name": "Set an admin to away", + "docs": "You can set an Admin as away for the Inbox.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + { + "name": "Unauthorized", + "path-parameters": { + "id": 1, + }, + "request": { + "away_mode_enabled": true, + "away_mode_reassign": true, + }, + "response": { + "body": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": true, + "away_mode_reassign": true, + "email": "admin2@email.com", + "has_inbox_seat": true, + "id": "991267391", + "job_title": "Philosopher", + "name": "Ciaran2 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/admins/{id}/away", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given admin", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "away_mode_enabled": { + "default": true, + "docs": "Set to "true" to change the status of the admin to away.", + "type": "boolean", + }, + "away_mode_reassign": { + "default": false, + "docs": "Set to "true" to assign any new conversation replies to your default inbox.", + "type": "boolean", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "SetAwayAdminRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Admin": { + "docs": "Admins are teammate accounts that have access to a workspace.", + "properties": { + "avatar": { + "docs": "Image for the associated team or teammate", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "away_mode_enabled": { + "docs": "Identifies if this admin is currently set in away mode.", + "type": "optional", + }, + "away_mode_reassign": { + "docs": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.", + "type": "optional", + }, + "email": { + "docs": "The email of the admin.", + "type": "optional", + }, + "has_inbox_seat": { + "docs": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them.", + "type": "optional", + }, + "id": { + "docs": "The id representing the admin.", + "type": "optional", + }, + "job_title": { + "docs": "The job title of the admin.", + "type": "optional", + }, + "name": { + "docs": "The name of the admin.", + "type": "optional", + }, + "team_ids": { + "docs": "This object represents the avatar associated with the admin.", + "type": "optional>", + }, + "team_priority_level": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `admin`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + identifyAdmin: + path: /me + method: GET + auth: true + docs: > + + You can view the currently authorised admin along with the embedded app + object (a "workspace" in legacy terminology). + + + > 🚧 Single Sign On + + > + + > If you are building a custom "Log in with Intercom" flow for your + site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email + addresses as it poses a potential impersonation security risk. + source: + openapi: ../openapi.yml + display-name: Identify an admin + response: + docs: Successful response + type: optional + examples: + - name: Successful response + response: + body: + type: admin + id: '991267390' + name: Ciaran1 Lee + email: admin1@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/assets/default-avatars/admins/128.png + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + region: US + timezone: America/Los_Angeles + created_at: 1719492696 + identity_verification: false + setAwayAdmin: + path: /admins/{id}/away + method: PUT + auth: true + docs: You can set an Admin as away for the Inbox. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given admin + display-name: Set an admin to away + request: + name: SetAwayAdminRequest + body: + properties: + away_mode_enabled: + type: boolean + docs: Set to "true" to change the status of the admin to away. + default: true + away_mode_reassign: + type: boolean + docs: >- + Set to "true" to assign any new conversation replies to your + default inbox. + default: false + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + - name: Admin not found + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + - name: Unauthorized + path-parameters: + id: 1 + request: + away_mode_enabled: true + away_mode_reassign: true + response: + body: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + job_title: Philosopher + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + listActivityLogs: + path: /admins/activity_logs + method: GET + auth: true + docs: You can get a log of activities by all admins in an app. + source: + openapi: ../openapi.yml + display-name: List all activity logs + request: + name: ListActivityLogsRequest + query-parameters: + created_at_after: + type: string + docs: >- + The start date that you request data for. It must be formatted as + a UNIX timestamp. + created_at_before: + type: optional + docs: >- + The end date that you request data for. It must be formatted as a + UNIX timestamp. + response: + docs: Successful response + type: root.ActivityLogList + errors: + - root.UnauthorizedError + examples: + - name: Successful response + query-parameters: + created_at_after: '1677253093' + created_at_before: '1677861493' + response: + body: + type: activity_log.list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + activity_logs: + - id: ddee3a18-0032-4061-b9b9-26230c3dd5f7 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + created_at: 1719492702 + activity_type: message_state_change + activity_description: >- + Ciaran5 Lee changed your Initial message title message from + Initial message title to Eventual message title. + - id: 5eec951b-db7a-4b5b-add5-95ffc90969b6 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + created_at: 1719492702 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from before to after. + listAdmins: + path: /admins + method: GET + auth: true + docs: You can fetch a list of admins for a given workspace. + source: + openapi: ../openapi.yml + display-name: List all admins + response: + docs: Successful response + type: root.Admins + errors: + - root.UnauthorizedError + examples: + - name: Successful response + response: + body: + type: admin.list + admins: + - type: admin + id: '991267397' + name: Ciaran7 Lee + email: admin7@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + retrieveAdmin: + path: /admins/{id} + method: GET + auth: true + docs: You can retrieve the details of a single admin. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given admin + display-name: Retrieve an admin + response: + docs: Admin found + type: optional + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Admin found + path-parameters: + id: 1 + response: + body: + type: admin + id: '991267399' + name: Ciaran9 Lee + email: admin9@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + source: + openapi: ../openapi.yml + display-name: Admins +docs: Everything about your Admins +types: + Admin: + docs: Admins are teammate accounts that have access to a workspace. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `admin`. + id: + type: optional + docs: The id representing the admin. + name: + type: optional + docs: The name of the admin. + email: + type: optional + docs: The email of the admin. + job_title: + type: optional + docs: The job title of the admin. + away_mode_enabled: + type: optional + docs: Identifies if this admin is currently set in away mode. + away_mode_reassign: + type: optional + docs: >- + Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + has_inbox_seat: + type: optional + docs: >- + Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + team_ids: + type: optional> + docs: This object represents the avatar associated with the admin. + avatar: + type: optional + docs: Image for the associated team or teammate + validation: + format: uri + team_priority_level: + type: optional + source: + openapi: ../openapi.yml +", + }, + "aiAgent.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "imports": { + "root": "__package__.yml", + }, + "types": { + "AiAgent": { + "docs": "Data related to AI Agent involvement in the conversation.", + "properties": { + "content_sources": { + "type": "optional", + }, + "last_answer_type": { + "docs": "The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null`", + "type": "optional", + }, + "rating": { + "docs": "The customer satisfaction rating given to AI Agent, from 1-5.", + "type": "optional", + }, + "rating_remark": { + "docs": "The customer satisfaction rating remark given to AI Agent.", + "type": "optional", + }, + "resolution_state": { + "docs": "The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`.", + "type": "optional", + }, + "source_title": { + "docs": "The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`.", + "type": "optional", + }, + "source_type": { + "docs": "The type of the source that triggered AI Agent involvement in the conversation.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AiAgentSourceType": { + "docs": "The type of the source that triggered AI Agent involvement in the conversation.", + "enum": [ + "essentials_plan_setup", + "profile", + "workflow", + "workflow_preview", + "fin_preview", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + AiAgentSourceType: + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + docs: >- + The type of the source that triggered AI Agent involvement in the + conversation. + source: + openapi: ../openapi.yml + AiAgent: + docs: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: optional + docs: >- + The type of the source that triggered AI Agent involvement in the + conversation. + source_title: + type: optional + docs: >- + The title of the source that triggered AI Agent involvement in the + conversation. If this is `essentials_plan_setup` then it will return + `null`. + last_answer_type: + type: optional + docs: >- + The type of the last answer delivered by AI Agent. If no answer was + delivered then this will return `null` + resolution_state: + type: optional + docs: >- + The resolution state of AI Agent. If no AI or custom answer has been + delivered then this will return `null`. + rating: + type: optional + docs: The customer satisfaction rating given to AI Agent, from 1-5. + rating_remark: + type: optional + docs: The customer satisfaction rating remark given to AI Agent. + content_sources: + type: optional + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +", + }, + "aiContentSource.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "types": { + "ContentSource": { + "docs": "The content source used by AI Agent in the conversation.", + "properties": { + "content_type": { + "docs": "The type of the content source.", + "type": "optional", + }, + "locale": { + "docs": "The ISO 639 language code of the content source.", + "type": "optional", + }, + "title": { + "docs": "The title of the content source.", + "type": "optional", + }, + "url": { + "docs": "The internal URL linking to the content source for teammates.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContentSourceContentType": { + "docs": "The type of the content source.", + "enum": [ + "file", + "article", + "external_content", + "content_snippet", + "workflow_connector_action", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + ContentSourceContentType: + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + docs: The type of the content source. + source: + openapi: ../openapi.yml + ContentSource: + docs: The content source used by AI Agent in the conversation. + properties: + content_type: + type: optional + docs: The type of the content source. + url: + type: optional + docs: The internal URL linking to the content source for teammates. + title: + type: optional + docs: The title of the content source. + locale: + type: optional + docs: The ISO 639 language code of the content source. + source: + openapi: ../openapi.yml +", + }, + "articles.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Articles", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Articles", + "endpoints": { + "createArticle": { + "auth": true, + "display-name": "Create an article", + "docs": "You can create a new article by making a POST request to `https://api.intercom.io/articles`.", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "article created", + "request": { + "author_id": 991267407, + "body": "Body of the Article", + "description": "Description of the Article", + "parent_id": 145, + "parent_type": "collection", + "state": "published", + "title": "Thanks for everything", + "translated_content": { + "fr": { + "author_id": 991267407, + "body": "Corps de l'article", + "description": "Description de l'article", + "state": "published", + "title": "Merci pour tout", + }, + }, + }, + "response": { + "body": { + "author_id": 991267407, + "body": "

Body of the Article

", + "created_at": 1719492710, + "default_locale": "en", + "description": "Description of the Article", + "id": "42", + "parent_id": 145, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Thanks for everything", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Bad Request", + "request": { + "author_id": 1295, + "body": "Body of the Article", + "description": "Description of the Article", + "state": "published", + "title": "Thanks for everything", + }, + "response": { + "body": { + "author_id": 991267407, + "body": "

Body of the Article

", + "created_at": 1719492710, + "default_locale": "en", + "description": "Description of the Article", + "id": "42", + "parent_id": 145, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Thanks for everything", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492710, + "url": "http://help-center.test/myapp-37/en/articles/42-thanks-for-everything", + "workspace_id": "this_is_an_id37_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/articles", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "article created", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteArticle": { + "auth": true, + "display-name": "Delete an article", + "docs": "You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "51", + "object": "article", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedArticleObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listArticles": { + "auth": true, + "display-name": "List all articles", + "docs": "You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`. + +> 📘 How are the articles sorted and ordered? +> +> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first. +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "author_id": 991267402, + "body": "", + "created_at": 1719492707, + "default_locale": "en", + "description": "", + "id": "39", + "parent_id": 143, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "title": "This is the article title", + "type": "article", + "updated_at": 1719492707, + "url": "http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title", + "workspace_id": "this_is_an_id33_that_should_be_at_least_4", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 25, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles", + "response": { + "docs": "successful", + "type": "root.Articles", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveArticle": { + "auth": true, + "display-name": "Retrieve an article", + "docs": "You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Article found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "author_id": 991267412, + "body": "", + "created_at": 1719492712, + "default_locale": "en", + "description": "", + "id": "45", + "parent_id": 148, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "This is the article title", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492712, + "url": "http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title", + "workspace_id": "this_is_an_id43_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Article found", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchArticles": { + "auth": true, + "display-name": "Search for articles", + "docs": "You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Search successful", + "query-parameters": { + "phrase": "Getting started", + "state": "published", + }, + "response": { + "body": { + "data": { + "articles": [ + { + "author_id": 991267431, + "body": "", + "created_at": 1719492719, + "default_locale": "en", + "description": "", + "id": "55", + "parent_ids": [ + 18, + 19, + ], + "state": "draft", + "title": "Title 1", + "type": "article", + "updated_at": 1719492719, + "workspace_id": "this_is_an_id61_that_should_be_at_least_4", + }, + ], + "highlights": [ + { + "article_id": "123", + }, + ], + }, + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/articles/search", + "request": { + "name": "SearchArticlesRequest", + "query-parameters": { + "help_center_id": { + "docs": "The ID of the Help Center to search in.", + "type": "optional", + }, + "highlight": { + "docs": "Return a highlighted version of the matching content within your articles. Refer to the response schema for more details.", + "type": "optional", + }, + "phrase": { + "docs": "The phrase within your articles to search for.", + "type": "optional", + }, + "state": { + "docs": "The state of the Articles returned. One of `published`, `draft` or `all`.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Search successful", + "type": "ArticleSearchResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateArticle": { + "auth": true, + "display-name": "Update an article", + "docs": "You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "title": "Christmas is here!", + }, + "response": { + "body": { + "author_id": 991267418, + "body": "

New gifts in store for the jolly season

", + "created_at": 1719492714, + "default_locale": "en", + "description": "", + "id": "48", + "parent_id": 151, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Christmas is here!", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Article Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "title": "Christmas is here!", + }, + "response": { + "body": { + "author_id": 991267418, + "body": "

New gifts in store for the jolly season

", + "created_at": 1719492714, + "default_locale": "en", + "description": "", + "id": "48", + "parent_id": 151, + "parent_ids": [ + 18, + 19, + ], + "parent_type": "collection", + "state": "published", + "statistics": { + "conversions": 0, + "happy_reaction_percentage": 0, + "neutral_reaction_percentage": 0, + "reactions": 0, + "sad_reaction_percentage": 0, + "type": "article_statistics", + "views": 0, + }, + "title": "Christmas is here!", + "translated_content": { + "ar": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bg": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "bs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ca": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "cs": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "da": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "de": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "el": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "en": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "es": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "et": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "fr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "he": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "hu": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "id": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "it": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ja": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ko": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "lv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "mn": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nb": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "nl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "pt-BR": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ro": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "ru": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sl": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "sv": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "tr": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "type": "article_translated_content", + "vi": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-CN": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + "zh-TW": { + "author_id": 1, + "body": "This is the body of the article.", + "created_at": 1663597223, + "description": "This article will show you how to create a new article.", + "state": "published", + "title": "How to create a new article", + "type": "article_content", + "updated_at": 1663597260, + "url": "http://intercom.test/help/en/articles/3-default-language", + }, + }, + "type": "article", + "updated_at": 1719492714, + "url": "http://help-center.test/myapp-49/en/articles/48-christmas-is-here", + "workspace_id": "this_is_an_id49_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/articles/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "Article", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Article": { + "docs": "The Articles API is a central place to gather all information and take actions on your articles. Articles can live within collections and sections, or alternatively they can stand alone.", + "extends": [ + "Articles", + ], + "properties": { + "statistics": { + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleListItemState": { + "default": "draft", + "docs": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", + "enum": [ + "published", + "draft", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlights": { + "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "properties": { + "article_id": { + "docs": "The ID of the corresponding article.", + "type": "optional", + }, + "highlighted_summary": { + "docs": "An Article description and body text highlighted.", + "type": "optional>>", + }, + "highlighted_title": { + "docs": "An Article title highlighted.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedSummaryItemItem": { + "docs": "An instance of highlighted summary text.", + "properties": { + "text": { + "docs": "The text of the title.", + "type": "optional", + }, + "type": { + "docs": "The type of text - `highlight` or `plain`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedSummaryItemItemType": { + "docs": "The type of text - `highlight` or `plain`.", + "enum": [ + "highlight", + "plain", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedTitleItem": { + "docs": "A highlighted article title.", + "properties": { + "text": { + "docs": "The text of the title.", + "type": "optional", + }, + "type": { + "docs": "The type of text - `highlight` or `plain`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchHighlightsHighlightedTitleItemType": { + "docs": "The type of text - `highlight` or `plain`.", + "enum": [ + "highlight", + "plain", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchResponse": { + "docs": "The results of an Article search", + "properties": { + "data": { + "docs": "An object containing the results of the search.", + "type": "optional", + }, + "pages": { + "type": "optional", + }, + "total_count": { + "docs": "The total number of Articles matching the search query", + "type": "optional", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ArticleSearchResponseData": { + "docs": "An object containing the results of the search.", + "properties": { + "articles": { + "docs": "An array of Article objects", + "type": "optional>", + }, + "highlights": { + "docs": "A corresponding array of highlighted Article content", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Articles": { + "docs": "The data returned about your articles when you list them.", + "properties": { + "author_id": { + "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", + "type": "optional", + }, + "body": { + "docs": "The body of the article in HTML. For multilingual articles, this will be the body of the default language's content.", + "type": "optional", + }, + "created_at": { + "docs": "The time when the article was created. For multilingual articles, this will be the timestamp of creation of the default language's content in seconds.", + "type": "optional", + }, + "default_locale": { + "docs": "The default locale of the help center. This field is only returned for multilingual help centers.", + "type": "optional", + }, + "description": { + "docs": "The description of the article. For multilingual articles, this will be the description of the default language's content.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the article which is given by Intercom.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the article's parent collection or section. An article without this field stands alone.", + "type": "optional", + }, + "parent_ids": { + "docs": "The ids of the article's parent collections or sections. An article without this field stands alone.", + "type": "optional>", + }, + "parent_type": { + "docs": "The type of parent, which can either be a `collection` or `section`.", + "type": "optional", + }, + "state": { + "default": "draft", + "docs": "Whether the article is `published` or is a `draft`. For multilingual articles, this will be the state of the default language's content.", + "type": "optional", + }, + "title": { + "docs": "The title of the article. For multilingual articles, this will be the title of the default language's content.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + "type": { + "docs": "The type of object - `article`.", + "type": "optional>", + }, + "updated_at": { + "docs": "The time when the article was last updated. For multilingual articles, this will be the timestamp of last update of the default language's content in seconds.", + "type": "optional", + }, + "url": { + "docs": "The URL of the article. For multilingual articles, this will be the URL of the default language's content.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the article belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listArticles: + path: /articles + method: GET + auth: true + docs: > + You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`. + + + > 📘 How are the articles sorted and ordered? + + > + + > Articles will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll + show the most recently updated articles first. + source: + openapi: ../openapi.yml + display-name: List all articles + response: + docs: successful + type: root.Articles + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - type: article + id: '39' + workspace_id: this_is_an_id33_that_should_be_at_least_4 + title: This is the article title + description: '' + body: '' + author_id: 991267402 + state: published + created_at: 1719492707 + updated_at: 1719492707 + url: >- + http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title + parent_id: 143 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + createArticle: + path: /articles + method: POST + auth: true + docs: >- + You can create a new article by making a POST request to + `https://api.intercom.io/articles`. + source: + openapi: ../openapi.yml + display-name: Create an article + request: + body: + type: optional + content-type: application/json + response: + docs: article created + type: Article + errors: + - root.BadRequestError + - root.UnauthorizedError + examples: + - name: article created + request: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991267407 + state: published + parent_id: 145 + parent_type: collection + translated_content: + fr: + title: Merci pour tout + description: Description de l'article + body: Corps de l'article + author_id: 991267407 + state: published + response: + body: + type: article + id: '42' + workspace_id: this_is_an_id37_that_should_be_at_least_4 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: >- + http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + parent_id: 145 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + - name: Bad Request + request: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 1295 + state: published + response: + body: + type: article + id: '42' + workspace_id: this_is_an_id37_that_should_be_at_least_4 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: >- + http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + parent_id: 145 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + retrieveArticle: + path: /articles/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single article by making a GET request to + `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Retrieve an article + response: + docs: Article found + type: Article + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Article found + path-parameters: + id: 1 + response: + body: + type: article + id: '45' + workspace_id: this_is_an_id43_that_should_be_at_least_4 + title: This is the article title + description: '' + body: '' + author_id: 991267412 + state: published + created_at: 1719492712 + updated_at: 1719492712 + url: >- + http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title + parent_id: 148 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + updateArticle: + path: /articles/{id} + method: PUT + auth: true + docs: >- + You can update the details of a single article by making a PUT request + to `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Update an article + request: + body: + type: optional + content-type: application/json + response: + docs: successful + type: Article + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ response: + body: + type: article + id: '48' + workspace_id: this_is_an_id49_that_should_be_at_least_4 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: >- + http://help-center.test/myapp-49/en/articles/48-christmas-is-here + parent_id: 151 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + - name: Article Not Found + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ response: + body: + type: article + id: '48' + workspace_id: this_is_an_id49_that_should_be_at_least_4 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: >- + http://help-center.test/myapp-49/en/articles/48-christmas-is-here + parent_id: 151 + parent_ids: + - 18 + - 19 + parent_type: collection + default_locale: en + translated_content: + type: article_translated_content + ar: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bg: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + bs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ca: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + cs: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + da: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + de: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + el: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + en: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + es: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + et: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + fr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + he: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + hu: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + id: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + it: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ja: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ko: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + lv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + mn: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nb: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + nl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ro: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + ru: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sl: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + sv: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + tr: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + vi: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + pt-BR: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-CN: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + zh-TW: + type: article_content + title: How to create a new article + description: This article will show you how to create a new article. + body: This is the body of the article. + author_id: 1 + state: published + created_at: 1663597223 + updated_at: 1663597260 + url: http://intercom.test/help/en/articles/3-default-language + statistics: + type: article_statistics + views: 0 + conversions: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + deleteArticle: + path: /articles/{id} + method: DELETE + auth: true + docs: >- + You can delete a single article by making a DELETE request to + `https://api.intercom.io/articles/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the article which is given by Intercom. + display-name: Delete an article + response: + docs: successful + type: root.DeletedArticleObject + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '51' + object: article + deleted: true + searchArticles: + path: /articles/search + method: GET + auth: true + docs: >- + You can search for articles by making a GET request to + `https://api.intercom.io/articles/search`. + source: + openapi: ../openapi.yml + display-name: Search for articles + request: + name: SearchArticlesRequest + query-parameters: + phrase: + type: optional + docs: The phrase within your articles to search for. + state: + type: optional + docs: >- + The state of the Articles returned. One of `published`, `draft` or + `all`. + help_center_id: + type: optional + docs: The ID of the Help Center to search in. + highlight: + type: optional + docs: >- + Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + response: + docs: Search successful + type: ArticleSearchResponse + errors: + - root.UnauthorizedError + examples: + - name: Search successful + query-parameters: + phrase: Getting started + state: published + response: + body: + type: list + total_count: 1 + data: + articles: + - type: article + id: '55' + workspace_id: this_is_an_id61_that_should_be_at_least_4 + title: Title 1 + description: '' + body: '' + author_id: 991267431 + state: draft + created_at: 1719492719 + updated_at: 1719492719 + parent_ids: + - 18 + - 19 + default_locale: en + highlights: + - article_id: '123' + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + source: + openapi: ../openapi.yml + display-name: Articles +docs: Everything about your Articles +types: + Article: + docs: >- + The Articles API is a central place to gather all information and take + actions on your articles. Articles can live within collections and + sections, or alternatively they can stand alone. + properties: + statistics: + type: optional + extends: + - Articles + source: + openapi: ../openapi.yml + ArticleListItemState: + enum: + - published + - draft + docs: >- + Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + default: draft + source: + openapi: ../openapi.yml + Articles: + docs: The data returned about your articles when you list them. + properties: + type: + type: optional> + docs: The type of object - `article`. + id: + type: optional + docs: The unique identifier for the article which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the article belongs to. + title: + type: optional + docs: >- + The title of the article. For multilingual articles, this will be the + title of the default language's content. + description: + type: optional + docs: >- + The description of the article. For multilingual articles, this will + be the description of the default language's content. + body: + type: optional + docs: >- + The body of the article in HTML. For multilingual articles, this will + be the body of the default language's content. + author_id: + type: optional + docs: >- + The id of the author of the article. For multilingual articles, this + will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + state: + type: optional + docs: >- + Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + default: draft + created_at: + type: optional + docs: >- + The time when the article was created. For multilingual articles, this + will be the timestamp of creation of the default language's content in + seconds. + updated_at: + type: optional + docs: >- + The time when the article was last updated. For multilingual articles, + this will be the timestamp of last update of the default language's + content in seconds. + url: + type: optional + docs: >- + The URL of the article. For multilingual articles, this will be the + URL of the default language's content. + parent_id: + type: optional + docs: >- + The id of the article's parent collection or section. An article + without this field stands alone. + parent_ids: + type: optional> + docs: >- + The ids of the article's parent collections or sections. An article + without this field stands alone. + parent_type: + type: optional + docs: The type of parent, which can either be a `collection` or `section`. + default_locale: + type: optional + docs: >- + The default locale of the help center. This field is only returned for + multilingual help centers. + translated_content: + type: optional + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedTitleItemType: + enum: + - highlight + - plain + docs: The type of text - `highlight` or `plain`. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedTitleItem: + docs: A highlighted article title. + properties: + type: + type: optional + docs: The type of text - `highlight` or `plain`. + text: + type: optional + docs: The text of the title. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedSummaryItemItemType: + enum: + - highlight + - plain + docs: The type of text - `highlight` or `plain`. + source: + openapi: ../openapi.yml + ArticleSearchHighlightsHighlightedSummaryItemItem: + docs: An instance of highlighted summary text. + properties: + type: + type: optional + docs: The type of text - `highlight` or `plain`. + text: + type: optional + docs: The text of the title. + source: + openapi: ../openapi.yml + ArticleSearchHighlights: + docs: >- + The highlighted results of an Article search. In the examples provided my + search query is always "my query". + properties: + article_id: + type: optional + docs: The ID of the corresponding article. + highlighted_title: + type: optional> + docs: An Article title highlighted. + highlighted_summary: + type: >- + optional>> + docs: An Article description and body text highlighted. + source: + openapi: ../openapi.yml + ArticleSearchResponseData: + docs: An object containing the results of the search. + properties: + articles: + type: optional> + docs: An array of Article objects + highlights: + type: optional> + docs: A corresponding array of highlighted Article content + source: + openapi: ../openapi.yml + ArticleSearchResponse: + docs: The results of an Article search + properties: + type: + type: optional> + docs: The type of the object - `list`. + total_count: + type: optional + docs: The total number of Articles matching the search query + data: + type: optional + docs: An object containing the results of the search. + pages: + type: optional + source: + openapi: ../openapi.yml +", + }, + "companies.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Companies", + "imports": { + "root": "__package__.yml", + "segments": "segments.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Companies", + "endpoints": { + "ListAttachedContacts": { + "auth": true, + "display-name": "List attached contacts", + "docs": "You can fetch a list of all contacts that belong to a company.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 50, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}/contacts", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.CompanyAttachedContacts", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ListAttachedSegmentsForCompanies": { + "auth": true, + "display-name": "List attached segments for companies", + "docs": "You can fetch a list of all segments that belong to a company.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "data": [ + { + "count": 3, + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "person_type": "contact", + "type": "segment", + "updated_at": 1394622004, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}/segments", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.CompanyAttachedSegments", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "RetrieveACompanyById": { + "auth": true, + "display-name": "Retrieve a company by ID", + "docs": "You can fetch a single company.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "app_id": "this_is_an_id128_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492736, + "custom_attributes": { + "key": "value", + }, + "id": "667d60808a68186f43bafd31", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492736, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492736, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateCompany": { + "auth": true, + "display-name": "Update a company", + "docs": "You can update a single company using the Intercom provisioned `id`. + +{% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "app_id": "this_is_an_id134_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492738, + "custom_attributes": { + "key": "value", + }, + "id": "667d60828a68186f43bafd3b", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company2", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492738, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492738, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachContactToACompany": { + "auth": true, + "display-name": "Attach a Contact to a Company", + "docs": "You can attach a company to a single contact.", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "667d608d8a68186f43bafd70", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + { + "name": "Bad Request", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "58a430d35458202d41b1e65b", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + { + "name": "Company Not Found", + "path-parameters": { + "id": "id", + }, + "request": { + "id": "123", + }, + "response": { + "body": { + "app_id": "this_is_an_id166_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492749, + "custom_attributes": { + "key": "value", + }, + "id": "667d608d8a68186f43bafd70", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company6", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492749, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492749, + "user_count": 1, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/companies", + "path-parameters": { + "id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "id": { + "availability": undefined, + "docs": "The unique identifier for the company which is given by Intercom", + "name": "companyId", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachContactToACompanyRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createOrUpdateCompany": { + "auth": true, + "display-name": "Create or Update a company", + "docs": "You can create or update a company. + +Companies will be only visible in Intercom when there is at least one associated user. + +Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + +{% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. +{% /admonition %} +", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "request": { + "company_id": "company_remote_id", + "name": "my company", + "remote_created_at": 1374138000, + }, + "response": { + "body": { + "app_id": "this_is_an_id116_that_should_be_at_least_", + "company_id": "company_remote_id", + "created_at": 1719492732, + "custom_attributes": { + "creation_source": "api", + }, + "id": "667d607c8a68186f43bafd1e", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "my company", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1374138000, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492732, + "user_count": 0, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/companies", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteCompany": { + "auth": true, + "display-name": "Delete a company", + "docs": "You can delete a single company.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632", + }, + "response": { + "body": { + "deleted": true, + "id": "667d60848a68186f43bafd45", + "object": "company", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/companies/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.DeletedCompanyObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachContactFromACompany": { + "auth": true, + "display-name": "Detach a contact from a company", + "docs": "You can detach a company from a single contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "58a430d35458202d41b1e65b", + "id": "58a430d35458202d41b1e65b", + }, + "response": { + "body": { + "app_id": "this_is_an_id174_that_should_be_at_least_", + "company_id": "1", + "created_at": 1719492753, + "custom_attributes": { + "key": "value", + }, + "id": "667d60918a68186f43bafd80", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "company8", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492753, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "tags": [ + { + "key": "value", + }, + ], + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492753, + "user_count": 0, + "website": "https://www.intercom.com", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/companies/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the company which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "Company", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAllCompanies": { + "auth": true, + "display-name": "List all companies", + "docs": "You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + +Note that the API does not include companies who have no associated users in list responses. + +When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "query-parameters": { + "order": "desc", + }, + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id158_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492746, + "custom_attributes": { + "key": "value", + }, + "id": "667d608a8a68186f43bafd61", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492746, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492746, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 15, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/companies/list", + "request": { + "name": "ListAllCompaniesRequest", + "query-parameters": { + "order": { + "docs": "`asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc", + "type": "optional", + }, + "page": { + "docs": "The page of results to fetch. Defaults to first page", + "type": "optional", + }, + "per_page": { + "docs": "How many results to return per page. Defaults to 15", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "root.Companies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveCompany": { + "auth": true, + "display-name": "Retrieve companies", + "docs": "You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + +You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "query-parameters": { + "company_id": "12345", + "name": "my company", + "segment_id": "98765", + "tag_id": "678910", + }, + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id122_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492734, + "custom_attributes": { + "key": "value", + }, + "id": "667d607e8a68186f43bafd26", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492734, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492734, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 15, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies", + "request": { + "name": "RetrieveCompanyRequest", + "query-parameters": { + "company_id": { + "docs": "The `company_id` of the company to filter by.", + "type": "optional", + }, + "name": { + "docs": "The `name` of the company to filter by.", + "type": "optional", + }, + "page": { + "docs": "The page of results to fetch. Defaults to first page", + "type": "optional", + }, + "per_page": { + "docs": "How many results to display per page. Defaults to 15", + "type": "optional", + }, + "segment_id": { + "docs": "The `segment_id` of the company to filter by.", + "type": "optional", + }, + "tag_id": { + "docs": "The `tag_id` of the company to filter by.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "root.Companies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "scrollOverAllCompanies": { + "auth": true, + "display-name": "Scroll over all companies", + "docs": " The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + +- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. +- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail +- If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + +{% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. +{% /admonition %} +{% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "app_id": "this_is_an_id162_that_should_be_at_least_", + "company_id": "remote_companies_scroll_2", + "created_at": 1719492747, + "custom_attributes": { + "key": "value", + }, + "id": "667d608b8a68186f43bafd67", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 0, + "name": "IntercomQATest1", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1719492747, + "segments": { + "segments": [ + { + "created_at": 1394621988, + "id": "56203d253cba154d39010062", + "name": "Active", + "updated_at": 1394622004, + }, + ], + "type": "segment.list", + }, + "session_count": 0, + "size": 100, + "tags": { + "type": "tag.list", + }, + "type": "company", + "updated_at": 1719492747, + "user_count": 4, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 2, + "total_pages": 13, + "type": "pages", + }, + "scroll_param": "12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc", + "total_count": 100, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/companies/scroll", + "request": { + "name": "ScrollOverAllCompaniesRequest", + "query-parameters": { + "scroll_param": { + "docs": "", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Company": { + "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "properties": { + "app_id": { + "docs": "The Intercom defined code of the workspace the company is associated to.", + "type": "optional", + }, + "company_id": { + "docs": "The company id you have defined for the company.", + "type": "optional", + }, + "created_at": { + "docs": "The time the company was added in Intercom.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes you have set on the company.", + "type": "optional>", + }, + "id": { + "docs": "The Intercom defined id representing the company.", + "type": "optional", + }, + "industry": { + "docs": "The industry that the company operates in.", + "type": "optional", + }, + "last_request_at": { + "docs": "The time the company last recorded making a request.", + "type": "optional", + }, + "monthly_spend": { + "docs": "How much revenue the company generates for your business.", + "type": "optional", + }, + "name": { + "docs": "The name of the company.", + "type": "optional", + }, + "plan": { + "type": "optional", + }, + "remote_created_at": { + "docs": "The time the company was created by you.", + "type": "optional", + }, + "segments": { + "docs": "The list of segments associated with the company", + "type": "optional", + }, + "session_count": { + "docs": "How many sessions the company has recorded.", + "type": "optional", + }, + "size": { + "docs": "The number of employees in the company.", + "type": "optional", + }, + "tags": { + "docs": "The list of tags associated with the company", + "type": "optional", + }, + "type": { + "docs": "Value is `company`", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the company was updated.", + "type": "optional", + }, + "user_count": { + "docs": "The number of users in the company.", + "type": "optional", + }, + "website": { + "docs": "The URL for the company website.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyPlan": { + "docs": undefined, + "properties": { + "id": { + "docs": "The id of the plan", + "type": "optional", + }, + "name": { + "docs": "The name of the plan", + "type": "optional", + }, + "type": { + "docs": "Value is always "plan"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanySegments": { + "docs": "The list of segments associated with the company", + "properties": { + "segments": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CompanyTags": { + "docs": "The list of tags associated with the company", + "properties": { + "tags": "optional>", + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + segments: segments.yml +service: + auth: false + base-path: '' + endpoints: + retrieveCompany: + path: /companies + method: GET + auth: true + docs: > + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a + query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` + source: + openapi: ../openapi.yml + display-name: Retrieve companies + request: + name: RetrieveCompanyRequest + query-parameters: + name: + type: optional + docs: The `name` of the company to filter by. + company_id: + type: optional + docs: The `company_id` of the company to filter by. + tag_id: + type: optional + docs: The `tag_id` of the company to filter by. + segment_id: + type: optional + docs: The `segment_id` of the company to filter by. + page: + type: optional + docs: The page of results to fetch. Defaults to first page + per_page: + type: optional + docs: How many results to display per page. Defaults to 15 + response: + docs: Successful + type: root.Companies + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + query-parameters: + name: my company + company_id: '12345' + tag_id: '678910' + segment_id: '98765' + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 15 + total_pages: 1 + total_count: 1 + data: + - type: company + id: 667d607e8a68186f43bafd26 + name: IntercomQATest1 + app_id: this_is_an_id122_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492734 + created_at: 1719492734 + updated_at: 1719492734 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + createOrUpdateCompany: + path: /companies + method: POST + auth: true + docs: > + You can create or update a company. + + + Companies will be only visible in Intercom when there is at least one + associated user. + + + Companies are looked up via `company_id` in a `POST` request, if not + found via `company_id`, the new company will be created, if found, that + company will be updated. + + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: Create or Update a company + request: + body: + type: optional + content-type: application/json + response: + docs: Successful + type: Company + errors: + - root.BadRequestError + - root.UnauthorizedError + examples: + - name: Successful + request: + name: my company + company_id: company_remote_id + remote_created_at: 1374138000 + response: + body: + type: company + id: 667d607c8a68186f43bafd1e + name: my company + app_id: this_is_an_id116_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: company_remote_id + remote_created_at: 1374138000 + created_at: 1719492732 + updated_at: 1719492732 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 0 + custom_attributes: + creation_source: api + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + RetrieveACompanyById: + path: /companies/{id} + method: GET + auth: true + docs: You can fetch a single company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Retrieve a company by ID + response: + docs: Successful + type: Company + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: company + id: 667d60808a68186f43bafd31 + name: company1 + app_id: this_is_an_id128_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492736 + created_at: 1719492736 + updated_at: 1719492736 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + UpdateCompany: + path: /companies/{id} + method: PUT + auth: true + docs: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Update a company + response: + docs: Successful + type: Company + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: company + id: 667d60828a68186f43bafd3b + name: company2 + app_id: this_is_an_id134_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492738 + created_at: 1719492738 + updated_at: 1719492738 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + deleteCompany: + path: /companies/{id} + method: DELETE + auth: true + docs: You can delete a single company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Delete a company + response: + docs: Successful + type: root.DeletedCompanyObject + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + id: 667d60848a68186f43bafd45 + object: company + deleted: true + ListAttachedContacts: + path: /companies/{id}/contacts + method: GET + auth: true + docs: You can fetch a list of all contacts that belong to a company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: List attached contacts + response: + docs: Successful + type: root.CompanyAttachedContacts + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 50 + total_pages: 0 + ListAttachedSegmentsForCompanies: + path: /companies/{id}/segments + method: GET + auth: true + docs: You can fetch a list of all segments that belong to a company. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: List attached segments for companies + response: + docs: Successful + type: root.CompanyAttachedSegments + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + response: + body: + type: list + data: + - type: segment + id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + person_type: contact + count: 3 + listAllCompanies: + path: /companies/list + method: POST + auth: true + docs: > + You can list companies. The company list is sorted by the + `last_request_at` field and by default is ordered descending, most + recently requested first. + + + Note that the API does not include companies who have no associated + users in list responses. + + + When using the Companies endpoint and the pages object to iterate + through the returned companies, there is a limit of 10,000 Companies + that can be returned. If you need to list or iterate on more than 10,000 + Companies, please use the [Scroll + API](https://developers.intercom.com/reference#iterating-over-all-companies). + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all companies + request: + name: ListAllCompaniesRequest + query-parameters: + page: + type: optional + docs: The page of results to fetch. Defaults to first page + per_page: + type: optional + docs: How many results to return per page. Defaults to 15 + order: + type: optional + docs: >- + `asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc + response: + docs: Successful + type: root.Companies + errors: + - root.UnauthorizedError + examples: + - name: Successful + query-parameters: + order: desc + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 15 + total_pages: 1 + total_count: 1 + data: + - type: company + id: 667d608a8a68186f43bafd61 + name: IntercomQATest1 + app_id: this_is_an_id158_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492746 + created_at: 1719492746 + updated_at: 1719492746 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + scrollOverAllCompanies: + path: /companies/scroll + method: GET + auth: true + docs: >2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error + message if you try to have more than one open per app. + + - If the scroll isn't used for 1 minute, it expires and calls with that + scroll param will fail + + - If the end of the scroll is reached, "companies" will be empty and the + scroll parameter will expire + + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: Scroll over all companies + request: + name: ScrollOverAllCompaniesRequest + query-parameters: + scroll_param: + type: optional + docs: '' + response: + docs: Successful + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Successful + response: + body: + type: list + data: + - type: company + id: 667d608b8a68186f43bafd67 + name: IntercomQATest1 + app_id: this_is_an_id162_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: remote_companies_scroll_2 + remote_created_at: 1719492747 + created_at: 1719492747 + updated_at: 1719492747 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 4 + custom_attributes: + key: value + tags: + type: tag.list + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 2 + total_pages: 13 + total_count: 100 + scroll_param: 12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc + attachContactToACompany: + path: /contacts/{id}/companies + method: POST + auth: true + docs: You can attach a company to a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Attach a Contact to a Company + request: + name: AttachContactToACompanyRequest + body: + properties: + id: + type: string + docs: The unique identifier for the company which is given by Intercom + name: companyId + content-type: application/json + response: + docs: Successful + type: Company + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + id: id + request: + id: 667d608d8a68186f43bafd70 + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + - name: Bad Request + path-parameters: + id: id + request: + id: 58a430d35458202d41b1e65b + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + - name: Company Not Found + path-parameters: + id: id + request: + id: '123' + response: + body: + type: company + id: 667d608d8a68186f43bafd70 + name: company6 + app_id: this_is_an_id166_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 1 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + detachContactFromACompany: + path: /contacts/{contact_id}/companies/{id} + method: DELETE + auth: true + docs: You can detach a company from a single contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: The unique identifier for the company which is given by Intercom + display-name: Detach a contact from a company + response: + docs: Successful + type: Company + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 58a430d35458202d41b1e65b + id: 58a430d35458202d41b1e65b + response: + body: + type: company + id: 667d60918a68186f43bafd80 + name: company8 + app_id: this_is_an_id174_that_should_be_at_least_ + plan: + type: plan + id: '269315' + name: Pro + company_id: '1' + remote_created_at: 1719492753 + created_at: 1719492753 + updated_at: 1719492753 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 0 + session_count: 0 + user_count: 0 + custom_attributes: + key: value + tags: + type: tag.list + tags: + - key: value + segments: + type: segment.list + segments: + - id: 56203d253cba154d39010062 + name: Active + created_at: 1394621988 + updated_at: 1394622004 + source: + openapi: ../openapi.yml + display-name: Companies +docs: Everything about your Companies +types: + CompanyPlan: + properties: + type: + type: optional + docs: Value is always "plan" + id: + type: optional + docs: The id of the plan + name: + type: optional + docs: The name of the plan + source: + openapi: ../openapi.yml + CompanyTags: + docs: The list of tags associated with the company + properties: + type: + type: optional> + docs: The type of the object + tags: optional> + source: + openapi: ../openapi.yml + CompanySegments: + docs: The list of segments associated with the company + properties: + type: + type: optional> + docs: The type of the object + segments: optional> + source: + openapi: ../openapi.yml + Company: + docs: >- + Companies allow you to represent organizations using your product. Each + company will have its own description and be associated with contacts. You + can fetch, create, update and list companies. + properties: + type: + type: optional> + docs: Value is `company` + id: + type: optional + docs: The Intercom defined id representing the company. + name: + type: optional + docs: The name of the company. + app_id: + type: optional + docs: >- + The Intercom defined code of the workspace the company is associated + to. + plan: + type: optional + company_id: + type: optional + docs: The company id you have defined for the company. + remote_created_at: + type: optional + docs: The time the company was created by you. + created_at: + type: optional + docs: The time the company was added in Intercom. + updated_at: + type: optional + docs: The last time the company was updated. + last_request_at: + type: optional + docs: The time the company last recorded making a request. + size: + type: optional + docs: The number of employees in the company. + website: + type: optional + docs: The URL for the company website. + industry: + type: optional + docs: The industry that the company operates in. + monthly_spend: + type: optional + docs: How much revenue the company generates for your business. + session_count: + type: optional + docs: How many sessions the company has recorded. + user_count: + type: optional + docs: The number of users in the company. + custom_attributes: + type: optional> + docs: The custom attributes you have set on the company. + tags: + type: optional + docs: The list of tags associated with the company + segments: + type: optional + docs: The list of segments associated with the company + source: + openapi: ../openapi.yml +", + }, + "contacts.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your contacts", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Contacts", + "endpoints": { + "ArchiveContact": { + "auth": true, + "display-name": "Archive contact", + "docs": "You can archive a single contact.", + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "archived": true, + "external_id": "70", + "id": "667d60b18a68186f43bafdc0", + "type": "contact", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/archive", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactArchived", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateContact": { + "auth": true, + "display-name": "Create contact", + "docs": "You can create a new contact (ie. user or lead).", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "email": "joebloggs@intercom.io", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/companies", + }, + "created_at": 1719492784, + "custom_attributes": { + "key": "value", + }, + "email": "joebloggs@intercom.io", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60b08a68186f43bafdbf", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "John Doe", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60b08a68186f43bafdbf/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492784, + "workspace_id": "this_is_an_id272_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts", + "request": { + "body": "root.CreateContactRequestTwo", + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DeleteContact": { + "auth": true, + "display-name": "Delete a contact", + "docs": "You can delete a single contact.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "deleted": true, + "external_id": "70", + "id": "667d60aa8a68186f43bafdba", + "type": "contact", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactDeleted", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ListContacts": { + "auth": true, + "display-name": "List all contacts", + "docs": "You can fetch a list of all contacts (ie. users or leads) in your workspace. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts", + "response": { + "docs": "successful", + "type": "root.ContactList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MergeContact": { + "auth": true, + "display-name": "Merge a lead and a user", + "docs": "You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "from": "667d60ac8a68186f43bafdbb", + "into": "667d60ac8a68186f43bafdbc", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/companies", + }, + "created_at": 1719492780, + "custom_attributes": { + "key": "value", + }, + "email": "joe@bloggs.com", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60ac8a68186f43bafdbc", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "Joe Bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492780, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60ac8a68186f43bafdbc/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492780, + "workspace_id": "this_is_an_id260_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/merge", + "request": { + "body": { + "properties": { + "from": { + "docs": "The unique identifier for the contact to merge away from. Must be a lead.", + "type": "optional", + }, + "into": { + "docs": "The unique identifier for the contact to merge into. Must be a user.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "MergeContactsRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SearchContacts": { + "auth": true, + "display-name": "Search contacts", + "docs": "You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + +To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + +This will accept a query object in the body which will define your filters in order to search for contacts. + +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} +### Contact Creation Delay + +If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +* There's a limit of max 2 nested filters +* There's a limit of max 15 filters for each AND or OR group + +### Searching for Timestamp Fields + +All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. +For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. +If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). +This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + +### Accepted Fields + +Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| ---------------------------------- | ------------------------------ | +| id | String | +| role | String
Accepts user or lead | +| name | String | +| avatar | String | +| owner_id | Integer | +| email | String | +| email_domain | String | +| phone | String | +| formatted_phone | String | +| external_id | String | +| created_at | Date (UNIX Timestamp) | +| signed_up_at | Date (UNIX Timestamp) | +| updated_at | Date (UNIX Timestamp) | +| last_seen_at | Date (UNIX Timestamp) | +| last_contacted_at | Date (UNIX Timestamp) | +| last_replied_at | Date (UNIX Timestamp) | +| last_email_opened_at | Date (UNIX Timestamp) | +| last_email_clicked_at | Date (UNIX Timestamp) | +| language_override | String | +| browser | String | +| browser_language | String | +| os | String | +| location.country | String | +| location.region | String | +| location.city | String | +| unsubscribed_from_emails | Boolean | +| marked_email_as_spam | Boolean | +| has_hard_bounced | Boolean | +| ios_last_seen_at | Date (UNIX Timestamp) | +| ios_app_version | String | +| ios_device | String | +| ios_app_device | String | +| ios_os_version | String | +| ios_app_name | String | +| ios_sdk_version | String | +| android_last_seen_at | Date (UNIX Timestamp) | +| android_app_version | String | +| android_device | String | +| android_app_name | String | +| andoid_sdk_version | String | +| segment_id | String | +| tag_id | String | +| custom_attributes.{attribute_name} | String | + +### Accepted Operators + +{% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :------------------------------- | :--------------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In
Shortcut for `OR` queries
Values must be in Array | +| NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | +| > | Integer
Date (UNIX Timestamp) | Greater than | +| < | Integer
Date (UNIX Timestamp) | Lower than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "data": [ + { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/companies", + }, + "created_at": 1571672154, + "custom_attributes": { + "key": "value", + }, + "email": "joe@example.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": true, + "id": "5ba682d23d7cf92bef87bfd4", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "marked_email_as_spam": true, + "name": "John Doe", + "notes": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1571672154, + "tags": { + "has_more": true, + "total_count": 100, + "url": "/contacts/5ba682d23d7cf92bef87bfd4/tags", + }, + "type": "contact", + "unsubscribed_from_emails": true, + "updated_at": 1571672154, + "workspace_id": "ecahpwf5", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.ContactList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ShowContact": { + "auth": true, + "display-name": "Get a contact", + "docs": "You can fetch the details of a single contact.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/companies", + }, + "created_at": 1719492777, + "custom_attributes": { + "key": "value", + }, + "email": "joe@bloggs.com", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60a98a68186f43bafdb9", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "Joe Bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492777, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a98a68186f43bafdb9/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492777, + "workspace_id": "this_is_an_id252_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UnarchiveContact": { + "auth": true, + "display-name": "Unarchive contact", + "docs": "You can unarchive a single contact.", + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "archived": false, + "external_id": "70", + "id": "667d60b28a68186f43bafdc1", + "type": "contact", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/unarchive", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactUnarchived", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateContact": { + "auth": true, + "display-name": "Update a contact", + "docs": "You can update an existing contact (ie. user or lead).", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "request": { + "email": "joebloggs@intercom.io", + "name": "joe bloggs", + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/companies", + }, + "created_at": 1719492776, + "custom_attributes": { + "key": "value", + }, + "email": "joebloggs@intercom.io", + "email_domain": "example.com", + "external_id": "70", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d60a88a68186f43bafdb8", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "joe bloggs", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719492776, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d60a88a68186f43bafdb8/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719492776, + "workspace_id": "this_is_an_id248_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/contacts/{id}", + "path-parameters": { + "id": { + "docs": "id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "avatar": { + "docs": "An image URL containing the avatar of a contact", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes which are set for the contact", + "type": "optional>", + }, + "email": { + "docs": "The contacts email", + "type": "optional", + }, + "external_id": { + "docs": "A unique identifier for the contact which is given to Intercom", + "type": "optional", + }, + "last_seen_at": { + "docs": "The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually)", + "type": "optional", + }, + "name": { + "docs": "The contacts name", + "type": "optional", + }, + "owner_id": { + "docs": "The id of an admin that has been assigned account ownership of the contact", + "type": "optional", + }, + "phone": { + "docs": "The contacts phone", + "type": "optional", + }, + "role": { + "docs": "The role of the contact.", + "type": "optional", + }, + "signed_up_at": { + "docs": "The time specified for when a contact signed up", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the contact is unsubscribed from emails", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listCompaniesForAContact": { + "auth": true, + "display-name": "List attached companies for contact", + "docs": "You can fetch a list of companies that are associated to a contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "plan": { + "id": "269315", + "name": "Pro", + "type": "plan", + }, + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "type": "company", + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "pages": { + "next": "next", + "page": 1, + "per_page": 50, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}/companies", + "path-parameters": { + "id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.ContactAttachedCompanies", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSegmentsForAContact": { + "auth": true, + "display-name": "List attached segments for contact", + "docs": "You can fetch a list of segments that are associated to a contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "count": 3, + "created_at": 1719492761, + "id": "667d60998a68186f43bafda1", + "name": "segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492761, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/segments", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.Segments", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSubscriptionsForAContact": { + "auth": true, + "display-name": "List subscriptions for a contact", + "docs": "You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. +This will return a list of Subscription Type objects that the contact is associated with. + +The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "consent_type": "opt_out", + "content_types": [ + "email", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "93", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "95", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "root.SubscriptionTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTagsForAContact": { + "auth": true, + "display-name": "List tags attached to a contact", + "docs": "You can fetch a list of all tags that are attached to a specific contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "response": { + "body": { + "data": [ + { + "applied_at": 1663597223, + "applied_by": { + "type": "contact", + }, + "id": "93", + "name": "Manual tag", + "type": "tag", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.Tags", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Contact": { + "docs": "Contact are the objects that represent your leads and users in Intercom.", + "properties": { + "android_app_name": { + "docs": "The name of the Android app which the contact is using.", + "type": "optional", + }, + "android_app_version": { + "docs": "The version of the Android app which the contact is using.", + "type": "optional", + }, + "android_device": { + "docs": "The Android device which the contact is using.", + "type": "optional", + }, + "android_last_seen_at": { + "docs": "(UNIX timestamp) The time when the contact was last seen on an Android device.", + "type": "optional", + }, + "android_os_version": { + "docs": "The version of the Android OS which the contact is using.", + "type": "optional", + }, + "android_sdk_version": { + "docs": "The version of the Android SDK which the contact is using.", + "type": "optional", + }, + "avatar": { + "type": "optional", + }, + "browser": { + "docs": "The name of the browser which the contact is using.", + "type": "optional", + }, + "browser_language": { + "docs": "The language set by the browser which the contact is using.", + "type": "optional", + }, + "browser_version": { + "docs": "The version of the browser which the contact is using.", + "type": "optional", + }, + "companies": { + "type": "optional", + }, + "created_at": { + "docs": "(UNIX timestamp) The time when the contact was created.", + "type": "optional", + }, + "custom_attributes": { + "docs": "The custom attributes which are set for the contact.", + "type": "optional>", + }, + "email": { + "docs": "The contact's email.", + "type": "optional", + }, + "email_domain": { + "docs": "The contact's email domain.", + "type": "optional", + }, + "external_id": { + "docs": "The unique identifier for the contact which is provided by the Client.", + "type": "optional", + }, + "formatted_phone": { + "docs": "The contacts phone number normalized to the E164 format", + "type": "optional", + }, + "has_hard_bounced": { + "docs": "Whether the contact has had an email sent to them hard bounce.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the contact which is given by Intercom.", + "type": "optional", + }, + "ios_app_name": { + "docs": "The name of the iOS app which the contact is using.", + "type": "optional", + }, + "ios_app_version": { + "docs": "The version of the iOS app which the contact is using.", + "type": "optional", + }, + "ios_device": { + "docs": "The iOS device which the contact is using.", + "type": "optional", + }, + "ios_last_seen_at": { + "docs": "(UNIX timestamp) The last time the contact used the iOS app.", + "type": "optional", + }, + "ios_os_version": { + "docs": "The version of iOS which the contact is using.", + "type": "optional", + }, + "ios_sdk_version": { + "docs": "The version of the iOS SDK which the contact is using.", + "type": "optional", + }, + "language_override": { + "docs": "A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.", + "type": "optional", + }, + "last_contacted_at": { + "docs": "(UNIX timestamp) The time when the contact was last messaged.", + "type": "optional", + }, + "last_email_clicked_at": { + "docs": "(UNIX timestamp) The time when the contact last clicked a link in an email.", + "type": "optional", + }, + "last_email_opened_at": { + "docs": "(UNIX timestamp) The time when the contact last opened an email.", + "type": "optional", + }, + "last_replied_at": { + "docs": "(UNIX timestamp) The time when the contact last messaged in.", + "type": "optional", + }, + "last_seen_at": { + "docs": "(UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).", + "type": "optional", + }, + "location": { + "type": "optional", + }, + "marked_email_as_spam": { + "docs": "Whether the contact has marked an email sent to them as spam.", + "type": "optional", + }, + "name": { + "docs": "The contacts name.", + "type": "optional", + }, + "notes": { + "type": "optional", + }, + "os": { + "docs": "The operating system which the contact is using.", + "type": "optional", + }, + "owner_id": { + "docs": "The id of an admin that has been assigned account ownership of the contact.", + "type": "optional", + }, + "phone": { + "docs": "The contacts phone.", + "type": "optional", + }, + "role": { + "docs": "The role of the contact.", + "type": "optional", + }, + "signed_up_at": { + "docs": "(UNIX timestamp) The time specified for when a contact signed up.", + "type": "optional", + }, + "social_profiles": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "type": { + "docs": "The type of object.", + "type": "optional", + }, + "unsubscribed_from_emails": { + "docs": "Whether the contact is unsubscribed from emails.", + "type": "optional", + }, + "updated_at": { + "docs": "(UNIX timestamp) The time when the contact was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the contact belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ContactAvatar": { + "docs": undefined, + "properties": { + "image_url": { + "docs": "An image URL containing the avatar of a contact.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "type": { + "docs": "The type of object", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listCompaniesForAContact: + path: /contacts/{id}/companies + method: GET + auth: true + docs: You can fetch a list of companies that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List attached companies for contact + response: + docs: successful + type: root.ContactAttachedCompanies + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: list + companies: + - type: company + id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + plan: + type: plan + id: '269315' + name: Pro + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + total_count: 1 + pages: + type: pages + page: 1 + next: next + per_page: 50 + total_pages: 1 + listSegmentsForAContact: + path: /contacts/{contact_id}/segments + method: GET + auth: true + docs: You can fetch a list of segments that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List attached segments for contact + response: + docs: successful + type: root.Segments + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: segment + id: 667d60998a68186f43bafda1 + name: segment + created_at: 1719492761 + updated_at: 1719492761 + person_type: user + count: 3 + listSubscriptionsForAContact: + path: /contacts/{contact_id}/subscriptions + method: GET + auth: true + docs: > + You can fetch a list of subscription types that are attached to a + contact. These can be subscriptions that a user has 'opted-in' to or has + 'opted-out' from, depending on the subscription type. + + This will return a list of Subscription Type objects that the contact is + associated with. + + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List subscriptions for a contact + response: + docs: Successful + type: root.SubscriptionTypeList + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: subscription + id: '93' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_out + content_types: + - email + - type: subscription + id: '95' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + listTagsForAContact: + path: /contacts/{contact_id}/tags + method: GET + auth: true + docs: >- + You can fetch a list of all tags that are attached to a specific + contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: List tags attached to a contact + response: + docs: successful + type: root.Tags + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + response: + body: + type: list + data: + - type: tag + id: '93' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + ShowContact: + path: /contacts/{id} + method: GET + auth: true + docs: You can fetch the details of a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Get a contact + response: + docs: successful + type: Contact + errors: + - root.UnauthorizedError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60a98a68186f43bafdb9 + external_id: '70' + workspace_id: this_is_an_id252_that_should_be_at_least_ + role: user + email: joe@bloggs.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: Joe Bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492777 + updated_at: 1719492777 + signed_up_at: 1719492777 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a98a68186f43bafdb9/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a98a68186f43bafdb9/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60a98a68186f43bafdb9/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + UpdateContact: + path: /contacts/{id} + method: PUT + auth: true + docs: You can update an existing contact (ie. user or lead). + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Update a contact + request: + name: UpdateContactRequest + body: + properties: + role: + type: optional + docs: The role of the contact. + external_id: + type: optional + docs: A unique identifier for the contact which is given to Intercom + email: + type: optional + docs: The contacts email + phone: + type: optional + docs: The contacts phone + name: + type: optional + docs: The contacts name + avatar: + type: optional + docs: An image URL containing the avatar of a contact + signed_up_at: + type: optional + docs: The time specified for when a contact signed up + last_seen_at: + type: optional + docs: >- + The time when the contact was last seen (either where the + Intercom Messenger was installed or when specified manually) + owner_id: + type: optional + docs: >- + The id of an admin that has been assigned account ownership of + the contact + unsubscribed_from_emails: + type: optional + docs: Whether the contact is unsubscribed from emails + custom_attributes: + type: optional> + docs: The custom attributes which are set for the contact + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.UnauthorizedError + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + request: + email: joebloggs@intercom.io + name: joe bloggs + response: + body: + type: contact + id: 667d60a88a68186f43bafdb8 + external_id: '70' + workspace_id: this_is_an_id248_that_should_be_at_least_ + role: user + email: joebloggs@intercom.io + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: joe bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492776 + updated_at: 1719492776 + signed_up_at: 1719492776 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a88a68186f43bafdb8/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60a88a68186f43bafdb8/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60a88a68186f43bafdb8/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + DeleteContact: + path: /contacts/{id} + method: DELETE + auth: true + docs: You can delete a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Delete a contact + response: + docs: successful + type: root.ContactDeleted + errors: + - root.UnauthorizedError + examples: + - name: successful + path-parameters: + id: id + response: + body: + type: contact + id: 667d60aa8a68186f43bafdba + external_id: '70' + deleted: true + MergeContact: + path: /contacts/merge + method: POST + auth: true + docs: >- + You can merge a contact with a `role` of `lead` into a contact with a + `role` of `user`. + source: + openapi: ../openapi.yml + display-name: Merge a lead and a user + request: + name: MergeContactsRequest + body: + properties: + from: + type: optional + docs: >- + The unique identifier for the contact to merge away from. Must + be a lead. + into: + type: optional + docs: >- + The unique identifier for the contact to merge into. Must be a + user. + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.UnauthorizedError + examples: + - name: successful + request: + from: 667d60ac8a68186f43bafdbb + into: 667d60ac8a68186f43bafdbc + response: + body: + type: contact + id: 667d60ac8a68186f43bafdbc + external_id: '70' + workspace_id: this_is_an_id260_that_should_be_at_least_ + role: user + email: joe@bloggs.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: Joe Bloggs + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492780 + updated_at: 1719492780 + signed_up_at: 1719492780 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60ac8a68186f43bafdbc/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60ac8a68186f43bafdbc/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60ac8a68186f43bafdbc/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + SearchContacts: + path: /contacts/search + method: POST + auth: true + docs: > + You can search for multiple contacts by the value of their attributes in + order to fetch exactly who you want. + + + To search for contacts, you need to send a `POST` request to + `https://api.intercom.io/contacts/search`. + + + This will accept a query object in the body which will define your + filters in order to search for contacts. + + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Contact Creation Delay + + + If a contact has recently been created, there is a possibility that it + will not yet be available when searching. This means that it may not + appear in the response. This delay can take a few minutes. If you need + to be instantly notified it is recommended to use webhooks and iterate + to see if they match your search filters. + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiple's there can be: + + * There's a limit of max 2 nested filters + + * There's a limit of max 15 filters for each AND or OR group + + + ### Searching for Timestamp Fields + + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates + for Contact Search queries; Datetime queries are not currently + supported. This means you can only query for timestamp fields by day - + not hour, minute or second. + + For example, if you search for all Contacts with a created_at value + greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 + 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 + 12:00 AM). The search results will then include Contacts created from + January 2nd, 2020 12:00 AM onwards. + + If you'd like to get contacts created on January 1st, 2020 you should + search with a created_at value equal (=) to 1577836800 (January 1st, + 2020 12:00 AM). + + This behaviour applies only to timestamps used in search queries. The + search results will still contain the full UNIX timestamp and be sorted + accordingly. + + + ### Accepted Fields + + + Most key listed as part of the Contacts Model are searchable, whether + writeable or not. The value you search for has to match the accepted + type, otherwise the query will fail (ie. as `created_at` accepts a date, + the `value` cannot be a string such as `"foorbar"`). + + + | Field | Type | + + | ---------------------------------- | ------------------------------ | + + | id | String | + + | role | String
Accepts user or lead | + + | name | String | + + | avatar | String | + + | owner_id | Integer | + + | email | String | + + | email_domain | String | + + | phone | String | + + | formatted_phone | String | + + | external_id | String | + + | created_at | Date (UNIX Timestamp) | + + | signed_up_at | Date (UNIX Timestamp) | + + | updated_at | Date (UNIX Timestamp) | + + | last_seen_at | Date (UNIX Timestamp) | + + | last_contacted_at | Date (UNIX Timestamp) | + + | last_replied_at | Date (UNIX Timestamp) | + + | last_email_opened_at | Date (UNIX Timestamp) | + + | last_email_clicked_at | Date (UNIX Timestamp) | + + | language_override | String | + + | browser | String | + + | browser_language | String | + + | os | String | + + | location.country | String | + + | location.region | String | + + | location.city | String | + + | unsubscribed_from_emails | Boolean | + + | marked_email_as_spam | Boolean | + + | has_hard_bounced | Boolean | + + | ios_last_seen_at | Date (UNIX Timestamp) | + + | ios_app_version | String | + + | ios_device | String | + + | ios_app_device | String | + + | ios_os_version | String | + + | ios_app_name | String | + + | ios_sdk_version | String | + + | android_last_seen_at | Date (UNIX Timestamp) | + + | android_app_version | String | + + | android_device | String | + + | android_app_name | String | + + | andoid_sdk_version | String | + + | segment_id | String | + + | tag_id | String | + + | custom_attributes.{attribute_name} | String | + + + ### Accepted Operators + + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :------------------------------- | + :--------------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In
Shortcut for `OR` + queries
Values must be in Array | + + | NIN | All | Not In
Shortcut for + `OR !` queries
Values must be in Array | + + | > | Integer
Date (UNIX Timestamp) | Greater + than | + + | < | Integer
Date (UNIX Timestamp) | Lower + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search contacts + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.ContactList + errors: + - root.UnauthorizedError + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 0 + ListContacts: + path: /contacts + method: GET + auth: true + docs: > + You can fetch a list of all contacts (ie. users or leads) in your + workspace. + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all contacts + response: + docs: successful + type: root.ContactList + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + data: + - type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: ecahpwf5 + role: user + email: joe@example.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: true + marked_email_as_spam: true + unsubscribed_from_emails: true + created_at: 1571672154 + updated_at: 1571672154 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + tags: + url: /contacts/5ba682d23d7cf92bef87bfd4/tags + total_count: 100 + has_more: true + notes: + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + total_count: 100 + has_more: true + companies: + url: /contacts/5ba682d23d7cf92bef87bfd4/companies + total_count: 100 + has_more: true + total_count: 0 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 0 + CreateContact: + path: /contacts + method: POST + auth: true + docs: You can create a new contact (ie. user or lead). + source: + openapi: ../openapi.yml + display-name: Create contact + request: + body: root.CreateContactRequestTwo + content-type: application/json + response: + docs: successful + type: Contact + errors: + - root.UnauthorizedError + examples: + - name: successful + request: + email: joebloggs@intercom.io + response: + body: + type: contact + id: 667d60b08a68186f43bafdbf + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: this_is_an_id272_that_should_be_at_least_ + role: user + email: joebloggs@intercom.io + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492784 + updated_at: 1719492784 + signed_up_at: 1571672154 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60b08a68186f43bafdbf/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d60b08a68186f43bafdbf/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d60b08a68186f43bafdbf/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + ArchiveContact: + path: /contacts/{id}/archive + method: POST + auth: true + docs: You can archive a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Archive contact + response: + docs: successful + type: root.ContactArchived + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60b18a68186f43bafdc0 + external_id: '70' + archived: true + UnarchiveContact: + path: /contacts/{id}/unarchive + method: POST + auth: true + docs: You can unarchive a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: id + display-name: Unarchive contact + response: + docs: successful + type: root.ContactUnarchived + examples: + - name: successful + path-parameters: + id: 63a07ddf05a32042dffac965 + response: + body: + type: contact + id: 667d60b28a68186f43bafdc1 + external_id: '70' + archived: false + source: + openapi: ../openapi.yml + display-name: Contacts +docs: Everything about your contacts +types: + ContactAvatar: + properties: + type: + type: optional + docs: The type of object + image_url: + type: optional + docs: An image URL containing the avatar of a contact. + validation: + format: uri + source: + openapi: ../openapi.yml + Contact: + docs: Contact are the objects that represent your leads and users in Intercom. + properties: + type: + type: optional + docs: The type of object. + id: + type: optional + docs: The unique identifier for the contact which is given by Intercom. + external_id: + type: optional + docs: The unique identifier for the contact which is provided by the Client. + workspace_id: + type: optional + docs: The id of the workspace which the contact belongs to. + role: + type: optional + docs: The role of the contact. + email: + type: optional + docs: The contact's email. + email_domain: + type: optional + docs: The contact's email domain. + phone: + type: optional + docs: The contacts phone. + formatted_phone: + type: optional + docs: The contacts phone number normalized to the E164 format + name: + type: optional + docs: The contacts name. + owner_id: + type: optional + docs: >- + The id of an admin that has been assigned account ownership of the + contact. + has_hard_bounced: + type: optional + docs: Whether the contact has had an email sent to them hard bounce. + marked_email_as_spam: + type: optional + docs: Whether the contact has marked an email sent to them as spam. + unsubscribed_from_emails: + type: optional + docs: Whether the contact is unsubscribed from emails. + created_at: + type: optional + docs: (UNIX timestamp) The time when the contact was created. + updated_at: + type: optional + docs: (UNIX timestamp) The time when the contact was last updated. + signed_up_at: + type: optional + docs: (UNIX timestamp) The time specified for when a contact signed up. + last_seen_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact was last seen (either where + the Intercom Messenger was installed or when specified manually). + last_replied_at: + type: optional + docs: (UNIX timestamp) The time when the contact last messaged in. + last_contacted_at: + type: optional + docs: (UNIX timestamp) The time when the contact was last messaged. + last_email_opened_at: + type: optional + docs: (UNIX timestamp) The time when the contact last opened an email. + last_email_clicked_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact last clicked a link in an + email. + language_override: + type: optional + docs: >- + A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + browser: + type: optional + docs: The name of the browser which the contact is using. + browser_version: + type: optional + docs: The version of the browser which the contact is using. + browser_language: + type: optional + docs: The language set by the browser which the contact is using. + os: + type: optional + docs: The operating system which the contact is using. + android_app_name: + type: optional + docs: The name of the Android app which the contact is using. + android_app_version: + type: optional + docs: The version of the Android app which the contact is using. + android_device: + type: optional + docs: The Android device which the contact is using. + android_os_version: + type: optional + docs: The version of the Android OS which the contact is using. + android_sdk_version: + type: optional + docs: The version of the Android SDK which the contact is using. + android_last_seen_at: + type: optional + docs: >- + (UNIX timestamp) The time when the contact was last seen on an Android + device. + ios_app_name: + type: optional + docs: The name of the iOS app which the contact is using. + ios_app_version: + type: optional + docs: The version of the iOS app which the contact is using. + ios_device: + type: optional + docs: The iOS device which the contact is using. + ios_os_version: + type: optional + docs: The version of iOS which the contact is using. + ios_sdk_version: + type: optional + docs: The version of the iOS SDK which the contact is using. + ios_last_seen_at: + type: optional + docs: (UNIX timestamp) The last time the contact used the iOS app. + custom_attributes: + type: optional> + docs: The custom attributes which are set for the contact. + avatar: + type: optional + tags: + type: optional + notes: + type: optional + companies: + type: optional + location: + type: optional + social_profiles: + type: optional + source: + openapi: ../openapi.yml +", + }, + "conversations.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Conversations", + "imports": { + "aiAgent": "aiAgent.yml", + "messages": "messages.yml", + "root": "__package__.yml", + "tickets": "tickets.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Conversations", + "endpoints": { + "attachContactToConversation": { + "auth": true, + "display-name": "Attach a contact to a conversation", + "docs": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="attention" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Attach a contact to a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "customer": { + "intercom_user_id": "667d61168a68186f43bafe0d", + }, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "customer": { + "intercom_user_id": "667d61188a68186f43bafe0e", + }, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/customers", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The `id` of the admin who is adding the new participant.", + "type": "optional", + }, + "customer": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachContactToConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Attach a contact to a conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "autoAssignConversation": { + "auth": true, + "display-name": "Run Assignment Rules on a conversation", + "docs": "You can let a conversation be automatically assigned following assignment rules. +{% admonition type="attention" name="When using workflows" %} +It is not possible to use this endpoint with Workflows. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Assign a conversation using assignment rules", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61108a68186f43bafe09", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "assigned_to": { + "type": "nobody_admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id364_that_should_be_at_least_@intercom.io", + "id": "991267624", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492881, + "id": "107", + "notified_at": 1719492881, + "part_type": "default_assignment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492881, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492880, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "409", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin197@email.com", + "id": "991267623", + "name": "Ciaran197 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918285", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492881, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/run_assignment_rules", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Assign a conversation using assignment rules", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "convertConversationToTicket": { + "auth": true, + "display-name": "Convert a conversation to a ticket", + "docs": "You can convert a conversation to a ticket.", + "errors": [ + "root.BadRequestError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "ticket_type_id": "79", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Customer", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61518a68186f43bafe45", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719492945, + "id": "474", + "is_shared": true, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "key": "value", + }, + "ticket_id": "37", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d61518a68186f43bafe45", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Comment for message

", + "created_at": 1719492945, + "id": "117", + "part_type": "comment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719492945, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "id": "991267667", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492947, + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719492947, + }, + ], + "total_count": 2, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Customer", + "created_at": 1719492947, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "79", + "name": "my-ticket-type-1", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719492947, + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719492947, + }, + }, + }, + { + "name": "Bad request", + "path-parameters": { + "id": 1, + }, + "request": { + "ticket_type_id": "80", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Customer", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61518a68186f43bafe45", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719492945, + "id": "474", + "is_shared": true, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "key": "value", + }, + "ticket_id": "37", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d61518a68186f43bafe45", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Comment for message

", + "created_at": 1719492945, + "id": "117", + "part_type": "comment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719492945, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id404_that_should_be_at_least_@intercom.io", + "id": "991267667", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492947, + "id": "118", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719492947, + }, + ], + "total_count": 2, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Customer", + "created_at": 1719492947, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "79", + "name": "my-ticket-type-1", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719492947, + "workspace_id": "this_is_an_id404_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719492947, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/convert", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "attributes": { + "type": "optional", + }, + "ticket_type_id": { + "docs": "The ID of the type of ticket you want to convert the conversation to", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "ConvertConversationToTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createConversation": { + "auth": true, + "display-name": "Creates a conversation", + "docs": "You can create a conversation that has been initiated by a contact (ie. user or lead). +The conversation can be an in-app message only. + +{% admonition type="info" name="Sending for visitors" %} +You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. +This visitor will be automatically converted to a contact with a lead role once the conversation is created. +{% /admonition %} + +This will return the Message model that has been created. + +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "conversation created", + "request": { + "body": "Hello there", + "from": { + "id": "667d60d18a68186f43bafddd", + "type": "user", + }, + }, + "response": { + "body": { + "body": "Hello there", + "conversation_id": "363", + "created_at": 1719492819, + "id": "403918251", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "Contact Not Found", + "request": { + "body": "Hello there", + "from": { + "id": "123_doesnt_exist", + "type": "user", + }, + }, + "response": { + "body": { + "body": "Hello there", + "conversation_id": "363", + "created_at": 1719492819, + "id": "403918251", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations", + "request": { + "body": { + "properties": { + "body": { + "docs": "The content of the message. HTML is not supported.", + "type": "string", + }, + "from": "CreateConversationRequestFrom", + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "conversation created", + "type": "messages.Message", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachContactFromConversation": { + "auth": true, + "display-name": "Detach a contact from a group conversation", + "docs": "You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + +{% admonition type="attention" name="Contacts without an email" %} +If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. +{% /admonition %} + +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + "root.UnprocessableEntityError", + ], + "examples": [ + { + "name": "Detach a contact from a group conversation", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Last customer", + "path-parameters": { + "contact_id": "123", + "conversation_id": "123", + }, + "request": { + "admin_id": "5017690", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": true, + "contacts": { + "contacts": [ + { + "id": "5ba682d23d7cf92bef87bfd4", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1663597223, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "1295", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 100, + "type": "list", + }, + "open": true, + "priority": "priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+abcd1234@intercom.io", + "id": "274", + "name": "Operator", + "type": "admin", + }, + "body": "

Hey there!

", + "delivered_as": "operator_initiated", + "id": "3", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1663597260, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/conversations/{conversation_id}/customers/{contact_id}", + "path-parameters": { + "contact_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + "conversation_id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The `id` of the admin who is performing the action.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachContactFromConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Detach a contact from a group conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listConversations": { + "auth": true, + "display-name": "List all conversations", + "docs": "You can fetch a list of all conversations. + +You can optionally request the result page size and the cursor to start after to fetch the result. +{% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. +{% /admonition %} +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1674917488, + "id": "12312", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1674917488, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "conversation.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/conversations", + "request": { + "name": "ListConversationsRequest", + "query-parameters": { + "per_page": { + "docs": "How many results per page", + "type": "optional", + }, + "starting_after": { + "docs": "String used to get the next page of conversations.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "manageConversation": { + "auth": true, + "display-name": "Manage a conversation", + "docs": "For managing conversations you can: +- Close a conversation +- Snooze a conversation to reopen on a future date +- Open a conversation which is `snoozed` or `closed` +- Assign a conversation to an admin and/or team. +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Close a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Goodbye :)", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60fd8a68186f43bafdfb", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

Goodbye :)

", + "created_at": 1719492862, + "id": "102", + "notified_at": 1719492862, + "part_type": "close", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492862, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492862, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "394", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918276", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492862, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Snooze a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60ff8a68186f43bafdfc", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin190@email.com", + "id": "991267610", + "name": "Ciaran190 Lee", + "type": "admin", + }, + "created_at": 1719492864, + "id": "103", + "notified_at": 1719492864, + "part_type": "snoozed", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492864, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492864, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "395", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1719496464, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin190@email.com", + "id": "991267610", + "name": "Ciaran190 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918277", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "snoozed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492864, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Open a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "74", + "id": "667d61038a68186f43bafe01", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin191@email.com", + "id": "991267612", + "name": "Ciaran191 Lee", + "type": "admin", + }, + "created_at": 1719492873, + "id": "105", + "notified_at": 1719492873, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492873, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492863, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "400", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin191@email.com", + "id": "991267612", + "name": "Ciaran191 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918278", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "", + "type": "conversation", + "updated_at": 1719492873, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Assign a conversation", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Let me pass you over to one of my colleagues.", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 991267615, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d610a8a68186f43bafe05", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "assigned_to": { + "id": "991267615", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin193@email.com", + "id": "991267615", + "name": "Ciaran193 Lee", + "type": "admin", + }, + "created_at": 1719492875, + "id": "106", + "notified_at": 1719492875, + "part_type": "assign_and_reopen", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492875, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492874, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "405", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin193@email.com", + "id": "991267615", + "name": "Ciaran193 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918281", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492875, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "12345", + "assignee_id": "4324241", + "body": "Goodbye :)", + "message_type": "assignment", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60fd8a68186f43bafdfb", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

Goodbye :)

", + "created_at": 1719492862, + "id": "102", + "notified_at": 1719492862, + "part_type": "close", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492862, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492862, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "394", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin189@email.com", + "id": "991267608", + "name": "Ciaran189 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918276", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492862, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/parts", + "path-parameters": { + "id": { + "docs": "The identifier for the conversation as given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": "ManageConversationRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Assign a conversation", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "redactConversation": { + "auth": true, + "display-name": "Redact a conversation part", + "docs": "You can redact a conversation part or the source message of a conversation (as seen in the source object). + +{% admonition type="info" name="Redacting parts and messages" %} +If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. +{% /admonition %} + +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Redact a conversation part", + "request": { + "conversation_id": "19894788788", + "conversation_part_id": "19381789428", + "type": "conversation_part", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d614a8a68186f43bafe42", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d614a8a68186f43bafe42", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

This message was deleted

", + "created_at": 1719492939, + "id": "115", + "notified_at": 1719492939, + "part_type": "open", + "redacted": true, + "type": "conversation_part", + "updated_at": 1719492940, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492938, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "471", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin217@email.com", + "id": "991267657", + "name": "Ciaran217 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918311", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492940, + "waiting_since": 1719492939, + }, + }, + }, + { + "name": "Not found", + "request": { + "conversation_id": "really_123_doesnt_exist", + "conversation_part_id": "really_123_doesnt_exist", + "type": "conversation_part", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d614a8a68186f43bafe42", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d614a8a68186f43bafe42", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

This message was deleted

", + "created_at": 1719492939, + "id": "115", + "notified_at": 1719492939, + "part_type": "open", + "redacted": true, + "type": "conversation_part", + "updated_at": 1719492940, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492938, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492939, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "471", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin217@email.com", + "id": "991267657", + "name": "Ciaran217 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918311", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492940, + "waiting_since": 1719492939, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/redact", + "request": { + "body": "root.RedactConversationRequest", + "content-type": "application/json", + }, + "response": { + "docs": "Redact a conversation part", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "replyConversation": { + "auth": true, + "display-name": "Reply to a conversation", + "docs": "You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "User reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f18a68186f43bafdf4", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f18a68186f43bafdf4", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f18a68186f43bafdf4", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492850, + "id": "99", + "notified_at": 1719492850, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492850, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492849, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "387", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin182@email.com", + "id": "991267594", + "name": "Ciaran182 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918269", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492850, + "waiting_since": 1719492850, + }, + }, + }, + { + "name": "Admin note reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "admin_id": "3156780", + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "message_type": "note", + "type": "admin", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f38a68186f43bafdf5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin183@email.com", + "id": "991267596", + "name": "Ciaran183 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719492853, + "id": "100", + "notified_at": 1719492853, + "part_type": "note", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492853, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492852, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "388", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin183@email.com", + "id": "991267596", + "name": "Ciaran183 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918270", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492853, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "User last conversation reply", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f78a68186f43bafdf7", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f78a68186f43bafdf7", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f78a68186f43bafdf7", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492856, + "id": "101", + "notified_at": 1719492856, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492856, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492855, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492856, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "390", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin185@email.com", + "id": "991267600", + "name": "Ciaran185 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918272", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492856, + "waiting_since": 1719492856, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123 or "last"", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d60f98a68186f43bafdf8", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60f18a68186f43bafdf4", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "joe@bloggs.com", + "id": "667d60f18a68186f43bafdf4", + "name": "Joe Bloggs", + "type": "user", + }, + "body": "

Thanks again :)

", + "created_at": 1719492850, + "id": "99", + "notified_at": 1719492850, + "part_type": "open", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492850, + }, + ], + "total_count": 1, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492849, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1719492850, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "387", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin182@email.com", + "id": "991267594", + "name": "Ciaran182 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918269", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "open", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492850, + "waiting_since": 1719492850, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{id}/reply", + "path-parameters": { + "id": { + "docs": "The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation", + "type": "string", + }, + }, + "request": { + "body": "root.ReplyConversationRequest", + "content-type": "application/json", + }, + "response": { + "docs": "User last conversation reply", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveConversation": { + "auth": true, + "display-name": "Retrieve a conversation", + "docs": " +You can fetch the details of a single conversation. + +This will return a single Conversation model with all its conversation parts. + +{% admonition type="warning" name="Hard limit of 500 parts" %} +The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. +{% /admonition %} + +For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "conversation found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60d88a68186f43bafde1", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "created_at": 1663597223, + "id": "3", + "notified_at": 1663597260, + "part_type": "comment", + "redacted": false, + "type": "conversation_part", + "updated_at": 1663597260, + }, + ], + "total_count": 0, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492825, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "367", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin153@email.com", + "id": "991267553", + "name": "Ciaran153 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918255", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492825, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/conversations/{id}", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "name": "RetrieveConversationRequest", + "query-parameters": { + "display_as": { + "docs": "Set to plaintext to retrieve conversation messages in plain text.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "conversation found", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchConversations": { + "auth": true, + "display-name": "Search conversations", + "docs": "You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + +To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + +This will accept a query object in the body which will define your filters in order to search for conversations. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiple's there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + +| Field | Type | +| :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | +| source.id | String | +| source.delivered_as | String | +| source.subject | String | +| source.body | String | +| source.author.id | String | +| source.author.type | String | +| source.author.name | String | +| source.author.email | String | +| source.url | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| channel_initiated | String | +| open | Boolean | +| read | Boolean | +| state | String | +| waiting_since | Date (UNIX timestamp) | +| snoozed_until | Date (UNIX timestamp) | +| tag_ids | String | +| priority | String | +| statistics.time_to_assignment | Integer | +| statistics.time_to_admin_reply | Integer | +| statistics.time_to_first_close | Integer | +| statistics.time_to_last_close | Integer | +| statistics.median_time_to_reply | Integer | +| statistics.first_contact_reply_at | Date (UNIX timestamp) | +| statistics.first_assignment_at | Date (UNIX timestamp) | +| statistics.first_admin_reply_at | Date (UNIX timestamp) | +| statistics.first_close_at | Date (UNIX timestamp) | +| statistics.last_assignment_at | Date (UNIX timestamp) | +| statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_contact_reply_at | Date (UNIX timestamp) | +| statistics.last_admin_reply_at | Date (UNIX timestamp) | +| statistics.last_close_at | Date (UNIX timestamp) | +| statistics.last_closed_by_id | String | +| statistics.count_reopens | Integer | +| statistics.count_assignments | Integer | +| statistics.count_conversation_parts | Integer | +| conversation_rating.requested_at | Date (UNIX timestamp) | +| conversation_rating.replied_at | Date (UNIX timestamp) | +| conversation_rating.score | Integer | +| conversation_rating.remark | String | +| conversation_rating.contact_id | String | +| conversation_rating.admin_d | String | +| ai_agent_participated | Boolean | +| ai_agent.resolution_state | String | +| ai_agent.last_answer_type | String | +| ai_agent.rating | Integer | +| ai_agent.rating_remark | String | +| ai_agent.source_type | String | +| ai_agent.source_title | String | + +### Accepted Operators + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "conversations": [ + { + "admin_assignee_id": 0, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60ea8a68186f43bafdec", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "total_count": 2, + }, + "conversation_rating": { + "created_at": 1671028894, + "rating": 5, + "remark": "", + }, + "created_at": 1719492843, + "custom_attributes": { + "key": "value", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + }, + "id": "378", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": false, + "sla_applied": { + "sla_name": "", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin180@email.com", + "id": "991267591", + "name": "Ciaran180 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918266", + "redacted": false, + "subject": "", + "type": "conversation", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492843, + "waiting_since": 1663597260, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 1, + "type": "pages", + }, + "total_count": 1, + "type": "conversation.list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.ConversationList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateConversation": { + "auth": true, + "display-name": "Update a conversation", + "docs": " +You can update an existing conversation. + +{% admonition type="info" name="Replying and other actions" %} +If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. +{% /admonition %} + +", + "errors": [ + "root.UnauthorizedError", + "root.ForbiddenError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "conversation found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "read": true, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60e08a68186f43bafde5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "96", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "97", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492832, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "371", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin157@email.com", + "id": "991267561", + "name": "Ciaran157 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918259", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492834, + "waiting_since": 1663597260, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": 1, + }, + "query-parameters": { + "display_as": "plaintext", + }, + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "read": true, + }, + "response": { + "body": { + "admin_assignee_id": 0, + "ai_agent": { + "content_sources": { + "content_sources": [ + { + "locale": "en", + "title": "My internal content snippet", + "url": "/fin-ai-agent/content?content=content_snippet&id=3234924", + }, + ], + "total_count": 1, + "type": "content_source.list", + }, + "last_answer_type": "ai_answer", + "rating": 4, + "rating_remark": "Very helpful!", + "resolution_state": "assumed_resolution", + "source_title": "My AI Workflow", + "source_type": "essentials_plan_setup", + }, + "ai_agent_participated": false, + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d60e08a68186f43bafde5", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "conversation_parts": { + "conversation_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "96", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id321_that_should_be_at_least_@intercom.io", + "id": "991267562", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719492834, + "id": "97", + "notified_at": 1719492834, + "part_type": "conversation_attribute_updated_by_admin", + "redacted": false, + "type": "conversation_part", + "updated_at": 1719492834, + }, + ], + "total_count": 2, + "type": "conversation_part.list", + }, + "conversation_rating": { + "contact": { + "external_id": "f3b87a2e09d514c6c2e79b9a", + "id": "5ba682d23d7cf92bef87bfd4", + "type": "contact", + }, + "created_at": 1671028894, + "rating": 5, + "remark": "", + "teammate": { + "id": "1a2b3c", + "type": "contact", + }, + }, + "created_at": 1719492832, + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "first_contact_reply": { + "created_at": 1663597223, + "type": "conversation", + "url": "https://developers.intercom.com/", + }, + "id": "371", + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": false, + "priority": "not_priority", + "read": true, + "sla_applied": { + "sla_name": "", + "sla_status": "hit", + "type": "conversation_sla_summary", + }, + "snoozed_until": 1663597260, + "source": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin157@email.com", + "id": "991267561", + "name": "Ciaran157 Lee", + "type": "admin", + }, + "body": "

this is the message body

", + "delivered_as": "admin_initiated", + "id": "403918259", + "redacted": false, + "subject": "", + "type": "conversation", + "url": "url", + }, + "state": "closed", + "statistics": { + "count_assignments": 1, + "count_conversation_parts": 1, + "count_reopens": 1, + "first_admin_reply_at": 1663597233, + "first_assignment_at": 1663597233, + "first_close_at": 1663597233, + "first_contact_reply_at": 1663597233, + "last_admin_reply_at": 1663597233, + "last_assignment_admin_reply_at": 1663597233, + "last_assignment_at": 1663597233, + "last_close_at": 1663597233, + "last_closed_by_id": "c3po", + "last_contact_reply_at": 1663597233, + "median_time_to_reply": 2310, + "time_to_admin_reply": 2310, + "time_to_assignment": 2310, + "time_to_first_close": 2310, + "time_to_last_close": 2310, + "type": "conversation_statistics", + }, + "tags": { + "tags": [ + { + "applied_at": 1663597223, + "id": "123456", + "name": "Test tag", + "type": "tag", + }, + ], + "type": "tag.list", + }, + "team_assignee_id": "5017691", + "teammates": { + "teammates": [ + { + "type": "contact", + }, + ], + "type": "admin.list", + }, + "title": "Conversation Title", + "type": "conversation", + "updated_at": 1719492834, + "waiting_since": 1663597260, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/conversations/{id}", + "path-parameters": { + "id": { + "docs": "The id of the conversation to target", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "custom_attributes": { + "type": "optional", + }, + "read": { + "docs": "Mark a conversation as read within Intercom.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateConversationRequest", + "query-parameters": { + "display_as": { + "docs": "Set to plaintext to retrieve conversation messages in plain text.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "conversation found", + "type": "Conversation", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "AttachContactToConversationRequestCustomer": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "AttachContactToConversationRequestCustomerIntercomUserId", + }, + { + "type": "AttachContactToConversationRequestCustomerUserId", + }, + { + "type": "Email", + }, + ], + }, + "AttachContactToConversationRequestCustomerIntercomUserId": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "intercom_user_id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "AttachContactToConversationRequestCustomerUserId": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "user_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Conversation": { + "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "properties": { + "admin_assignee_id": { + "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", + "type": "optional", + }, + "ai_agent": { + "type": "optional", + }, + "ai_agent_participated": { + "docs": "Indicates whether the AI Agent participated in the conversation.", + "type": "optional", + }, + "contacts": { + "type": "optional", + }, + "conversation_parts": { + "type": "optional", + }, + "conversation_rating": { + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation was created.", + "type": "optional", + }, + "custom_attributes": { + "type": "optional", + }, + "first_contact_reply": { + "type": "optional", + }, + "id": { + "docs": "The id representing the conversation.", + "type": "optional", + }, + "linked_objects": { + "type": "optional", + }, + "open": { + "docs": "Indicates whether a conversation is open (true) or closed (false).", + "type": "optional", + }, + "priority": { + "docs": "If marked as priority, it will return priority or else not_priority.", + "type": "optional", + }, + "read": { + "docs": "Indicates whether a conversation has been read.", + "type": "optional", + }, + "sla_applied": { + "type": "optional", + }, + "snoozed_until": { + "docs": "If set this is the time in the future when this conversation will be marked as open. i.e. it will be in a snoozed state until this time. i.e. it will be in a snoozed state until this time.", + "type": "optional", + }, + "source": { + "type": "optional", + }, + "state": { + "docs": "Can be set to "open", "closed" or "snoozed".", + "type": "optional", + }, + "statistics": { + "type": "optional", + }, + "tags": { + "type": "optional", + }, + "team_assignee_id": { + "docs": "The id of the team assigned to the conversation. If it's not assigned to a team it will return null.", + "type": "optional", + }, + "teammates": { + "type": "optional", + }, + "title": { + "docs": "The title given to the conversation.", + "type": "optional", + }, + "type": { + "docs": "Always conversation.", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the conversation was updated.", + "type": "optional", + }, + "waiting_since": { + "docs": "The last time a Contact responded to an Admin. In other words, the time a customer started waiting for a response. Set to null if last reply is from an Admin.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationPriority": { + "docs": "If marked as priority, it will return priority or else not_priority.", + "enum": [ + "priority", + "not_priority", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "ConversationState": { + "docs": "Can be set to "open", "closed" or "snoozed".", + "enum": [ + "open", + "closed", + "snoozed", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateConversationRequestFrom": { + "docs": undefined, + "properties": { + "id": { + "docs": "The identifier for the contact which is given by Intercom.", + "type": "string", + "validation": { + "format": "uuid", + "maxLength": 24, + "minLength": 24, + "pattern": undefined, + }, + }, + "type": { + "docs": "The role associated to the contact - user or lead.", + "type": "CreateConversationRequestFromType", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateConversationRequestFromType": { + "docs": "The role associated to the contact - user or lead.", + "enum": [ + "lead", + "user", + "contact", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "customer": { + "type": "optional", + }, + "email": { + "docs": "The email you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ManageConversationRequestBody": { + "availability": undefined, + "base-properties": {}, + "discriminant": "message_type", + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": { + "assignment": { + "type": "root.AssignConversationRequest", + }, + "close": { + "type": "root.CloseConversationRequest", + }, + "open": { + "type": "root.OpenConversationRequest", + }, + "snoozed": { + "type": "root.SnoozeConversationRequest", + }, + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + messages: messages.yml + tickets: tickets.yml + aiAgent: aiAgent.yml +service: + auth: false + base-path: '' + endpoints: + listConversations: + path: /conversations + method: GET + auth: true + docs: > + You can fetch a list of all conversations. + + + You can optionally request the result page size and the cursor to start + after to fetch the result. + + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + source: + openapi: ../openapi.yml + display-name: List all conversations + request: + name: ListConversationsRequest + query-parameters: + per_page: + type: optional + docs: How many results per page + starting_after: + type: optional + docs: String used to get the next page of conversations. + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.UnauthorizedError + - root.ForbiddenError + examples: + - name: successful + response: + body: + type: conversation.list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + total_count: 1 + data: + - type: newsfeed + id: '12312' + name: My Newsfeed + created_at: 1674917488 + updated_at: 1674917488 + createConversation: + path: /conversations + method: POST + auth: true + docs: >+ + You can create a conversation that has been initiated by a contact (ie. + user or lead). + + The conversation can be an in-app message only. + + + {% admonition type="info" name="Sending for visitors" %} + + You can also send a message from a visitor by specifying their `user_id` + or `id` value in the `from` field, along with a `type` field value of + `contact`. + + This visitor will be automatically converted to a contact with a lead + role once the conversation is created. + + {% /admonition %} + + + This will return the Message model that has been created. + + source: + openapi: ../openapi.yml + display-name: Creates a conversation + request: + name: CreateConversationRequest + body: + properties: + from: CreateConversationRequestFrom + body: + type: string + docs: The content of the message. HTML is not supported. + content-type: application/json + response: + docs: conversation created + type: messages.Message + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: conversation created + request: + from: + type: user + id: 667d60d18a68186f43bafddd + body: Hello there + response: + body: + type: user_message + id: '403918251' + created_at: 1719492819 + subject: Greetings + body: Hello there + message_type: inapp + conversation_id: '363' + - name: Contact Not Found + request: + from: + type: user + id: 123_doesnt_exist + body: Hello there + response: + body: + type: user_message + id: '403918251' + created_at: 1719492819 + subject: Greetings + body: Hello there + message_type: inapp + conversation_id: '363' + retrieveConversation: + path: /conversations/{id} + method: GET + auth: true + docs: > + + You can fetch the details of a single conversation. + + + This will return a single Conversation model with all its conversation + parts. + + + {% admonition type="warning" name="Hard limit of 500 parts" %} + + The maximum number of conversation parts that can be returned via the + API is 500. If you have more than that we will return the 500 most + recent conversation parts. + + {% /admonition %} + + + For AI agent conversation metadata, please note that you need to have + the agent enabled in your workspace, which is a [paid + feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Retrieve a conversation + request: + name: RetrieveConversationRequest + query-parameters: + display_as: + type: optional + docs: Set to plaintext to retrieve conversation messages in plain text. + response: + docs: conversation found + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: conversation found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + response: + body: + type: conversation + id: '367' + title: Conversation Title + created_at: 1719492825 + updated_at: 1719492825 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918255' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267553' + name: Ciaran153 Lee + email: admin153@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60d88a68186f43bafde1 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 0 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + updateConversation: + path: /conversations/{id} + method: PUT + auth: true + docs: >+ + + You can update an existing conversation. + + + {% admonition type="info" name="Replying and other actions" %} + + If you want to reply to a coveration or take an action such as assign, + unassign, open, close or snooze, take a look at the reply and manage + endpoints. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Update a conversation + request: + name: UpdateConversationRequest + query-parameters: + display_as: + type: optional + docs: Set to plaintext to retrieve conversation messages in plain text. + body: + properties: + read: + type: optional + docs: Mark a conversation as read within Intercom. + custom_attributes: + type: optional + content-type: application/json + response: + docs: conversation found + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: conversation found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + request: + read: true + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: conversation + id: '371' + title: Conversation Title + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + issue_type: Billing + priority: High + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: 1 + query-parameters: + display_as: plaintext + request: + read: true + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: conversation + id: '371' + title: Conversation Title + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + issue_type: Billing + priority: High + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + author: + type: bot + id: '991267562' + name: Operator + email: >- + operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + searchConversations: + path: /conversations/search + method: POST + auth: true + docs: > + You can search for multiple conversations by the value of their + attributes in order to fetch exactly which ones you want. + + + To search for conversations, you need to send a `POST` request to + `https://api.intercom.io/conversations/search`. + + + This will accept a query object in the body which will define your + filters in order to search for conversations. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiple's there can be: + + - There's a limit of max 2 nested filters + + - There's a limit of max 15 filters for each AND or OR group + + + ### Accepted Fields + + + Most keys listed as part of the The conversation model is searchable, + whether writeable or not. The value you search for has to match the + accepted type, otherwise the query will fail (ie. as `created_at` + accepts a date, the `value` cannot be a string such as `"foorbar"`). + + + | Field | + Type + | + + | :---------------------------------------- | + :----------------------------------------------------------------------------------------------------------------------------------------------------- + | + + | id | + String + | + + | created_at | Date (UNIX + timestamp) + | + + | updated_at | Date (UNIX + timestamp) + | + + | source.type | String
Accepted fields + are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, + `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + + | source.id | + String + | + + | source.delivered_as | + String + | + + | source.subject | + String + | + + | source.body | + String + | + + | source.author.id | + String + | + + | source.author.type | + String + | + + | source.author.name | + String + | + + | source.author.email | + String + | + + | source.url | + String + | + + | contact_ids | + String + | + + | teammate_ids | + String + | + + | admin_assignee_id | + String + | + + | team_assignee_id | + String + | + + | channel_initiated | + String + | + + | open | + Boolean + | + + | read | + Boolean + | + + | state | + String + | + + | waiting_since | Date (UNIX + timestamp) + | + + | snoozed_until | Date (UNIX + timestamp) + | + + | tag_ids | + String + | + + | priority | + String + | + + | statistics.time_to_assignment | + Integer + | + + | statistics.time_to_admin_reply | + Integer + | + + | statistics.time_to_first_close | + Integer + | + + | statistics.time_to_last_close | + Integer + | + + | statistics.median_time_to_reply | + Integer + | + + | statistics.first_contact_reply_at | Date (UNIX + timestamp) + | + + | statistics.first_assignment_at | Date (UNIX + timestamp) + | + + | statistics.first_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.first_close_at | Date (UNIX + timestamp) + | + + | statistics.last_assignment_at | Date (UNIX + timestamp) + | + + | statistics.last_assignment_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_contact_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_admin_reply_at | Date (UNIX + timestamp) + | + + | statistics.last_close_at | Date (UNIX + timestamp) + | + + | statistics.last_closed_by_id | + String + | + + | statistics.count_reopens | + Integer + | + + | statistics.count_assignments | + Integer + | + + | statistics.count_conversation_parts | + Integer + | + + | conversation_rating.requested_at | Date (UNIX + timestamp) + | + + | conversation_rating.replied_at | Date (UNIX + timestamp) + | + + | conversation_rating.score | + Integer + | + + | conversation_rating.remark | + String + | + + | conversation_rating.contact_id | + String + | + + | conversation_rating.admin_d | + String + | + + | ai_agent_participated | + Boolean + | + + | ai_agent.resolution_state | + String + | + + | ai_agent.last_answer_type | + String + | + + | ai_agent.rating | + Integer + | + + | ai_agent.rating_remark | + String + | + + | ai_agent.source_type | + String + | + + | ai_agent.source_title | + String + | + + + ### Accepted Operators + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :----------------------------- | + :----------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In Shortcut for `OR` + queries Values most be in Array | + + | NIN | All | Not In Shortcut for `OR + !` queries Values must be in Array | + + | > | Integer Date (UNIX Timestamp) | Greater (or equal) + than | + + | < | Integer Date (UNIX Timestamp) | Lower (or equal) + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search conversations + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.ConversationList + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: conversation.list + conversations: + - type: conversation + id: '378' + title: Conversation Title + created_at: 1719492843 + updated_at: 1719492843 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + source: + type: conversation + id: '403918266' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267591' + name: Ciaran180 Lee + email: admin180@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ea8a68186f43bafdec + external_id: '70' + teammates: + type: admin.list + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + sla_applied: + type: conversation_sla_summary + sla_name: '' + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + total_count: 2 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + total_count: 1 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 1 + replyConversation: + path: /conversations/{id}/reply + method: POST + auth: true + docs: >- + You can reply to a conversation with a message from an admin or on + behalf of a contact, or with a note for admins. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + display-name: Reply to a conversation + request: + body: root.ReplyConversationRequest + content-type: application/json + response: + docs: User last conversation reply + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: User reply + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f18a68186f43bafdf4 + response: + body: + type: conversation + id: '387' + title: Conversation Title + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492850 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body:

Thanks again :)

+ created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + author: + type: user + id: 667d60f18a68186f43bafdf4 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Admin note reply + path-parameters: + id: 123 or "last" + request: + message_type: note + type: admin + body: >- +

An Unordered HTML List

    +
  • Coffee
  • Tea
  • Milk

An + Ordered HTML List

  1. Coffee
  2. Tea
  3. +
  4. Milk
+ admin_id: '3156780' + response: + body: + type: conversation + id: '388' + title: Conversation Title + created_at: 1719492852 + updated_at: 1719492853 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918270' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f38a68186f43bafdf5 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '100' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719492853 + updated_at: 1719492853 + notified_at: 1719492853 + author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: User last conversation reply + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f78a68186f43bafdf7 + response: + body: + type: conversation + id: '390' + title: Conversation Title + created_at: 1719492855 + updated_at: 1719492856 + waiting_since: 1719492856 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918272' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267600' + name: Ciaran185 Lee + email: admin185@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f78a68186f43bafdf7 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492856 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '101' + part_type: open + body:

Thanks again :)

+ created_at: 1719492856 + updated_at: 1719492856 + notified_at: 1719492856 + author: + type: user + id: 667d60f78a68186f43bafdf7 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: 123 or "last" + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d60f98a68186f43bafdf8 + response: + body: + type: conversation + id: '387' + title: Conversation Title + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492850 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body:

Thanks again :)

+ created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + author: + type: user + id: 667d60f18a68186f43bafdf4 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + manageConversation: + path: /conversations/{id}/parts + method: POST + auth: true + docs: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Manage a conversation + request: + body: ManageConversationRequestBody + content-type: application/json + response: + docs: Assign a conversation + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: Close a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Goodbye :) + response: + body: + type: conversation + id: '394' + title: Conversation Title + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body:

Goodbye :)

+ created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Snooze a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '395' + title: Conversation Title + created_at: 1719492864 + updated_at: 1719492864 + waiting_since: 1663597260 + snoozed_until: 1719496464 + open: true + state: snoozed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918277' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ff8a68186f43bafdfc + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '103' + part_type: snoozed + created_at: 1719492864 + updated_at: 1719492864 + notified_at: 1719492864 + author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Open a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '400' + title: '' + created_at: 1719492863 + updated_at: 1719492873 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918278' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61038a68186f43bafe01 + external_id: '74' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '105' + part_type: open + created_at: 1719492873 + updated_at: 1719492873 + notified_at: 1719492873 + author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Assign a conversation + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Let me pass you over to one of my colleagues. + response: + body: + type: conversation + id: '405' + title: Conversation Title + created_at: 1719492874 + updated_at: 1719492875 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: false + priority: not_priority + admin_assignee_id: 991267615 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918281' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d610a8a68186f43bafe05 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '106' + part_type: assign_and_reopen + created_at: 1719492875 + updated_at: 1719492875 + notified_at: 1719492875 + assigned_to: + type: admin + id: '991267615' + author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: '123' + request: + message_type: assignment + type: admin + admin_id: '12345' + assignee_id: '4324241' + body: Goodbye :) + response: + body: + type: conversation + id: '394' + title: Conversation Title + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body:

Goodbye :)

+ created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + autoAssignConversation: + path: /conversations/{id}/run_assignment_rules + method: POST + auth: true + docs: > + You can let a conversation be automatically assigned following + assignment rules. + + {% admonition type="attention" name="When using workflows" %} + + It is not possible to use this endpoint with Workflows. + + {% /admonition %} + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Run Assignment Rules on a conversation + response: + docs: Assign a conversation using assignment rules + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: Assign a conversation using assignment rules + path-parameters: + id: '123' + response: + body: + type: conversation + id: '409' + title: Conversation Title + created_at: 1719492880 + updated_at: 1719492881 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: false + state: closed + read: false + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918285' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267623' + name: Ciaran197 Lee + email: admin197@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61108a68186f43bafe09 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '107' + part_type: default_assignment + created_at: 1719492881 + updated_at: 1719492881 + notified_at: 1719492881 + assigned_to: + type: nobody_admin + author: + type: bot + id: '991267624' + name: Operator + email: >- + operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + attachContactToConversation: + path: /conversations/{id}/customers + method: POST + auth: true + docs: >+ + You can add participants who are contacts to a conversation, on behalf + of either another contact or an admin. + + + {% admonition type="attention" name="Contacts without an email" %} + + If you add a contact via the email parameter and there is no user/lead + found on that workspace with he given email, then we will create a new + contact with `role` set to `lead`. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The identifier for the conversation as given by Intercom. + display-name: Attach a contact to a conversation + request: + name: AttachContactToConversationRequest + body: + properties: + admin_id: + type: optional + docs: The `id` of the admin who is adding the new participant. + customer: + type: optional + content-type: application/json + response: + docs: Attach a contact to a conversation + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + examples: + - name: Attach a contact to a conversation + path-parameters: + id: '123' + request: + admin_id: '12345' + customer: + intercom_user_id: 667d61168a68186f43bafe0d + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + path-parameters: + id: '123' + request: + admin_id: '12345' + customer: + intercom_user_id: 667d61188a68186f43bafe0e + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + detachContactFromConversation: + path: /conversations/{conversation_id}/customers/{contact_id} + method: DELETE + auth: true + docs: >+ + You can add participants who are contacts to a conversation, on behalf + of either another contact or an admin. + + + {% admonition type="attention" name="Contacts without an email" %} + + If you add a contact via the email parameter and there is no user/lead + found on that workspace with he given email, then we will create a new + contact with `role` set to `lead`. + + {% /admonition %} + + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: The identifier for the conversation as given by Intercom. + contact_id: + type: string + docs: The identifier for the contact as given by Intercom. + display-name: Detach a contact from a group conversation + request: + name: DetachContactFromConversationRequest + body: + properties: + admin_id: + type: string + docs: The `id` of the admin who is performing the action. + content-type: application/json + response: + docs: Detach a contact from a group conversation + type: Conversation + errors: + - root.UnauthorizedError + - root.ForbiddenError + - root.NotFoundError + - root.UnprocessableEntityError + examples: + - name: Detach a contact from a group conversation + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Conversation not found + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Contact not found + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Last customer + path-parameters: + conversation_id: '123' + contact_id: '123' + request: + admin_id: '5017690' + response: + body: + type: conversation + id: '1295' + title: Conversation Title + created_at: 1663597223 + updated_at: 1663597260 + waiting_since: 1663597260 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '3' + delivered_as: operator_initiated + subject: '' + body:

Hey there!

+ author: + type: admin + id: '274' + name: Operator + email: operator+abcd1234@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - id: 5ba682d23d7cf92bef87bfd4 + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1663597223 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '3' + part_type: comment + created_at: 1663597223 + updated_at: 1663597260 + notified_at: 1663597260 + redacted: false + total_count: 2 + linked_objects: + type: list + total_count: 100 + has_more: false + data: + - id: '7583' + ai_agent_participated: true + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + redactConversation: + path: /conversations/redact + method: POST + auth: true + docs: >+ + You can redact a conversation part or the source message of a + conversation (as seen in the source object). + + + {% admonition type="info" name="Redacting parts and messages" %} + + If you are redacting a conversation part, it must have a `body`. If you + are redacting a source message, it must have been created by a contact. + We will return a `conversation_part_not_redactable` error if these + criteria are not met. + + {% /admonition %} + + source: + openapi: ../openapi.yml + display-name: Redact a conversation part + request: + body: root.RedactConversationRequest + content-type: application/json + response: + docs: Redact a conversation part + type: Conversation + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Redact a conversation part + request: + type: conversation_part + conversation_id: '19894788788' + conversation_part_id: '19381789428' + response: + body: + type: conversation + id: '471' + title: Conversation Title + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492939 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body:

This message was deleted

+ created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + author: + type: user + id: 667d614a8a68186f43bafe42 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: true + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + - name: Not found + request: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + response: + body: + type: conversation + id: '471' + title: Conversation Title + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: 1663597260 + open: true + state: open + read: true + priority: not_priority + admin_assignee_id: 0 + team_assignee_id: '5017691' + tags: + type: tag.list + tags: + - type: tag + id: '123456' + name: Test tag + applied_at: 1663597223 + conversation_rating: + rating: 5 + remark: '' + created_at: 1671028894 + contact: + type: contact + id: 5ba682d23d7cf92bef87bfd4 + external_id: f3b87a2e09d514c6c2e79b9a + teammate: + type: contact + id: 1a2b3c + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body:

this is the message body

+ author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + url: url + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + teammates: + type: admin.list + teammates: + - type: contact + custom_attributes: + key: value + first_contact_reply: + created_at: 1719492939 + type: conversation + url: https://developers.intercom.com/ + sla_applied: + type: conversation_sla_summary + sla_name: '' + sla_status: hit + statistics: + type: conversation_statistics + time_to_assignment: 2310 + time_to_admin_reply: 2310 + time_to_first_close: 2310 + time_to_last_close: 2310 + median_time_to_reply: 2310 + first_contact_reply_at: 1663597233 + first_assignment_at: 1663597233 + first_admin_reply_at: 1663597233 + first_close_at: 1663597233 + last_assignment_at: 1663597233 + last_assignment_admin_reply_at: 1663597233 + last_contact_reply_at: 1663597233 + last_admin_reply_at: 1663597233 + last_close_at: 1663597233 + last_closed_by_id: c3po + count_reopens: 1 + count_assignments: 1 + count_conversation_parts: 1 + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body:

This message was deleted

+ created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + author: + type: user + id: 667d614a8a68186f43bafe42 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: true + total_count: 1 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ai_agent_participated: false + ai_agent: + source_type: essentials_plan_setup + source_title: My AI Workflow + last_answer_type: ai_answer + resolution_state: assumed_resolution + rating: 4 + rating_remark: Very helpful! + content_sources: + type: content_source.list + total_count: 1 + content_sources: + - url: /fin-ai-agent/content?content=content_snippet&id=3234924 + title: My internal content snippet + locale: en + convertConversationToTicket: + path: /conversations/{id}/convert + method: POST + auth: true + docs: You can convert a conversation to a ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The id of the conversation to target + display-name: Convert a conversation to a ticket + request: + name: ConvertConversationToTicketRequest + body: + properties: + ticket_type_id: + type: string + docs: >- + The ID of the type of ticket you want to convert the + conversation to + attributes: + type: optional + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.BadRequestError + examples: + - name: successful + path-parameters: + id: 1 + request: + ticket_type_id: '79' + response: + body: + type: ticket + id: '474' + ticket_id: '37' + category: Customer + ticket_attributes: + key: value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + category: Customer + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id404_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719492947 + updated_at: 1719492947 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body:

Comment for message

+ created_at: 1719492945 + updated_at: 1719492945 + author: + type: user + id: 667d61518a68186f43bafe45 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + type: bot + id: '991267667' + name: Operator + email: >- + operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + - name: Bad request + path-parameters: + id: 1 + request: + ticket_type_id: '80' + response: + body: + type: ticket + id: '474' + ticket_id: '37' + category: Customer + ticket_attributes: + key: value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + category: Customer + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id404_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719492947 + updated_at: 1719492947 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body:

Comment for message

+ created_at: 1719492945 + updated_at: 1719492945 + author: + type: user + id: 667d61518a68186f43bafe45 + name: Joe Bloggs + email: joe@bloggs.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + type: bot + id: '991267667' + name: Operator + email: >- + operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 2 + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + source: + openapi: ../openapi.yml + display-name: Conversations +docs: Everything about your Conversations +types: + CreateConversationRequestFromType: + enum: + - lead + - user + - contact + docs: The role associated to the contact - user or lead. + source: + openapi: ../openapi.yml + CreateConversationRequestFrom: + properties: + type: + type: CreateConversationRequestFromType + docs: The role associated to the contact - user or lead. + id: + type: string + docs: The identifier for the contact which is given by Intercom. + validation: + format: uuid + minLength: 24 + maxLength: 24 + source: + openapi: ../openapi.yml + ManageConversationRequestBody: + discriminant: message_type + base-properties: {} + union: + close: + type: root.CloseConversationRequest + snoozed: + type: root.SnoozeConversationRequest + open: + type: root.OpenConversationRequest + assignment: + type: root.AssignConversationRequest + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomerIntercomUserId: + properties: + intercom_user_id: + type: string + docs: The identifier for the contact as given by Intercom. + customer: + type: optional + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomerUserId: + properties: + user_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + customer: + type: optional + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. + customer: + type: optional + source: + openapi: ../openapi.yml + AttachContactToConversationRequestCustomer: + discriminated: false + union: + - type: AttachContactToConversationRequestCustomerIntercomUserId + - type: AttachContactToConversationRequestCustomerUserId + - type: Email + source: + openapi: ../openapi.yml + ConversationState: + enum: + - open + - closed + - snoozed + docs: Can be set to "open", "closed" or "snoozed". + source: + openapi: ../openapi.yml + ConversationPriority: + enum: + - priority + - not_priority + docs: If marked as priority, it will return priority or else not_priority. + source: + openapi: ../openapi.yml + Conversation: + docs: >- + Conversations are how you can communicate with users in Intercom. They are + created when a contact replies to an outbound message, or when one admin + directly sends a message to a single contact. + properties: + type: + type: optional + docs: Always conversation. + id: + type: optional + docs: The id representing the conversation. + title: + type: optional + docs: The title given to the conversation. + created_at: + type: optional + docs: The time the conversation was created. + updated_at: + type: optional + docs: The last time the conversation was updated. + waiting_since: + type: optional + docs: >- + The last time a Contact responded to an Admin. In other words, the + time a customer started waiting for a response. Set to null if last + reply is from an Admin. + snoozed_until: + type: optional + docs: >- + If set this is the time in the future when this conversation will be + marked as open. i.e. it will be in a snoozed state until this time. + i.e. it will be in a snoozed state until this time. + open: + type: optional + docs: Indicates whether a conversation is open (true) or closed (false). + state: + type: optional + docs: Can be set to "open", "closed" or "snoozed". + read: + type: optional + docs: Indicates whether a conversation has been read. + priority: + type: optional + docs: If marked as priority, it will return priority or else not_priority. + admin_assignee_id: + type: optional + docs: >- + The id of the admin assigned to the conversation. If it's not assigned + to an admin it will return null. + team_assignee_id: + type: optional + docs: >- + The id of the team assigned to the conversation. If it's not assigned + to a team it will return null. + tags: + type: optional + conversation_rating: + type: optional + source: + type: optional + contacts: + type: optional + teammates: + type: optional + custom_attributes: + type: optional + first_contact_reply: + type: optional + sla_applied: + type: optional + statistics: + type: optional + conversation_parts: + type: optional + linked_objects: + type: optional + ai_agent_participated: + type: optional + docs: Indicates whether the AI Agent participated in the conversation. + ai_agent: + type: optional + source: + openapi: ../openapi.yml +", + }, + "customObjectInstances.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "types": { + "CustomObjectInstance": { + "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "properties": { + "custom_attributes": { + "docs": "The custom attributes you have set on the custom object instance.", + "type": "optional>", + }, + "external_id": { + "docs": "The id you have defined for the custom object instance.", + "type": "optional", + }, + "id": { + "docs": "The Intercom defined id representing the custom object instance.", + "type": "optional", + }, + "type": { + "docs": "The identifier of the custom object type that defines the structure of the custom object instance.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + CustomObjectInstance: + docs: >- + A Custom Object Instance represents an instance of a custom object type. + This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom + attributes. + properties: + id: + type: optional + docs: The Intercom defined id representing the custom object instance. + external_id: + type: optional + docs: The id you have defined for the custom object instance. + type: + type: optional + docs: >- + The identifier of the custom object type that defines the structure of + the custom object instance. + custom_attributes: + type: optional> + docs: The custom attributes you have set on the custom object instance. + source: + openapi: ../openapi.yml +", + }, + "dataAttributes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Attributes", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Attributes", + "endpoints": { + "createDataAttribute": { + "auth": true, + "display-name": "Create a data attribute", + "docs": "You can create a data attributes for a `contact` or a `company`.", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "request": { + "data_type": "string", + "model": "company", + "name": "Mithril Shirt", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Same name already exists", + "request": { + "data_type": "integer", + "model": "contact", + "name": "The One Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Invalid name", + "request": { + "data_type": "string", + "model": "company", + "name": "!nv@l!d n@me", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Attribute already exists", + "request": { + "data_type": "string", + "model": "company", + "name": "The One Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Invalid Data Type", + "request": { + "data_type": "string", + "model": "company", + "name": "The Second Ring", + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + { + "name": "Too few options for list", + "request": { + "data_type": "string", + "description": "Just a plain old ring", + "model": "contact", + "name": "My Data Attribute", + "options": [ + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267686", + "api_writable": true, + "archived": false, + "created_at": 1719492955, + "custom": true, + "data_type": "string", + "description": "Whether the user is a paid subscriber.", + "full_name": "custom_attributes.Mithril Shirt", + "id": 37, + "label": "Mithril Shirt", + "messenger_writable": false, + "model": "company", + "name": "Mithril Shirt", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492955, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/data_attributes", + "request": { + "body": { + "properties": { + "data_type": { + "docs": "The type of data stored for this attribute.", + "type": "CreateDataAttributeRequestDataType", + }, + "description": { + "docs": "The readable description you see in the UI for the attribute.", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "model": { + "docs": "The model that the data attribute belongs to.", + "type": "CreateDataAttributeRequestModel", + }, + "name": { + "docs": "The name of the data attribute.", + "type": "string", + }, + "options": { + "docs": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "DataAttribute", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "lisDataAttributes": { + "auth": true, + "display-name": "List all data attributes", + "docs": "You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "data": [ + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The name of a company", + "full_name": "name", + "id": 12878, + "label": "Company name", + "messenger_writable": true, + "model": "company", + "name": "name", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "A number identifying a company", + "full_name": "company_id", + "id": 12878, + "label": "Company ID", + "messenger_writable": true, + "model": "company", + "name": "company_id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The last day anyone from a company visited your site or app", + "full_name": "last_request_at", + "id": 12878, + "label": "Company last seen", + "messenger_writable": true, + "model": "company", + "name": "last_request_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The day a company was added to Intercom", + "full_name": "remote_created_at", + "id": 12878, + "label": "Company created at", + "messenger_writable": true, + "model": "company", + "name": "remote_created_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "The number of people in a company", + "full_name": "user_count", + "id": 12878, + "label": "People", + "messenger_writable": true, + "model": "company", + "name": "user_count", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "All visits from anyone in a company to your product's site or app", + "full_name": "session_count", + "id": 12878, + "label": "Company web sessions", + "messenger_writable": true, + "model": "company", + "name": "session_count", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "A specific plan or level within your product that companies have signed up to", + "full_name": "plan.name", + "id": 12878, + "label": "Plan", + "messenger_writable": true, + "model": "company", + "name": "name", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "float", + "description": "The monthly revenue you receive from a company", + "full_name": "monthly_spend", + "id": 12878, + "label": "Monthly Spend", + "messenger_writable": true, + "model": "company", + "name": "monthly_spend", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "integer", + "description": "The number of people employed in this company, expressed as a single number", + "full_name": "size", + "id": 12878, + "label": "Company size", + "messenger_writable": true, + "model": "company", + "name": "size", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The category or domain this company belongs to e.g. 'ecommerce' or 'SaaS'", + "full_name": "industry", + "id": 12878, + "label": "Company industry", + "messenger_writable": true, + "model": "company", + "name": "industry", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": true, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The web address for the company's primary marketing site", + "full_name": "website", + "id": 12878, + "label": "Company website", + "messenger_writable": true, + "model": "company", + "name": "website", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "991267684", + "api_writable": true, + "archived": false, + "created_at": 1719492954, + "custom": true, + "data_type": "string", + "description": "One ring to rule them all, one ring to find them, One ring to bring them all and in the darkness bind them.", + "full_name": "custom_attributes.The One Ring", + "id": 34, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492954, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the company", + "full_name": "id", + "id": 12878, + "label": "ID", + "messenger_writable": true, + "model": "company", + "name": "id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The time the company was added to Intercom", + "full_name": "created_at", + "id": 12878, + "label": "Created at", + "messenger_writable": true, + "model": "company", + "name": "created_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "date", + "description": "The last time the company was updated", + "full_name": "updated_at", + "id": 12878, + "label": "Updated at", + "messenger_writable": true, + "model": "company", + "name": "updated_at", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the plan", + "full_name": "plan.id", + "id": 12878, + "label": "Plan ID", + "messenger_writable": true, + "model": "company", + "name": "id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + { + "admin_id": "5712945", + "api_writable": false, + "archived": false, + "created_at": 1671028894, + "custom": false, + "data_type": "string", + "description": "The Intercom defined id representing the app", + "full_name": "app_id", + "id": 12878, + "label": "App ID", + "messenger_writable": true, + "model": "company", + "name": "app_id", + "options": [ + "true", + "false", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1671028894, + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/data_attributes", + "request": { + "name": "LisDataAttributesRequest", + "query-parameters": { + "include_archived": { + "docs": "Include archived attributes in the list. By default we return only non archived data attributes.", + "type": "optional", + }, + "model": { + "docs": "Specify the data attribute model to return.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.DataAttributeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateDataAttribute": { + "auth": true, + "display-name": "Update a data attribute", + "docs": " +You can update a data attribute. + +> 🚧 Updating the data type is not possible +> +> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead. +", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.NotFoundError", + "root.UnprocessableEntityError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Just a plain old ring", + "options": [ + "options", + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Too few options in list", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Too few options", + "options": [ + "option1", + "option2", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Attribute Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": false, + "description": "Just a plain old ring", + "options": [ + "options", + "options", + ], + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + { + "name": "Has Dependant Object", + "path-parameters": { + "id": 1, + }, + "request": { + "archived": true, + "description": "Trying to archieve", + }, + "response": { + "body": { + "admin_id": "991267693", + "api_writable": true, + "archived": false, + "created_at": 1719492958, + "custom": true, + "data_type": "string", + "description": "Just a plain old ring", + "full_name": "custom_attributes.The One Ring", + "id": 44, + "label": "The One Ring", + "messenger_writable": true, + "model": "company", + "name": "The One Ring", + "options": [ + "1-10", + "11-20", + ], + "type": "data_attribute", + "ui_writable": false, + "updated_at": 1719492959, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/data_attributes/{id}", + "path-parameters": { + "id": { + "docs": "The data attribute id", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "archived": { + "docs": "Whether the attribute is to be archived or not.", + "type": "optional", + }, + "description": { + "docs": "The readable description you see in the UI for the attribute.", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "options": { + "docs": "To create list attributes. Provide a set of hashes with `value` as the key of the options you want to make. `data_type` must be `string`.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateDataAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "DataAttribute", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateDataAttributeRequestDataType": { + "docs": "The type of data stored for this attribute.", + "enum": [ + "string", + "integer", + "float", + "boolean", + "datetime", + "date", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateDataAttributeRequestModel": { + "docs": "The model that the data attribute belongs to.", + "enum": [ + "contact", + "company", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttribute": { + "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "properties": { + "admin_id": { + "docs": "Teammate who created the attribute. Only applicable to CDAs", + "type": "optional", + }, + "api_writable": { + "docs": "Can this attribute be updated through API", + "type": "optional", + }, + "archived": { + "docs": "Is this attribute archived. (Only applicable to CDAs)", + "type": "optional", + }, + "created_at": { + "docs": "The time the attribute was created as a UTC Unix timestamp", + "type": "optional", + }, + "custom": { + "docs": "Set to true if this is a CDA", + "type": "optional", + }, + "data_type": { + "docs": "The data type of the attribute.", + "type": "optional", + }, + "description": { + "docs": "Readable description of the attribute.", + "type": "optional", + }, + "full_name": { + "docs": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.", + "type": "optional", + }, + "label": { + "docs": "Readable name of the attribute (i.e. name you see in the UI)", + "type": "optional", + }, + "messenger_writable": { + "docs": "Can this attribute be updated by the Messenger", + "type": "optional", + }, + "model": { + "docs": "Value is `contact` for user/lead attributes and `company` for company attributes.", + "type": "optional", + }, + "name": { + "docs": "Name of the attribute.", + "type": "optional", + }, + "options": { + "docs": "List of predefined options for attribute value.", + "type": "optional>", + }, + "type": { + "docs": "Value is `data_attribute`.", + "type": "optional>", + }, + "ui_writable": { + "docs": "Can this attribute be updated in the UI", + "type": "optional", + }, + "updated_at": { + "docs": "The time the attribute was last updated as a UTC Unix timestamp", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeDataType": { + "docs": "The data type of the attribute.", + "enum": [ + "string", + "integer", + "float", + "boolean", + "date", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataAttributeModel": { + "docs": "Value is `contact` for user/lead attributes and `company` for company attributes.", + "enum": [ + "contact", + "company", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataAttributesRequestModel": { + "enum": [ + "contact", + "company", + "conversation", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + LisDataAttributesRequestModel: + enum: + - contact + - company + - conversation + source: + openapi: ../openapi.yml + CreateDataAttributeRequestModel: + enum: + - contact + - company + docs: The model that the data attribute belongs to. + source: + openapi: ../openapi.yml + CreateDataAttributeRequestDataType: + enum: + - string + - integer + - float + - boolean + - datetime + - date + docs: The type of data stored for this attribute. + source: + openapi: ../openapi.yml + DataAttributeModel: + enum: + - contact + - company + docs: >- + Value is `contact` for user/lead attributes and `company` for company + attributes. + source: + openapi: ../openapi.yml + DataAttributeDataType: + enum: + - string + - integer + - float + - boolean + - date + docs: The data type of the attribute. + source: + openapi: ../openapi.yml + DataAttribute: + docs: >- + Data Attributes are metadata used to describe your contact, company and + conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of + attributes for your workspace, as well as create and archive custom + attributes. + properties: + type: + type: optional> + docs: Value is `data_attribute`. + id: + type: optional + docs: >- + The unique identifier for the data attribute which is given by + Intercom. Only available for custom attributes. + model: + type: optional + docs: >- + Value is `contact` for user/lead attributes and `company` for company + attributes. + name: + type: optional + docs: Name of the attribute. + full_name: + type: optional + docs: >- + Full name of the attribute. Should match the name unless it's a nested + attribute. We can split full_name on `.` to access nested user object + values. + label: + type: optional + docs: Readable name of the attribute (i.e. name you see in the UI) + description: + type: optional + docs: Readable description of the attribute. + data_type: + type: optional + docs: The data type of the attribute. + options: + type: optional> + docs: List of predefined options for attribute value. + api_writable: + type: optional + docs: Can this attribute be updated through API + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + ui_writable: + type: optional + docs: Can this attribute be updated in the UI + custom: + type: optional + docs: Set to true if this is a CDA + archived: + type: optional + docs: Is this attribute archived. (Only applicable to CDAs) + created_at: + type: optional + docs: The time the attribute was created as a UTC Unix timestamp + updated_at: + type: optional + docs: The time the attribute was last updated as a UTC Unix timestamp + admin_id: + type: optional + docs: Teammate who created the attribute. Only applicable to CDAs + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + lisDataAttributes: + path: /data_attributes + method: GET + auth: true + docs: >- + You can fetch a list of all data attributes belonging to a workspace for + contacts, companies or conversations. + source: + openapi: ../openapi.yml + display-name: List all data attributes + request: + name: LisDataAttributesRequest + query-parameters: + model: + type: optional + docs: Specify the data attribute model to return. + include_archived: + type: optional + docs: >- + Include archived attributes in the list. By default we return only + non archived data attributes. + response: + docs: Successful response + type: root.DataAttributeList + errors: + - root.UnauthorizedError + examples: + - name: Successful response + response: + body: + type: list + data: + - type: data_attribute + id: 12878 + model: company + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your site or app + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: session_count + full_name: session_count + label: Company web sessions + description: >- + All visits from anyone in a company to your product's site + or app + data_type: integer + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: name + full_name: plan.name + label: Plan + description: >- + A specific plan or level within your product that companies + have signed up to + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: size + full_name: size + label: Company size + description: >- + The number of people employed in this company, expressed as + a single number + data_type: integer + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: industry + full_name: industry + label: Company industry + description: >- + The category or domain this company belongs to e.g. + 'ecommerce' or 'SaaS' + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing site + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 34 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: >- + One ring to rule them all, one ring to find them, One ring + to bring them all and in the darkness bind them. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492954 + updated_at: 1719492954 + admin_id: '991267684' + - type: data_attribute + id: 12878 + model: company + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + - type: data_attribute + id: 12878 + model: company + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + options: + - 'true' + - 'false' + api_writable: false + messenger_writable: true + ui_writable: false + custom: false + archived: false + created_at: 1671028894 + updated_at: 1671028894 + admin_id: '5712945' + createDataAttribute: + path: /data_attributes + method: POST + auth: true + docs: You can create a data attributes for a `contact` or a `company`. + source: + openapi: ../openapi.yml + display-name: Create a data attribute + request: + name: CreateDataAttributeRequest + body: + properties: + name: + type: string + docs: The name of the data attribute. + model: + type: CreateDataAttributeRequestModel + docs: The model that the data attribute belongs to. + data_type: + type: CreateDataAttributeRequestDataType + docs: The type of data stored for this attribute. + description: + type: optional + docs: The readable description you see in the UI for the attribute. + options: + type: optional> + docs: >- + To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be + `string`. + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + content-type: application/json + response: + docs: Successful + type: DataAttribute + errors: + - root.BadRequestError + - root.UnauthorizedError + examples: + - name: Successful + request: + name: Mithril Shirt + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Same name already exists + request: + name: The One Ring + model: contact + data_type: integer + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Invalid name + request: + name: '!nv@l!d n@me' + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Attribute already exists + request: + name: The One Ring + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Invalid Data Type + request: + name: The Second Ring + model: company + data_type: string + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + - name: Too few options for list + request: + name: My Data Attribute + model: contact + data_type: string + description: Just a plain old ring + options: + - options + response: + body: + type: data_attribute + id: 37 + model: company + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + description: Whether the user is a paid subscriber. + data_type: string + options: + - 'true' + - 'false' + api_writable: true + messenger_writable: false + ui_writable: false + custom: true + archived: false + created_at: 1719492955 + updated_at: 1719492955 + admin_id: '991267686' + updateDataAttribute: + path: /data_attributes/{id} + method: PUT + auth: true + docs: > + + You can update a data attribute. + + + > 🚧 Updating the data type is not possible + + > + + > It is currently a dangerous action to execute changing a data + attribute's type via the API. You will need to update the type via the + UI instead. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The data attribute id + display-name: Update a data attribute + request: + name: UpdateDataAttributeRequest + body: + properties: + archived: + type: optional + docs: Whether the attribute is to be archived or not. + description: + type: optional + docs: The readable description you see in the UI for the attribute. + options: + type: optional> + docs: >- + To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be + `string`. + messenger_writable: + type: optional + docs: Can this attribute be updated by the Messenger + content-type: application/json + response: + docs: Successful + type: DataAttribute + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.NotFoundError + - root.UnprocessableEntityError + examples: + - name: Successful + path-parameters: + id: 1 + request: + archived: false + description: Just a plain old ring + options: + - options + - options + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Too few options in list + path-parameters: + id: 1 + request: + archived: false + description: Too few options + options: + - option1 + - option2 + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Attribute Not Found + path-parameters: + id: 1 + request: + archived: false + description: Just a plain old ring + options: + - options + - options + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + - name: Has Dependant Object + path-parameters: + id: 1 + request: + archived: true + description: Trying to archieve + response: + body: + type: data_attribute + id: 44 + model: company + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + messenger_writable: true + ui_writable: false + custom: true + archived: false + created_at: 1719492958 + updated_at: 1719492959 + admin_id: '991267693' + source: + openapi: ../openapi.yml + display-name: Data Attributes +docs: Everything about your Data Attributes +", + }, + "dataEvents.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Events", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Events", + "endpoints": { + "createDataEvent": { + "auth": true, + "display-name": "Submit a data event", + "docs": " +You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + +When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + +With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + +**NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + +| Type | Description | Example | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | +| String | The value is a JSON String | `"source":"desktop"` | +| Number | The value is a JSON Number | `"load": 3.67` | +| Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | +| Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | +| Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | +| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + +**Lead Events** + +When submitting events for Leads, you will need to specify the Lead's `id`. + +**Metadata behaviour** + +- We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. +- It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. +- There might be up to 24 hrs delay when you send a new metadata for an existing event. + +**Event de-duplication** + +The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + +Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + +### HTTP API Responses + +- Successful responses to submitted events return `202 Accepted` with an empty body. +- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. +- Events sent about users that cannot be found will return a `404 Not Found`. +- Event lists containing duplicate events will have those duplicates ignored. +- Server errors will return a `500` response code and may contain an error message in the body. + +", + "errors": [ + "root.UnauthorizedError", + ], + "method": "POST", + "pagination": undefined, + "path": "/events", + "request": { + "body": "root.CreateDataEventRequestTwo", + "content-type": "application/json", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "dataEventSummaries": { + "auth": true, + "display-name": "Create event summaries", + "docs": "Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred. + +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "request": {}, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/events/summaries", + "request": { + "body": { + "properties": { + "event_summaries": { + "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "optional", + }, + "user_id": { + "docs": "Your identifier for the user.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataEventSummariesRequest", + "query-parameters": undefined, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "lisDataEvents": { + "auth": true, + "display-name": "List all data events", + "docs": " +> 🚧 +> +> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days + +The events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`. + +- `https://api.intercom.io/events?type=user&user_id={user_id}` +- `https://api.intercom.io/events?type=user&email={email}` +- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads) + +The `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + +You can optionally define the result page size as well with the `per_page` parameter. +", + "errors": [ + "root.UnauthorizedError", + ], + "method": "GET", + "pagination": undefined, + "path": "/events", + "request": { + "name": "LisDataEventsRequest", + "query-parameters": { + "filter": "LisDataEventsRequestFilter", + "summary": { + "docs": "summary flag", + "type": "optional", + }, + "type": { + "docs": "The value must be user", + "type": "string", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.DataEventSummary", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateDataEventSummariesRequestEventSummaries": { + "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "properties": { + "count": { + "docs": "The number of times the event occurred.", + "type": "optional", + }, + "event_name": { + "docs": "The name of the event that occurred. A good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "optional", + }, + "first": { + "docs": "The first time the event was sent", + "type": "optional", + }, + "last": { + "docs": "The last time the event was sent", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataEvent": { + "docs": "Data events are used to notify Intercom of changes to your data.", + "properties": { + "created_at": { + "docs": "The time the event occurred as a UTC Unix timestamp", + "type": "integer", + }, + "email": { + "docs": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", + "type": "optional", + }, + "event_name": { + "docs": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "type": "string", + }, + "id": { + "docs": "Your identifier for a lead or a user.", + "type": "optional", + }, + "intercom_user_id": { + "docs": "The Intercom identifier for the user.", + "type": "optional", + }, + "metadata": { + "docs": "Optional metadata about the event.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object", + "type": "optional>", + }, + "user_id": { + "docs": "Your identifier for the user.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilter": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "LisDataEventsRequestFilterUserId", + }, + { + "type": "LisDataEventsRequestFilterIntercomUserId", + }, + { + "type": "LisDataEventsRequestFilterEmail", + }, + ], + }, + "LisDataEventsRequestFilterEmail": { + "docs": undefined, + "properties": { + "email": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilterIntercomUserId": { + "docs": undefined, + "properties": { + "intercom_user_id": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "LisDataEventsRequestFilterUserId": { + "docs": undefined, + "properties": { + "user_id": "string", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + LisDataEventsRequestFilterUserId: + properties: + user_id: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilterIntercomUserId: + properties: + intercom_user_id: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilterEmail: + properties: + email: string + source: + openapi: ../openapi.yml + LisDataEventsRequestFilter: + discriminated: false + union: + - type: LisDataEventsRequestFilterUserId + - type: LisDataEventsRequestFilterIntercomUserId + - type: LisDataEventsRequestFilterEmail + source: + openapi: ../openapi.yml + CreateDataEventSummariesRequestEventSummaries: + docs: >- + A list of event summaries for the user. Each event summary should contain + the event name, the time the event occurred, and the number of times the + event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: optional + docs: >- + The name of the event that occurred. A good event name is typically a + past tense 'verb-noun' combination, to improve readability, for + example `updated-plan`. + count: + type: optional + docs: The number of times the event occurred. + first: + type: optional + docs: The first time the event was sent + last: + type: optional + docs: The last time the event was sent + source: + openapi: ../openapi.yml + DataEvent: + docs: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: optional> + docs: The type of the object + event_name: + type: string + docs: >- + The name of the event that occurred. This is presented to your App's + admins when filtering and creating segments - a good event name is + typically a past tense 'verb-noun' combination, to improve + readability, for example `updated-plan`. + created_at: + type: integer + docs: The time the event occurred as a UTC Unix timestamp + user_id: + type: optional + docs: Your identifier for the user. + id: + type: optional + docs: Your identifier for a lead or a user. + intercom_user_id: + type: optional + docs: The Intercom identifier for the user. + email: + type: optional + docs: >- + An email address for your user. An email should only be used where + your application uses email to uniquely identify users. + metadata: + type: optional> + docs: Optional metadata about the event. + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + lisDataEvents: + path: /events + method: GET + auth: true + docs: > + + > 🚧 + + > + + > Please note that you can only 'list' events that are less than 90 days + old. Event counts and summaries will still include your events older + than 90 days but you cannot 'list' these events individually if they are + older than 90 days + + + The events belonging to a customer can be listed by sending a GET + request to `https://api.intercom.io/events` with a user or lead + identifier along with a `type` parameter. The identifier parameter can + be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`. + + + - `https://api.intercom.io/events?type=user&user_id={user_id}` + + - `https://api.intercom.io/events?type=user&email={email}` + + - `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this + call can be used to list leads) + + + The `email` parameter value should be [url + encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending. + + + You can optionally define the result page size as well with the + `per_page` parameter. + source: + openapi: ../openapi.yml + display-name: List all data events + request: + name: LisDataEventsRequest + query-parameters: + filter: LisDataEventsRequestFilter + type: + type: string + docs: The value must be user + summary: + type: optional + docs: summary flag + response: + docs: Successful response + type: root.DataEventSummary + errors: + - root.UnauthorizedError + createDataEvent: + path: /events + method: POST + auth: true + docs: >+ + + You will need an Access Token that has write permissions to send Events. + Once you have a key you can submit events via POST to the Events + resource, which is located at https://api.intercom.io/events, or you can + send events using one of the client libraries. When working with the + HTTP API directly a client should send the event with a `Content-Type` + of `application/json`. + + + When using the JavaScript API, [adding the code to your + app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) + makes the Events API available. Once added, you can submit an event + using the `trackEvent` method. This will associate the event with the + Lead or currently logged-in user or logged-out visitor/lead and send it + to Intercom. The final parameter is a map that can be used to send + optional metadata about the event. + + + With the Ruby client you pass a hash describing the event to + `Intercom::Event.create`, or call the `track_user` method directly on + the current user object (e.g. `user.track_event`). + + + **NB: For the JSON object types, please note that we do not currently + support nested JSON structure.** + + + | Type | + Description + | + Example + | + + | :-------------- | + :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + | + :-------------------------------------------------------------------------------- + | + + | String | The value is a JSON + String + | + `"source":"desktop"` + | + + | Number | The value is a JSON + Number + | `"load": + 3.67` + | + + | Date | The key ends with the String `_date` and the value + is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed + to be in the + [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. + | `"contact_date": + 1392036272` | + + | Link | The value is a HTTP or HTTPS + URI. + | `"article": + "https://example.org/ab1de.html"` | + + | Rich Link | The value is a JSON object that contains `url` and + `value` + keys. + | `"article": {"url": "https://example.org/ab1de.html", "value":"the + dude abides"}` | + + | Monetary Amount | The value is a JSON object that contains `amount` + and `currency` keys. The `amount` key is a positive integer representing + the amount in cents. The price in the example to the right denotes + €349.99. | `"price": {"amount": 34999, "currency": + "eur"}` | + + + **Lead Events** + + + When submitting events for Leads, you will need to specify the Lead's + `id`. + + + **Metadata behaviour** + + + - We currently limit the number of tracked metadata keys to 10 per + event. Once the quota is reached, we ignore any further keys we receive. + The first 10 metadata keys are determined by the order in which they are + sent in with the event. + + - It is not possible to change the metadata keys once the event has been + sent. A new event will need to be created with the new keys and you can + archive the old one. + + - There might be up to 24 hrs delay when you send a new metadata for an + existing event. + + + **Event de-duplication** + + + The API may detect and ignore duplicate events. Each event is uniquely + identified as a combination of the following data - the Workspace + identifier, the Contact external identifier, the Data Event name and the + Data Event created time. As a result, it is **strongly recommended** to + send a second granularity Unix timestamp in the `created_at` field. + + + Duplicated events are responded to using the normal `202 Accepted` code + - an error is not thrown, however repeat requests will be counted + against any rate limit that is in place. + + + ### HTTP API Responses + + + - Successful responses to submitted events return `202 Accepted` with an + empty body. + + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 + Forbidden` response code. + + - Events sent about users that cannot be found will return a `404 Not + Found`. + + - Event lists containing duplicate events will have those duplicates + ignored. + + - Server errors will return a `500` response code and may contain an + error message in the body. + + source: + openapi: ../openapi.yml + display-name: Submit a data event + request: + body: root.CreateDataEventRequestTwo + content-type: application/json + errors: + - root.UnauthorizedError + dataEventSummaries: + path: /events/summaries + method: POST + auth: true + docs: >+ + Create event summaries for a user. Event summaries are used to track the + number of times an event has occurred, the first time it occurred and + the last time it occurred. + + source: + openapi: ../openapi.yml + display-name: Create event summaries + request: + name: CreateDataEventSummariesRequest + body: + properties: + user_id: + type: optional + docs: Your identifier for the user. + event_summaries: + type: optional + docs: >- + A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and + the number of times the event occurred. The event name should be + a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + content-type: application/json + errors: + - root.UnauthorizedError + examples: + - request: {} + source: + openapi: ../openapi.yml + display-name: Data Events +docs: Everything about your Data Events +", + }, + "dataExport.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Data Exports", + "service": { + "auth": false, + "base-path": "", + "display-name": "Data Export", + "endpoints": { + "cancelDataExport": { + "auth": true, + "display-name": "Cancel content data export", + "docs": "You can cancel your job", + "examples": [ + { + "name": "successful", + "path-parameters": { + "job_identifier": "job_identifier", + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "canceled", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/export/cancel/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createDataExport": { + "auth": true, + "display-name": "Create content data export", + "docs": "To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`. + +The only parameters you need to provide are the range of dates that you want exported. + +>🚧 Limit of one active job +> +> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job. + +>❗️ Updated_at not included +> +> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job. + +>📘 Date ranges are inclusive +> +> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99. +", + "examples": [ + { + "name": "successful", + "request": { + "created_at_after": 1719474967, + "created_at_before": 1719492967, + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "pending", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/export/content/data", + "request": { + "body": { + "properties": { + "created_at_after": { + "docs": "The start date that you request data for. It must be formatted as a unix timestamp.", + "type": "integer", + }, + "created_at_before": { + "docs": "The end date that you request data for. It must be formatted as a unix timestamp.", + "type": "integer", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateDataExportsRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "downloadDataExport": { + "auth": true, + "display-name": "Download content data export", + "docs": "When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234. + +Your exported message data will be streamed continuously back down to you in a gzipped CSV format. + +> 📘 Octet header required +> +> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint. +", + "examples": [ + { + "path-parameters": { + "job_identifier": "job_identifier", + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/download/content/data/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getDataExport": { + "auth": true, + "display-name": "Show content data export", + "docs": "You can view the status of your job by sending a `GET` request to the URL +`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model. + +> 🚧 Jobs expire after two days +> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available. +", + "examples": [ + { + "name": "successful", + "path-parameters": { + "job_identifier": "job_identifier", + }, + "response": { + "body": { + "download_expires_at": "", + "download_url": "", + "job_identfier": "orzzsbd7hk67xyu", + "status": "pending", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/export/content/data/{job_identifier}", + "path-parameters": { + "job_identifier": { + "docs": "job_identifier", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "DataExport", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "DataExport": { + "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "properties": { + "download_expires_at": { + "docs": "The time after which you will not be able to access the data.", + "type": "optional", + }, + "download_url": { + "docs": "The location where you can download your data.", + "type": "optional", + }, + "job_identfier": { + "docs": "The identifier for your job.", + "type": "optional", + }, + "status": { + "docs": "The current state of your job.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "DataExportStatus": { + "docs": "The current state of your job.", + "enum": [ + "pending", + "in_progress", + "failed", + "completed", + "no_data", + "canceled", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "service: + auth: false + base-path: '' + endpoints: + createDataExport: + path: /export/content/data + method: POST + auth: true + docs: > + To create your export job, you need to send a `POST` request to the + export endpoint `https://api.intercom.io/export/content/data`. + + + The only parameters you need to provide are the range of dates that you + want exported. + + + >🚧 Limit of one active job + + > + + > You can only have one active job per workspace. You will receive a + HTTP status code of 429 with the message Exceeded rate limit of 1 + pending message data export jobs if you attempt to create a second + concurrent job. + + + >❗️ Updated_at not included + + > + + > It should be noted that the timeframe only includes messages sent + during the time period and not messages that were only updated during + this period. For example, if a message was updated yesterday but sent + two days ago, you would need to set the created_at_after date before the + message was sent to include that in your retrieval job. + + + >📘 Date ranges are inclusive + + > + + > Requesting data for 2018-06-01 until 2018-06-30 will get all data for + those days including those specified - e.g. 2018-06-01 00:00:00 until + 2018-06-30 23:59:99. + source: + openapi: ../openapi.yml + display-name: Create content data export + request: + name: CreateDataExportsRequest + body: + properties: + created_at_after: + type: integer + docs: >- + The start date that you request data for. It must be formatted + as a unix timestamp. + created_at_before: + type: integer + docs: >- + The end date that you request data for. It must be formatted as + a unix timestamp. + content-type: application/json + response: + docs: successful + type: DataExport + examples: + - name: successful + request: + created_at_after: 1719474967 + created_at_before: 1719492967 + response: + body: + job_identfier: orzzsbd7hk67xyu + status: pending + download_expires_at: '' + download_url: '' + getDataExport: + path: /export/content/data/{job_identifier} + method: GET + auth: true + docs: > + You can view the status of your job by sending a `GET` request to the + URL + + `https://api.intercom.io/export/content/data/{job_identifier}` - the + `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model. + + + > 🚧 Jobs expire after two days + + > All jobs that have completed processing (and are thus available to + download from the provided URL) will have an expiry limit of two days + from when the export ob completed. After this, the data will no longer + be available. + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Show content data export + response: + docs: successful + type: DataExport + examples: + - name: successful + path-parameters: + job_identifier: job_identifier + response: + body: + job_identfier: orzzsbd7hk67xyu + status: pending + download_expires_at: '' + download_url: '' + cancelDataExport: + path: /export/cancel/{job_identifier} + method: POST + auth: true + docs: You can cancel your job + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Cancel content data export + response: + docs: successful + type: DataExport + examples: + - name: successful + path-parameters: + job_identifier: job_identifier + response: + body: + job_identfier: orzzsbd7hk67xyu + status: canceled + download_expires_at: '' + download_url: '' + downloadDataExport: + path: /download/content/data/{job_identifier} + method: GET + auth: true + docs: > + When a job has a status of complete, and thus a filled download_url, you + can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234. + + + Your exported message data will be streamed continuously back down to + you in a gzipped CSV format. + + + > 📘 Octet header required + + > + + > You will have to specify the header Accept: `application/octet-stream` + when hitting this endpoint. + source: + openapi: ../openapi.yml + path-parameters: + job_identifier: + type: string + docs: job_identifier + display-name: Download content data export + examples: + - path-parameters: + job_identifier: job_identifier + source: + openapi: ../openapi.yml + display-name: Data Export +docs: Everything about your Data Exports +types: + DataExportStatus: + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + docs: The current state of your job. + source: + openapi: ../openapi.yml + DataExport: + docs: >- + The data export api is used to view all message sent & viewed in a given + timeframe. + properties: + job_identfier: + type: optional + docs: The identifier for your job. + status: + type: optional + docs: The current state of your job. + download_expires_at: + type: optional + docs: The time after which you will not be able to access the data. + download_url: + type: optional + docs: The location where you can download your data. + source: + openapi: ../openapi.yml +", + }, + "helpCenter.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Help Center", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Help Center", + "endpoints": { + "createCollection": { + "auth": true, + "display-name": "Create a collection", + "docs": "You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "collection created", + "request": { + "name": "Thanks for everything", + }, + "response": { + "body": { + "created_at": 1719492721, + "default_locale": "en", + "description": "", + "help_center_id": 81, + "icon": "book-bookmark", + "id": "165", + "name": "Thanks for everything", + "order": 1, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492721, + "url": "http://help-center.test/myapp-69/", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Bad Request", + "request": { + "description": "Missing required parameter", + "name": "collection 51", + }, + "response": { + "body": { + "created_at": 1719492721, + "default_locale": "en", + "description": "", + "help_center_id": 81, + "icon": "book-bookmark", + "id": "165", + "name": "Thanks for everything", + "order": 1, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492721, + "url": "http://help-center.test/myapp-69/", + "workspace_id": "this_is_an_id69_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/help_center/collections", + "request": { + "body": { + "properties": { + "description": { + "docs": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "type": "optional", + }, + "help_center_id": { + "docs": "The id of the help center where the collection will be created. If `null` then it will be created in the default help center.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "string", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it will be created as the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateCollectionRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "collection created", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteCollection": { + "auth": true, + "display-name": "Delete a collection", + "docs": "You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "182", + "object": "collection", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedCollectionObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listAllCollections": { + "auth": true, + "display-name": "List all collections", + "docs": "You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + +Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492720, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 79, + "icon": "bookmark", + "id": "159", + "name": "English collection title", + "order": 17, + "parent_id": "6871118", + "updated_at": 1719492720, + "url": "http://help-center.test/myapp-65/collection-17", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + }, + { + "created_at": 1719492720, + "default_locale": "en", + "description": "Default language description", + "help_center_id": 1, + "icon": "bookmark", + "id": "160", + "name": "English section title", + "order": 1, + "parent_id": "159", + "updated_at": 1719492720, + "url": "http://help-center.test/myapp-65/section-1", + "workspace_id": "this_is_an_id65_that_should_be_at_least_4", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/collections", + "response": { + "docs": "Successful", + "type": "root.Collections", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listHelpCenters": { + "auth": true, + "display-name": "List all Help Centers", + "docs": "You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Help Centers found", + "response": { + "body": { + "data": [ + { + "created_at": 1672928359, + "display_name": "Intercom Help Center", + "id": "123", + "identifier": "intercom", + "updated_at": 1672928610, + "website_turned_on": true, + "workspace_id": "hfi1bx4l", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/help_centers", + "response": { + "docs": "Help Centers found", + "type": "HelpCenterList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveCollection": { + "auth": true, + "display-name": "Retrieve a collection", + "docs": "You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Collection found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "created_at": 1719492723, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 84, + "icon": "bookmark", + "id": "170", + "name": "English collection title", + "order": 22, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492723, + "url": "http://help-center.test/myapp-75/collection-22", + "workspace_id": "this_is_an_id75_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Collection found", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveHelpCenter": { + "auth": true, + "display-name": "Retrieve a Help Center", + "docs": "You can fetch the details of a single Help Center by making a GET request to `https://api.intercom.io/help_center/help_center/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Collection found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "created_at": 1719492727, + "display_name": "Intercom Help Center", + "id": "93", + "identifier": "help-center-1", + "updated_at": 1719492727, + "website_turned_on": false, + "workspace_id": "this_is_an_id93_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/help_center/help_centers/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "Collection found", + "type": "HelpCenter", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateCollection": { + "auth": true, + "display-name": "Update a collection", + "docs": "You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/`.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "name": "Update collection name", + }, + "response": { + "body": { + "created_at": 1719492724, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 87, + "icon": "folder", + "id": "176", + "name": "Update collection name", + "order": 25, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492724, + "url": "http://help-center.test/myapp-81/collection-25", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + }, + }, + }, + { + "name": "Collection Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "name": "Update collection name", + }, + "response": { + "body": { + "created_at": 1719492724, + "default_locale": "en", + "description": "english collection description", + "help_center_id": 87, + "icon": "folder", + "id": "176", + "name": "Update collection name", + "order": 25, + "parent_id": "6871118", + "translated_content": { + "ar": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bg": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "bs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ca": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "cs": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "da": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "de": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "el": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "en": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "es": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "et": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "fr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "he": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "hu": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "id": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "it": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ja": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ko": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "lv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "mn": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nb": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "nl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "pt-BR": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ro": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "ru": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sl": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "sv": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "tr": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "type": "group_translated_content", + "vi": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-CN": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + "zh-TW": { + "description": " Collection description", + "name": "Collection name", + "type": "group_content", + }, + }, + "updated_at": 1719492724, + "url": "http://help-center.test/myapp-81/collection-25", + "workspace_id": "this_is_an_id81_that_should_be_at_least_4", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/help_center/collections/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "description": { + "docs": "The description of the collection. For multilingual collections, this will be the description of the default language's content.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it will be updated as the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateCollectionRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Collection", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Collection": { + "docs": "Collections are top level containers for Articles within the Help Center.", + "properties": { + "created_at": { + "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", + "type": "optional", + }, + "default_locale": { + "docs": "The default locale of the help center. This field is only returned for multilingual help centers.", + "type": "optional", + }, + "description": { + "docs": "The description of the collection. For multilingual help centers, this will be the description of the collection for the default language.", + "type": "optional", + }, + "help_center_id": { + "docs": "The id of the help center the collection is in.", + "type": "optional", + }, + "icon": { + "docs": "The icon of the collection.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the collection which is given by Intercom.", + "type": "optional", + }, + "name": { + "docs": "The name of the collection. For multilingual collections, this will be the name of the default language's content.", + "type": "optional", + }, + "order": { + "docs": "The order of the section in relation to others sections within a collection. Values go from `0` upwards. `0` is the default if there's no order.", + "type": "optional", + }, + "parent_id": { + "docs": "The id of the parent collection. If `null` then it is the first level collection.", + "type": "optional", + }, + "translated_content": { + "type": "optional", + }, + "updated_at": { + "docs": "The time when the article was last updated (seconds). For multilingual articles, this will be the timestamp of last update of the default language's content.", + "type": "optional", + }, + "url": { + "docs": "The URL of the collection. For multilingual help centers, this will be the URL of the collection for the default language.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the collection belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "HelpCenter": { + "docs": "Help Centers contain collections", + "properties": { + "created_at": { + "docs": "The time when the Help Center was created.", + "type": "optional", + }, + "display_name": { + "docs": "The display name of the Help Center only seen by teammates.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the Help Center which is given by Intercom.", + "type": "optional", + }, + "identifier": { + "docs": "The identifier of the Help Center. This is used in the URL of the Help Center.", + "type": "optional", + }, + "updated_at": { + "docs": "The time when the Help Center was last updated.", + "type": "optional", + }, + "website_turned_on": { + "docs": "Whether the Help Center is turned on or not. This is controlled in your Help Center settings.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the Help Center belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "HelpCenterList": { + "docs": "A list of Help Centers belonging to the App", + "properties": { + "data": { + "docs": "An array of Help Center objects", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - `list`.", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listAllCollections: + path: /help_center/collections + method: GET + auth: true + docs: > + You can fetch a list of all collections by making a GET request to + `https://api.intercom.io/help_center/collections`. + + + Collections will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll + show the most recently updated collections first. + source: + openapi: ../openapi.yml + display-name: List all collections + response: + docs: Successful + type: root.Collections + errors: + - root.UnauthorizedError + examples: + - name: Successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 1 + total_count: 2 + data: + - id: '159' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English collection title + description: english collection description + created_at: 1719492720 + updated_at: 1719492720 + url: http://help-center.test/myapp-65/collection-17 + icon: bookmark + order: 17 + default_locale: en + parent_id: '6871118' + help_center_id: 79 + - id: '160' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English section title + description: Default language description + created_at: 1719492720 + updated_at: 1719492720 + url: http://help-center.test/myapp-65/section-1 + icon: bookmark + order: 1 + default_locale: en + parent_id: '159' + help_center_id: 1 + createCollection: + path: /help_center/collections + method: POST + auth: true + docs: >- + You can create a new collection by making a POST request to + `https://api.intercom.io/help_center/collections.` + source: + openapi: ../openapi.yml + display-name: Create a collection + request: + name: CreateCollectionRequest + body: + properties: + name: + type: string + docs: >- + The name of the collection. For multilingual collections, this + will be the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual collections, + this will be the description of the default language's content. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it will be + created as the first level collection. + help_center_id: + type: optional + docs: >- + The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + content-type: application/json + response: + docs: collection created + type: Collection + errors: + - root.BadRequestError + - root.UnauthorizedError + examples: + - name: collection created + request: + name: Thanks for everything + response: + body: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + description: '' + created_at: 1719492721 + updated_at: 1719492721 + url: http://help-center.test/myapp-69/ + icon: book-bookmark + order: 1 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 81 + - name: Bad Request + request: + name: collection 51 + description: Missing required parameter + response: + body: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + description: '' + created_at: 1719492721 + updated_at: 1719492721 + url: http://help-center.test/myapp-69/ + icon: book-bookmark + order: 1 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 81 + retrieveCollection: + path: /help_center/collections/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single collection by making a GET request + to `https://api.intercom.io/help_center/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Retrieve a collection + response: + docs: Collection found + type: Collection + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Collection found + path-parameters: + id: 1 + response: + body: + id: '170' + workspace_id: this_is_an_id75_that_should_be_at_least_4 + name: English collection title + description: english collection description + created_at: 1719492723 + updated_at: 1719492723 + url: http://help-center.test/myapp-75/collection-22 + icon: bookmark + order: 22 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 84 + updateCollection: + path: /help_center/collections/{id} + method: PUT + auth: true + docs: >- + You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Update a collection + request: + name: UpdateCollectionRequest + body: + properties: + name: + type: optional + docs: >- + The name of the collection. For multilingual collections, this + will be the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual collections, + this will be the description of the default language's content. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it will be + updated as the first level collection. + content-type: application/json + response: + docs: successful + type: Collection + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + name: Update collection name + response: + body: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + description: english collection description + created_at: 1719492724 + updated_at: 1719492724 + url: http://help-center.test/myapp-81/collection-25 + icon: folder + order: 25 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 87 + - name: Collection Not Found + path-parameters: + id: 1 + request: + name: Update collection name + response: + body: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + description: english collection description + created_at: 1719492724 + updated_at: 1719492724 + url: http://help-center.test/myapp-81/collection-25 + icon: folder + order: 25 + default_locale: en + translated_content: + type: group_translated_content + ar: + type: group_content + name: Collection name + description: ' Collection description' + bg: + type: group_content + name: Collection name + description: ' Collection description' + bs: + type: group_content + name: Collection name + description: ' Collection description' + ca: + type: group_content + name: Collection name + description: ' Collection description' + cs: + type: group_content + name: Collection name + description: ' Collection description' + da: + type: group_content + name: Collection name + description: ' Collection description' + de: + type: group_content + name: Collection name + description: ' Collection description' + el: + type: group_content + name: Collection name + description: ' Collection description' + en: + type: group_content + name: Collection name + description: ' Collection description' + es: + type: group_content + name: Collection name + description: ' Collection description' + et: + type: group_content + name: Collection name + description: ' Collection description' + fi: + type: group_content + name: Collection name + description: ' Collection description' + fr: + type: group_content + name: Collection name + description: ' Collection description' + he: + type: group_content + name: Collection name + description: ' Collection description' + hr: + type: group_content + name: Collection name + description: ' Collection description' + hu: + type: group_content + name: Collection name + description: ' Collection description' + id: + type: group_content + name: Collection name + description: ' Collection description' + it: + type: group_content + name: Collection name + description: ' Collection description' + ja: + type: group_content + name: Collection name + description: ' Collection description' + ko: + type: group_content + name: Collection name + description: ' Collection description' + lt: + type: group_content + name: Collection name + description: ' Collection description' + lv: + type: group_content + name: Collection name + description: ' Collection description' + mn: + type: group_content + name: Collection name + description: ' Collection description' + nb: + type: group_content + name: Collection name + description: ' Collection description' + nl: + type: group_content + name: Collection name + description: ' Collection description' + pl: + type: group_content + name: Collection name + description: ' Collection description' + pt: + type: group_content + name: Collection name + description: ' Collection description' + ro: + type: group_content + name: Collection name + description: ' Collection description' + ru: + type: group_content + name: Collection name + description: ' Collection description' + sl: + type: group_content + name: Collection name + description: ' Collection description' + sr: + type: group_content + name: Collection name + description: ' Collection description' + sv: + type: group_content + name: Collection name + description: ' Collection description' + tr: + type: group_content + name: Collection name + description: ' Collection description' + vi: + type: group_content + name: Collection name + description: ' Collection description' + pt-BR: + type: group_content + name: Collection name + description: ' Collection description' + zh-CN: + type: group_content + name: Collection name + description: ' Collection description' + zh-TW: + type: group_content + name: Collection name + description: ' Collection description' + parent_id: '6871118' + help_center_id: 87 + deleteCollection: + path: /help_center/collections/{id} + method: DELETE + auth: true + docs: >- + You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Delete a collection + response: + docs: successful + type: root.DeletedCollectionObject + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '182' + object: collection + deleted: true + retrieveHelpCenter: + path: /help_center/help_centers/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the collection which is given by Intercom. + display-name: Retrieve a Help Center + response: + docs: Collection found + type: HelpCenter + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Collection found + path-parameters: + id: 1 + response: + body: + id: '93' + workspace_id: this_is_an_id93_that_should_be_at_least_4 + created_at: 1719492727 + updated_at: 1719492727 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + listHelpCenters: + path: /help_center/help_centers + method: GET + auth: true + docs: >- + You can list all Help Centers by making a GET request to + `https://api.intercom.io/help_center/help_centers`. + source: + openapi: ../openapi.yml + display-name: List all Help Centers + response: + docs: Help Centers found + type: HelpCenterList + errors: + - root.UnauthorizedError + examples: + - name: Help Centers found + response: + body: + type: list + data: + - id: '123' + workspace_id: hfi1bx4l + created_at: 1672928359 + updated_at: 1672928610 + identifier: intercom + website_turned_on: true + display_name: Intercom Help Center + source: + openapi: ../openapi.yml + display-name: Help Center +docs: Everything about your Help Center +types: + Collection: + docs: Collections are top level containers for Articles within the Help Center. + properties: + id: + type: optional + docs: The unique identifier for the collection which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the collection belongs to. + name: + type: optional + docs: >- + The name of the collection. For multilingual collections, this will be + the name of the default language's content. + description: + type: optional + docs: >- + The description of the collection. For multilingual help centers, this + will be the description of the collection for the default language. + created_at: + type: optional + docs: >- + The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default + language's content. + updated_at: + type: optional + docs: >- + The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default + language's content. + url: + type: optional + docs: >- + The URL of the collection. For multilingual help centers, this will be + the URL of the collection for the default language. + icon: + type: optional + docs: The icon of the collection. + order: + type: optional + docs: >- + The order of the section in relation to others sections within a + collection. Values go from `0` upwards. `0` is the default if there's + no order. + default_locale: + type: optional + docs: >- + The default locale of the help center. This field is only returned for + multilingual help centers. + translated_content: + type: optional + parent_id: + type: optional + docs: >- + The id of the parent collection. If `null` then it is the first level + collection. + help_center_id: + type: optional + docs: The id of the help center the collection is in. + source: + openapi: ../openapi.yml + HelpCenter: + docs: Help Centers contain collections + properties: + id: + type: optional + docs: The unique identifier for the Help Center which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the Help Center belongs to. + created_at: + type: optional + docs: The time when the Help Center was created. + updated_at: + type: optional + docs: The time when the Help Center was last updated. + identifier: + type: optional + docs: >- + The identifier of the Help Center. This is used in the URL of the Help + Center. + website_turned_on: + type: optional + docs: >- + Whether the Help Center is turned on or not. This is controlled in + your Help Center settings. + display_name: + type: optional + docs: The display name of the Help Center only seen by teammates. + source: + openapi: ../openapi.yml + HelpCenterList: + docs: A list of Help Centers belonging to the App + properties: + type: + type: optional> + docs: The type of the object - `list`. + data: + type: optional> + docs: An array of Help Center objects + source: + openapi: ../openapi.yml +", + }, + "messages.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your messages", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Messages", + "endpoints": { + "createMessage": { + "auth": true, + "display-name": "Create a message", + "docs": "You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email. + +> 🚧 Sending for visitors +> +> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case. + +This will return the Message model that has been created. + +> 🚧 Retrieving Associated Conversations +> +> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message. +", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.ForbiddenError", + "root.UnprocessableEntityError", + ], + "examples": [ + { + "name": "user message created", + "request": { + "body": "heyy", + "from": { + "id": "667d61698a68186f43bafe50", + "type": "user", + }, + "referer": "https://twitter.com/bob", + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "lead message created", + "request": { + "body": "heyy", + "from": { + "id": "667d616a8a68186f43bafe51", + "type": "lead", + }, + "referer": "https://twitter.com/bob", + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "477", + "created_at": 1719492971, + "id": "403918317", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "admin message created", + "request": { + "body": "heyy", + "from": { + "id": "991267716", + "type": "admin", + }, + "message_type": "conversation", + "to": { + "id": "667d616c8a68186f43bafe52", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "64619700005570", + "created_at": 1719492972, + "id": "15", + "message_type": "inapp", + "subject": "heyy", + "type": "admin_message", + }, + }, + }, + { + "name": "No body supplied for message", + "request": { + "from": { + "id": "991267718", + "type": "admin", + }, + "message_type": "inapp", + "subject": "heyy", + "to": { + "id": "667d616d8a68186f43bafe53", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "No subject supplied for email message", + "request": { + "body": "hey there", + "from": { + "id": "991267719", + "type": "admin", + }, + "message_type": "email", + "to": { + "type": "user", + "user_id": "70", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + { + "name": "No body supplied for email message", + "request": { + "from": { + "id": "991267720", + "type": "admin", + }, + "message_type": "email", + "subject": "heyy", + "to": { + "id": "667d616e8a68186f43bafe55", + "type": "user", + }, + }, + "response": { + "body": { + "body": "heyy", + "conversation_id": "476", + "created_at": 1719492969, + "id": "403918316", + "message_type": "inapp", + "subject": "Greetings", + "type": "user_message", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/messages", + "request": { + "body": "root.CreateMessageRequestOne", + "content-type": "application/json", + }, + "response": { + "docs": "admin message created", + "type": "Message", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Message": { + "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "properties": { + "body": { + "docs": "The message body, which may contain HTML.", + "type": "string", + }, + "conversation_id": { + "docs": "The associated conversation_id", + "type": "optional", + }, + "created_at": { + "docs": "The time the conversation was created.", + "type": "integer", + }, + "id": { + "docs": "The id representing the message.", + "type": "string", + }, + "message_type": { + "docs": "The type of message that was sent. Can be email, inapp, facebook or twitter.", + "type": "MessageMessageType", + }, + "subject": { + "docs": "The subject of the message. Only present if message_type: email.", + "type": "optional", + }, + "type": { + "docs": "The type of the message", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "MessageMessageType": { + "docs": "The type of message that was sent. Can be email, inapp, facebook or twitter.", + "enum": [ + "email", + "inapp", + "facebook", + "twitter", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createMessage: + path: /messages + method: POST + auth: true + docs: > + You can create a message that has been initiated by an admin. The + conversation can be either an in-app message or an email. + + + > 🚧 Sending for visitors + + > + + > There can be a short delay between when a contact is created and when + a contact becomes available to be messaged through the API. A 404 Not + Found error will be returned in this case. + + + This will return the Message model that has been created. + + + > 🚧 Retrieving Associated Conversations + + > + + > As this is a message, there will be no conversation present until the + contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message. + source: + openapi: ../openapi.yml + display-name: Create a message + request: + body: root.CreateMessageRequestOne + content-type: application/json + response: + docs: admin message created + type: Message + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.ForbiddenError + - root.UnprocessableEntityError + examples: + - name: user message created + request: + from: + type: user + id: 667d61698a68186f43bafe50 + body: heyy + referer: https://twitter.com/bob + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: lead message created + request: + from: + type: lead + id: 667d616a8a68186f43bafe51 + body: heyy + referer: https://twitter.com/bob + response: + body: + type: user_message + id: '403918317' + created_at: 1719492971 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '477' + - name: admin message created + request: + from: + type: admin + id: '991267716' + to: + type: user + id: 667d616c8a68186f43bafe52 + message_type: conversation + body: heyy + response: + body: + type: admin_message + id: '15' + created_at: 1719492972 + subject: heyy + body: heyy + message_type: inapp + conversation_id: '64619700005570' + - name: No body supplied for message + request: + from: + type: admin + id: '991267718' + to: + type: user + id: 667d616d8a68186f43bafe53 + message_type: inapp + subject: heyy + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: No subject supplied for email message + request: + from: + type: admin + id: '991267719' + to: + type: user + user_id: '70' + message_type: email + body: hey there + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + - name: No body supplied for email message + request: + from: + type: admin + id: '991267720' + to: + type: user + id: 667d616e8a68186f43bafe55 + message_type: email + subject: heyy + response: + body: + type: user_message + id: '403918316' + created_at: 1719492969 + subject: Greetings + body: heyy + message_type: inapp + conversation_id: '476' + source: + openapi: ../openapi.yml + display-name: Messages +docs: Everything about your messages +types: + MessageMessageType: + enum: + - email + - inapp + - facebook + - twitter + docs: >- + The type of message that was sent. Can be email, inapp, facebook or + twitter. + source: + openapi: ../openapi.yml + Message: + docs: >- + Message are how you reach out to contacts in Intercom. They are created + when an admin sends an outbound message to a contact. + properties: + type: + type: string + docs: The type of the message + id: + type: string + docs: The id representing the message. + created_at: + type: integer + docs: The time the conversation was created. + subject: + type: optional + docs: 'The subject of the message. Only present if message_type: email.' + body: + type: string + docs: The message body, which may contain HTML. + message_type: + type: MessageMessageType + docs: >- + The type of message that was sent. Can be email, inapp, facebook or + twitter. + conversation_id: + type: optional + docs: The associated conversation_id + source: + openapi: ../openapi.yml +", + }, + "news.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your News", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "News", + "endpoints": { + "createNewsItem": { + "auth": true, + "display-name": "Create a news item", + "docs": "You can create a news item", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "body": "

New costumes in store for this spooky season

", + "deliver_silently": true, + "labels": [ + "Product", + "Update", + "New", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214, + }, + ], + "reactions": [ + "😆", + "😅", + ], + "sender_id": 991267734, + "state": "live", + "title": "Halloween is here!", + }, + "response": { + "body": { + "body": "

New costumes in store for this spooky season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492978, + "deliver_silently": true, + "id": "33", + "labels": [ + "New", + "Product", + "Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 53, + "published_at": 1664638214, + }, + ], + "reactions": [ + "😆", + "😅", + ], + "sender_id": 991267734, + "state": "live", + "title": "Halloween is here!", + "updated_at": 1719492978, + "workspace_id": "this_is_an_id498_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/news/news_items", + "request": { + "body": { + "type": "root.NewsItemRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteNewsItem": { + "auth": true, + "display-name": "Delete a news item", + "docs": "You can delete a single news item.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "deleted": true, + "id": "40", + "object": "news-item", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "root.DeletedObject", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listLiveNewsfeedItems": { + "auth": true, + "display-name": "List all live newsfeed items", + "docs": "You can fetch a list of all news items that are live on a given newsfeed", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "data": [ + { + "created_at": 1674917488, + "id": "12312", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1674917488, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 20, + "total_pages": 0, + "type": "pages", + }, + "total_count": 0, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds/{id}/items", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news feed item which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNewsItems": { + "auth": true, + "display-name": "List all news items", + "docs": "You can fetch a list of all news items", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492976, + "id": "29", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1719492976, + }, + { + "created_at": 1719492976, + "id": "30", + "name": "My Newsfeed", + "type": "newsfeed", + "updated_at": 1719492976, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/news_items", + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNewsfeeds": { + "auth": true, + "display-name": "List all newsfeeds", + "docs": "You can fetch a list of all newsfeeds", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "created_at": 1719492987, + "id": "68", + "name": "Visitor Feed", + "type": "newsfeed", + "updated_at": 1719492987, + }, + { + "created_at": 1719492987, + "id": "69", + "name": "Visitor Feed", + "type": "newsfeed", + "updated_at": 1719492987, + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 10, + "total_pages": 1, + "type": "pages", + }, + "total_count": 2, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds", + "response": { + "docs": "successful", + "type": "root.PaginatedResponse", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNewsItem": { + "auth": true, + "display-name": "Retrieve a news item", + "docs": "You can fetch the details of a single news item.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "body": "

Hello there,

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492979, + "deliver_silently": false, + "id": "34", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 55, + "published_at": 1719492980, + }, + ], + "reactions": [ + "👍", + "👍", + "👍", + "👍", + ], + "sender_id": 991267737, + "state": "live", + "title": "We have news", + "updated_at": 1719492979, + "workspace_id": "this_is_an_id502_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNewsfeed": { + "auth": true, + "display-name": "Retrieve a newsfeed", + "docs": "You can fetch the details of a single newsfeed", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "created_at": 1719492988, + "id": "72", + "name": "Visitor Feed", + "updated_at": 1719492988, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/news/newsfeeds/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news feed item which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Newsfeed", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateNewsItem": { + "auth": true, + "display-name": "Update a news item", + "docs": undefined, + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "title": "Christmas is here!", + }, + "response": { + "body": { + "body": "

New gifts in store for the jolly season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492982, + "deliver_silently": false, + "id": "37", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 198313, + "published_at": 1674917488, + }, + ], + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "state": "live", + "title": "Christmas is here!", + "updated_at": 1719492982, + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + }, + }, + }, + { + "name": "News Item Not Found", + "path-parameters": { + "id": 1, + }, + "request": { + "body": "

New gifts in store for the jolly season

", + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267748, + "title": "Christmas is here!", + }, + "response": { + "body": { + "body": "

New gifts in store for the jolly season

", + "cover_image_url": "https://example.com/cover.jpg", + "created_at": 1719492982, + "deliver_silently": false, + "id": "37", + "labels": [ + "Product Update", + ], + "newsfeed_assignments": [ + { + "newsfeed_id": 198313, + "published_at": 1674917488, + }, + ], + "reactions": [ + "😝", + "😂", + ], + "sender_id": 991267745, + "state": "live", + "title": "Christmas is here!", + "updated_at": 1719492982, + "workspace_id": "this_is_an_id508_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/news/news_items/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "integer", + }, + }, + "request": { + "body": { + "type": "root.NewsItemRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "NewsItem", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "NewsItem": { + "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "properties": { + "body": { + "docs": "The news item body, which may contain HTML.", + "type": "optional", + }, + "cover_image_url": { + "docs": "URL of the image used as cover. Must have .jpg or .png extension.", + "type": "optional", + "validation": { + "format": "uri", + "maxLength": undefined, + "minLength": undefined, + "pattern": undefined, + }, + }, + "created_at": { + "docs": "Timestamp for when the news item was created.", + "type": "optional", + }, + "deliver_silently": { + "docs": "When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the news item which is given by Intercom.", + "type": "optional", + }, + "labels": { + "docs": "Label names displayed to users to categorize the news item.", + "type": "optional>>", + }, + "newsfeed_assignments": { + "docs": "A list of newsfeed_assignments to assign to the specified newsfeed.", + "type": "optional>", + }, + "reactions": { + "docs": "Ordered list of emoji reactions to the news item. When empty, reactions are disabled.", + "type": "optional>>", + }, + "sender_id": { + "docs": "The id of the sender of the news item. Must be a teammate on the workspace.", + "type": "optional", + }, + "state": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "type": "optional", + }, + "title": { + "docs": "The title of the news item.", + "type": "optional", + }, + "updated_at": { + "docs": "Timestamp for when the news item was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace which the news item belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsItemState": { + "docs": "News items will not be visible to your users in the assigned newsfeeds until they are set live.", + "enum": [ + "draft", + "live", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "Newsfeed": { + "docs": "A newsfeed is a collection of news items, targeted to a specific audience. + +Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. +", + "properties": { + "created_at": { + "docs": "Timestamp for when the newsfeed was created.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the newsfeed which is given by Intercom.", + "type": "optional", + }, + "name": { + "docs": "The name of the newsfeed. This name will never be visible to your users.", + "type": "optional", + }, + "updated_at": { + "docs": "Timestamp for when the newsfeed was last updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NewsfeedAssignment": { + "docs": "Assigns a news item to a newsfeed.", + "properties": { + "newsfeed_id": { + "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", + "type": "optional", + }, + "published_at": { + "docs": "Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft".", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listNewsItems: + path: /news/news_items + method: GET + auth: true + docs: You can fetch a list of all news items + source: + openapi: ../openapi.yml + display-name: List all news items + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + total_count: 2 + data: + - type: newsfeed + id: '29' + name: My Newsfeed + created_at: 1719492976 + updated_at: 1719492976 + - type: newsfeed + id: '30' + name: My Newsfeed + created_at: 1719492976 + updated_at: 1719492976 + createNewsItem: + path: /news/news_items + method: POST + auth: true + docs: You can create a news item + source: + openapi: ../openapi.yml + display-name: Create a news item + request: + body: + type: root.NewsItemRequest + content-type: application/json + response: + docs: successful + type: NewsItem + errors: + - root.UnauthorizedError + examples: + - name: successful + request: + title: Halloween is here! + body:

New costumes in store for this spooky season

+ sender_id: 991267734 + state: live + deliver_silently: true + labels: + - Product + - Update + - New + reactions: + - 😆 + - 😅 + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + response: + body: + id: '33' + workspace_id: this_is_an_id498_that_should_be_at_least_ + title: Halloween is here! + body:

New costumes in store for this spooky season

+ sender_id: 991267734 + state: live + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + labels: + - New + - Product + - Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😆 + - 😅 + deliver_silently: true + created_at: 1719492978 + updated_at: 1719492978 + retrieveNewsItem: + path: /news/news_items/{id} + method: GET + auth: true + docs: You can fetch the details of a single news item. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Retrieve a news item + response: + docs: successful + type: NewsItem + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '34' + workspace_id: this_is_an_id502_that_should_be_at_least_ + title: We have news + body:

Hello there,

+ sender_id: 991267737 + state: live + newsfeed_assignments: + - newsfeed_id: 55 + published_at: 1719492980 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 👍 + - 👍 + - 👍 + - 👍 + deliver_silently: false + created_at: 1719492979 + updated_at: 1719492979 + updateNewsItem: + path: /news/news_items/{id} + method: PUT + auth: true + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Update a news item + request: + body: + type: root.NewsItemRequest + content-type: application/json + response: + docs: successful + type: NewsItem + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + reactions: + - 😝 + - 😂 + response: + body: + id: '37' + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + state: live + newsfeed_assignments: + - newsfeed_id: 198313 + published_at: 1674917488 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😝 + - 😂 + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + - name: News Item Not Found + path-parameters: + id: 1 + request: + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267748 + reactions: + - 😝 + - 😂 + response: + body: + id: '37' + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body:

New gifts in store for the jolly season

+ sender_id: 991267745 + state: live + newsfeed_assignments: + - newsfeed_id: 198313 + published_at: 1674917488 + labels: + - Product Update + cover_image_url: https://example.com/cover.jpg + reactions: + - 😝 + - 😂 + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + deleteNewsItem: + path: /news/news_items/{id} + method: DELETE + auth: true + docs: You can delete a single news item. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier for the news item which is given by Intercom. + display-name: Delete a news item + response: + docs: successful + type: root.DeletedObject + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: 1 + response: + body: + id: '40' + object: news-item + deleted: true + listLiveNewsfeedItems: + path: /news/newsfeeds/{id}/items + method: GET + auth: true + docs: You can fetch a list of all news items that are live on a given newsfeed + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the news feed item which is given by + Intercom. + display-name: List all live newsfeed items + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.UnauthorizedError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 20 + total_pages: 0 + total_count: 0 + data: + - type: newsfeed + id: '12312' + name: My Newsfeed + created_at: 1674917488 + updated_at: 1674917488 + listNewsfeeds: + path: /news/newsfeeds + method: GET + auth: true + docs: You can fetch a list of all newsfeeds + source: + openapi: ../openapi.yml + display-name: List all newsfeeds + response: + docs: successful + type: root.PaginatedResponse + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 10 + total_pages: 1 + total_count: 2 + data: + - type: newsfeed + id: '68' + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + - type: newsfeed + id: '69' + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + retrieveNewsfeed: + path: /news/newsfeeds/{id} + method: GET + auth: true + docs: You can fetch the details of a single newsfeed + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the news feed item which is given by + Intercom. + display-name: Retrieve a newsfeed + response: + docs: successful + type: Newsfeed + errors: + - root.UnauthorizedError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + id: '72' + name: Visitor Feed + created_at: 1719492988 + updated_at: 1719492988 + source: + openapi: ../openapi.yml + display-name: News +docs: Everything about your News +types: + NewsItemState: + enum: + - draft + - live + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + source: + openapi: ../openapi.yml + NewsItem: + docs: >- + A News Item is a content type in Intercom enabling you to announce product + updates, company news, promotions, events and more with your customers. + properties: + id: + type: optional + docs: The unique identifier for the news item which is given by Intercom. + workspace_id: + type: optional + docs: The id of the workspace which the news item belongs to. + title: + type: optional + docs: The title of the news item. + body: + type: optional + docs: The news item body, which may contain HTML. + sender_id: + type: optional + docs: >- + The id of the sender of the news item. Must be a teammate on the + workspace. + state: + type: optional + docs: >- + News items will not be visible to your users in the assigned newsfeeds + until they are set live. + newsfeed_assignments: + type: optional> + docs: A list of newsfeed_assignments to assign to the specified newsfeed. + labels: + type: optional>> + docs: Label names displayed to users to categorize the news item. + cover_image_url: + type: optional + docs: URL of the image used as cover. Must have .jpg or .png extension. + validation: + format: uri + reactions: + type: optional>> + docs: >- + Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + deliver_silently: + type: optional + docs: >- + When set to true, the news item will appear in the messenger newsfeed + without showing a notification badge. + created_at: + type: optional + docs: Timestamp for when the news item was created. + updated_at: + type: optional + docs: Timestamp for when the news item was last updated. + source: + openapi: ../openapi.yml + Newsfeed: + docs: > + A newsfeed is a collection of news items, targeted to a specific audience. + + + Newsfeeds currently cannot be edited through the API, please refer to + [this + article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) + to set up your newsfeeds in Intercom. + properties: + id: + type: optional + docs: The unique identifier for the newsfeed which is given by Intercom. + name: + type: optional + docs: >- + The name of the newsfeed. This name will never be visible to your + users. + created_at: + type: optional + docs: Timestamp for when the newsfeed was created. + updated_at: + type: optional + docs: Timestamp for when the newsfeed was last updated. + source: + openapi: ../openapi.yml + NewsfeedAssignment: + docs: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: optional + docs: >- + The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + published_at: + type: optional + docs: >- + Publish date of the news item on the newsfeed, use this field if you + want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item + state is "draft". + source: + openapi: ../openapi.yml +", + }, + "notes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Notes", + "imports": { + "admins": "admins.yml", + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Notes", + "endpoints": { + "createNote": { + "auth": true, + "display-name": "Create a note", + "docs": "You can add a note to a single contact.", + "errors": [ + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "667d60978a68186f43bafd9e", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "667d60988a68186f43bafd9f", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "id": 1, + }, + "request": { + "admin_id": "123", + "body": "Hello", + "contact_id": "123", + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin103@email.com", + "has_inbox_seat": true, + "id": "991267493", + "job_title": "Philosopher", + "name": "Ciaran103 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

Hello

", + "contact": { + "id": "667d60978a68186f43bafd9e", + "type": "contact", + }, + "created_at": 1719492759, + "id": "34", + "type": "note", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{id}/notes", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given contact.", + "type": "integer", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier of a given admin.", + "type": "optional", + }, + "body": { + "docs": "The text of the note.", + "type": "string", + }, + "contact_id": { + "docs": "The unique identifier of a given contact.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateNoteRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "Note", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listNotes": { + "auth": true, + "display-name": "List all notes", + "docs": "You can fetch a list of notes that are associated to a contact.", + "errors": [ + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "data": [ + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718887958, + "id": "29", + "type": "note", + }, + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718801558, + "id": "28", + "type": "note", + }, + { + "author": { + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin101@email.com", + "has_inbox_seat": true, + "id": "991267491", + "job_title": "Philosopher", + "name": "Ciaran101 Lee", + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d60968a68186f43bafd9c", + "type": "contact", + }, + "created_at": 1718801558, + "id": "27", + "type": "note", + }, + ], + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 50, + "total_pages": 1, + "type": "pages", + }, + "total_count": 3, + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/contacts/{id}/notes", + "path-parameters": { + "id": { + "docs": "The unique identifier of a contact.", + "type": "integer", + }, + }, + "response": { + "docs": "Successful response", + "type": "root.NoteList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveNote": { + "auth": true, + "display-name": "Retrieve a note", + "docs": "You can fetch the details of a single note.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Note found", + "path-parameters": { + "id": 1, + }, + "response": { + "body": { + "author": { + "avatar": "https://picsum.photos/200/300", + "away_mode_enabled": false, + "away_mode_reassign": false, + "email": "admin316@email.com", + "has_inbox_seat": true, + "id": "991267764", + "job_title": "Philosopher", + "name": "Ciaran316 Lee", + "team_ids": [ + 814865, + ], + "team_priority_level": { + "primary_team_ids": [ + 814865, + ], + "secondary_team_ids": [ + 493881, + ], + }, + "type": "admin", + }, + "body": "

This is a note.

", + "contact": { + "id": "667d617d8a68186f43bafe58", + "type": "contact", + }, + "created_at": 1718801789, + "id": "37", + "type": "note", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/notes/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given note", + "type": "integer", + }, + }, + "response": { + "docs": "Note found", + "type": "Note", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Note": { + "docs": "Notes allow you to annotate and comment on your contacts.", + "properties": { + "author": { + "docs": "Optional. Represents the Admin that created the note.", + "type": "optional", + }, + "body": { + "docs": "The body text of the note.", + "type": "optional", + }, + "contact": { + "docs": "Represents the contact that the note was created about.", + "type": "optional", + }, + "created_at": { + "docs": "The time the note was created.", + "type": "optional", + }, + "id": { + "docs": "The id of the note.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `note`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "NoteContact": { + "docs": "Represents the contact that the note was created about.", + "properties": { + "id": { + "docs": "The id of the contact.", + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `contact`.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + admins: admins.yml +service: + auth: false + base-path: '' + endpoints: + listNotes: + path: /contacts/{id}/notes + method: GET + auth: true + docs: You can fetch a list of notes that are associated to a contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a contact. + display-name: List all notes + response: + docs: Successful response + type: root.NoteList + errors: + - root.NotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + response: + body: + type: list + data: + - type: note + id: '29' + created_at: 1718887958 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ - type: note + id: '28' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ - type: note + id: '27' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + body:

This is a note.

+ total_count: 3 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 50 + total_pages: 1 + createNote: + path: /contacts/{id}/notes + method: POST + auth: true + docs: You can add a note to a single contact. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given contact. + display-name: Create a note + request: + name: CreateNoteRequest + body: + properties: + body: + type: string + docs: The text of the note. + contact_id: + type: optional + docs: The unique identifier of a given contact. + admin_id: + type: optional + docs: The unique identifier of a given admin. + content-type: application/json + response: + docs: Successful response + type: Note + errors: + - root.NotFoundError + examples: + - name: Successful response + path-parameters: + id: 1 + request: + body: Hello + contact_id: 667d60978a68186f43bafd9e + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ - name: Admin not found + path-parameters: + id: 1 + request: + body: Hello + contact_id: 667d60988a68186f43bafd9f + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ - name: Contact not found + path-parameters: + id: 1 + request: + body: Hello + contact_id: '123' + admin_id: '123' + response: + body: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

Hello

+ retrieveNote: + path: /notes/{id} + method: GET + auth: true + docs: You can fetch the details of a single note. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: integer + docs: The unique identifier of a given note + display-name: Retrieve a note + response: + docs: Note found + type: Note + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Note found + path-parameters: + id: 1 + response: + body: + type: note + id: '37' + created_at: 1718801789 + contact: + type: contact + id: 667d617d8a68186f43bafe58 + author: + type: admin + id: '991267764' + name: Ciaran316 Lee + email: admin316@email.com + job_title: Philosopher + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: + - 814865 + avatar: https://picsum.photos/200/300 + team_priority_level: + primary_team_ids: + - 814865 + secondary_team_ids: + - 493881 + body:

This is a note.

+ source: + openapi: ../openapi.yml + display-name: Notes +docs: Everything about your Notes +types: + NoteContact: + docs: Represents the contact that the note was created about. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `contact`. + id: + type: optional + docs: The id of the contact. + source: + openapi: ../openapi.yml + Note: + docs: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: optional + docs: String representing the object's type. Always has the value `note`. + id: + type: optional + docs: The id of the note. + created_at: + type: optional + docs: The time the note was created. + contact: + type: optional + docs: Represents the contact that the note was created about. + author: + type: optional + docs: Optional. Represents the Admin that created the note. + body: + type: optional + docs: The body text of the note. + source: + openapi: ../openapi.yml +", + }, + "segments.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Segments", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Segments", + "endpoints": { + "listSegments": { + "auth": true, + "display-name": "List all segments", + "docs": "You can fetch a list of all segments.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "response": { + "body": { + "pages": { + "key": "value", + }, + "segments": [ + { + "count": 3, + "created_at": 1719492991, + "id": "667d617f8a68186f43bafe5b", + "name": "John segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492991, + }, + { + "count": 3, + "created_at": 1719492991, + "id": "667d617f8a68186f43bafe5c", + "name": "Jane segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492991, + }, + ], + "type": "segment.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/segments", + "request": { + "name": "ListSegmentsRequest", + "query-parameters": { + "include_count": { + "docs": "It includes the count of contacts that belong to each segment.", + "type": "optional", + }, + }, + }, + "response": { + "docs": "Successful response", + "type": "root.SegmentList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveSegment": { + "auth": true, + "display-name": "Retrieve a segment", + "docs": "You can fetch the details of a single segment.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "count": 3, + "created_at": 1719492992, + "id": "667d61808a68186f43bafe5f", + "name": "John segment", + "person_type": "user", + "type": "segment", + "updated_at": 1719492992, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/segments/{id}", + "path-parameters": { + "id": { + "docs": "The unique identified of a given segment.", + "type": "string", + }, + }, + "response": { + "docs": "Successful response", + "type": "Segment", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Segment": { + "docs": "A segment is a group of your contacts defined by the rules that you set.", + "properties": { + "count": { + "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", + "type": "optional", + }, + "created_at": { + "docs": "The time the segment was created.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier representing the segment.", + "type": "optional", + }, + "name": { + "docs": "The name of the segment.", + "type": "optional", + }, + "person_type": { + "docs": "Type of the contact: contact (lead) or user.", + "type": "optional", + }, + "type": { + "docs": "The type of object.", + "type": "optional>", + }, + "updated_at": { + "docs": "The time the segment was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SegmentPersonType": { + "docs": "Type of the contact: contact (lead) or user.", + "enum": [ + "contact", + "user", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listSegments: + path: /segments + method: GET + auth: true + docs: You can fetch a list of all segments. + source: + openapi: ../openapi.yml + display-name: List all segments + request: + name: ListSegmentsRequest + query-parameters: + include_count: + type: optional + docs: It includes the count of contacts that belong to each segment. + response: + docs: Successful response + type: root.SegmentList + errors: + - root.UnauthorizedError + examples: + - name: Successful response + response: + body: + type: segment.list + segments: + - type: segment + id: 667d617f8a68186f43bafe5b + name: John segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + count: 3 + - type: segment + id: 667d617f8a68186f43bafe5c + name: Jane segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + count: 3 + pages: + key: value + retrieveSegment: + path: /segments/{id} + method: GET + auth: true + docs: You can fetch the details of a single segment. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identified of a given segment. + display-name: Retrieve a segment + response: + docs: Successful response + type: Segment + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful response + path-parameters: + id: '123' + response: + body: + type: segment + id: 667d61808a68186f43bafe5f + name: John segment + created_at: 1719492992 + updated_at: 1719492992 + person_type: user + count: 3 + source: + openapi: ../openapi.yml + display-name: Segments +docs: Everything about your Segments +types: + SegmentPersonType: + enum: + - contact + - user + docs: 'Type of the contact: contact (lead) or user.' + source: + openapi: ../openapi.yml + Segment: + docs: A segment is a group of your contacts defined by the rules that you set. + properties: + type: + type: optional> + docs: The type of object. + id: + type: optional + docs: The unique identifier representing the segment. + name: + type: optional + docs: The name of the segment. + created_at: + type: optional + docs: The time the segment was created. + updated_at: + type: optional + docs: The time the segment was updated. + person_type: + type: optional + docs: 'Type of the contact: contact (lead) or user.' + count: + type: optional + docs: >- + The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + source: + openapi: ../openapi.yml +", + }, + "subscriptionTypes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about subscription types", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Subscription Types", + "endpoints": { + "attachSubscriptionTypeToContact": { + "auth": true, + "display-name": "Add subscription to a contact", + "docs": "You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + +This will return a subscription type model for the subscription type that was added to the contact. +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + { + "name": "Resource not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "consent_type": "opt_in", + "id": "invalid_id", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "108", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "consent_type": { + "docs": "The consent_type of a subscription, opt_out or opt_in.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the subscription which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachSubscriptionTypeToContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful", + "type": "SubscriptionType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachSubscriptionTypeToContact": { + "auth": true, + "display-name": "Remove subscription from a contact", + "docs": "You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "37846", + }, + "response": { + "body": { + "consent_type": "opt_in", + "content_types": [ + "sms_message", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "124", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/subscriptions/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the subscription type which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "Successful", + "type": "SubscriptionType", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listSubscriptionTypes": { + "auth": true, + "display-name": "List subscription types", + "docs": "You can list all subscription types. A list of subscription type objects will be returned.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful", + "response": { + "body": { + "data": [ + { + "consent_type": "opt_out", + "content_types": [ + "email", + ], + "default_translation": { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + "id": "137", + "state": "live", + "translations": [ + { + "description": "Lorem ipsum dolor sit amet", + "locale": "en", + "name": "Newsletters", + }, + ], + "type": "subscription", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/subscription_types", + "response": { + "docs": "Successful", + "type": "root.SubscriptionTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "SubscriptionType": { + "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "properties": { + "consent_type": { + "docs": "Describes the type of consent.", + "type": "optional", + }, + "content_types": { + "docs": "The message types that this subscription supports - can contain `email` or `sms_message`.", + "type": "optional>", + }, + "default_translation": { + "type": "optional", + }, + "id": { + "docs": "The unique identifier representing the subscription type.", + "type": "optional", + }, + "state": { + "docs": "The state of the subscription type.", + "type": "optional", + }, + "translations": { + "docs": "An array of translations objects with the localised version of the subscription type in each available locale within your translation settings.", + "type": "optional>", + }, + "type": { + "docs": "The type of the object - subscription", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeConsentType": { + "docs": "Describes the type of consent.", + "enum": [ + "opt_out", + "opt_in", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeContentTypesItem": { + "enum": [ + "email", + "sms_message", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "SubscriptionTypeState": { + "docs": "The state of the subscription type.", + "enum": [ + "live", + "draft", + "archived", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + attachSubscriptionTypeToContact: + path: /contacts/{contact_id}/subscriptions + method: POST + auth: true + docs: > + You can add a specific subscription to a contact. In Intercom, we have + two different subscription types based on user consent - opt-out and + opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type + that was added to the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Add subscription to a contact + request: + name: AttachSubscriptionTypeToContactRequest + body: + properties: + id: + type: string + docs: >- + The unique identifier for the subscription which is given by + Intercom + consent_type: + type: string + docs: The consent_type of a subscription, opt_out or opt_in. + content-type: application/json + response: + docs: Successful + type: SubscriptionType + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '37846' + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + - name: Contact not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '37846' + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + - name: Resource not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: invalid_id + consent_type: opt_in + response: + body: + type: subscription + id: '108' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + detachSubscriptionTypeToContact: + path: /contacts/{contact_id}/subscriptions/{id} + method: DELETE + auth: true + docs: >- + You can remove a specific subscription from a contact. This will return + a subscription type model for the subscription type that was removed + from the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: >- + The unique identifier for the subscription type which is given by + Intercom + display-name: Remove subscription from a contact + response: + docs: Successful + type: SubscriptionType + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + id: '37846' + response: + body: + type: subscription + id: '124' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_in + content_types: + - sms_message + listSubscriptionTypes: + path: /subscription_types + method: GET + auth: true + docs: >- + You can list all subscription types. A list of subscription type objects + will be returned. + source: + openapi: ../openapi.yml + display-name: List subscription types + response: + docs: Successful + type: root.SubscriptionTypeList + errors: + - root.UnauthorizedError + examples: + - name: Successful + response: + body: + type: list + data: + - type: subscription + id: '137' + state: live + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + consent_type: opt_out + content_types: + - email + source: + openapi: ../openapi.yml + display-name: Subscription Types +docs: Everything about subscription types +types: + SubscriptionTypeState: + enum: + - live + - draft + - archived + docs: The state of the subscription type. + source: + openapi: ../openapi.yml + SubscriptionTypeConsentType: + enum: + - opt_out + - opt_in + docs: Describes the type of consent. + source: + openapi: ../openapi.yml + SubscriptionTypeContentTypesItem: + enum: + - email + - sms_message + source: + openapi: ../openapi.yml + SubscriptionType: + docs: >- + A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: optional + docs: The type of the object - subscription + id: + type: optional + docs: The unique identifier representing the subscription type. + state: + type: optional + docs: The state of the subscription type. + default_translation: + type: optional + translations: + type: optional> + docs: >- + An array of translations objects with the localised version of the + subscription type in each available locale within your translation + settings. + consent_type: + type: optional + docs: Describes the type of consent. + content_types: + type: optional> + docs: >- + The message types that this subscription supports - can contain + `email` or `sms_message`. + source: + openapi: ../openapi.yml +", + }, + "switch.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about Switch", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Switch", + "endpoints": { + "createPhoneSwitch": { + "auth": true, + "display-name": "Create a phone Switch", + "docs": "You can use the API to deflect phone calls to the Intercom Messenger. +Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + +If custom attributes are specified, they will be added to the user or lead's custom data attributes. +", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.UnprocessableEntityError", + ], + "examples": [ + { + "name": "successful", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "bad request - exception sending sms", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "bad request - invalid number", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+353832345678", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + { + "name": "unprocessable entity", + "request": { + "custom_attributes": { + "issue_type": "Billing", + "priority": "High", + }, + "phone": "+40241100100", + }, + "response": { + "body": { + "phone": "+1 1234567890", + "type": "phone_call_redirect", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/phone_call_redirects", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createPhoneSwitch: + path: /phone_call_redirects + method: POST + auth: true + docs: > + You can use the API to deflect phone calls to the Intercom Messenger. + + Calling this endpoint will send an SMS with a link to the Messenger to + the phone number specified. + + + If custom attributes are specified, they will be added to the user or + lead's custom data attributes. + source: + openapi: ../openapi.yml + display-name: Create a phone Switch + request: + body: + type: optional + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.UnprocessableEntityError + examples: + - name: successful + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: bad request - exception sending sms + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: bad request - invalid number + request: + phone: '+353832345678' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + - name: unprocessable entity + request: + phone: '+40241100100' + custom_attributes: + issue_type: Billing + priority: High + response: + body: + type: phone_call_redirect + phone: +1 1234567890 + source: + openapi: ../openapi.yml + display-name: Switch +docs: Everything about Switch +", + }, + "tags.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about tags", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Tags", + "endpoints": { + "attachTagToContact": { + "auth": true, + "display-name": "Add tag to a contact", + "docs": "You can tag a specific contact. This will return a tag object for the tag that was added to the contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Contact not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + }, + "request": { + "id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "94", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToContactRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachTagToConversation": { + "auth": true, + "display-name": "Add tag to a conversation", + "docs": "You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "conversation_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "99", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "conversation_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "99", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/conversations/{conversation_id}/tags", + "path-parameters": { + "conversation_id": { + "docs": "conversation_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "attachTagToTicket": { + "auth": true, + "display-name": "Add tag to a ticket", + "docs": "You can tag a specific ticket. This will return a tag object for the tag that was added to the ticket.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "134", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Ticket not found", + "path-parameters": { + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "780", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "134", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/{ticket_id}/tags", + "path-parameters": { + "ticket_id": { + "docs": "ticket_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "AttachTagToTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "createTag": { + "auth": true, + "display-name": "Create or update a tag, Tag or untag companies, Tag contacts", + "docs": "You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + +Each operation will return a tag object. +", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Action successful", + "request": { + "name": "test", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "Invalid parameters", + "request": { + "name": "Independent", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "Company not found", + "request": { + "companies": [ + { + "company_id": "123", + }, + ], + "name": "test", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + { + "name": "User not found", + "request": { + "name": "test", + "users": [ + { + "id": "123", + }, + ], + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "118", + "name": "test", + "type": "tag", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tags", + "request": { + "body": "CreateTagRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Action successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "deleteTag": { + "auth": true, + "display-name": "Delete tag", + "docs": "You can delete the details of tags that are on the workspace by passing in the id.", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "path-parameters": { + "id": "123", + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given tag", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromContact": { + "auth": true, + "display-name": "Remove tag from a contact", + "docs": "You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "contact_id": "63a07ddf05a32042dffac965", + "id": "7522907", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "97", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/contacts/{contact_id}/tags/{id}", + "path-parameters": { + "contact_id": { + "docs": "The unique identifier for the contact which is given by Intercom", + "type": "string", + }, + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromConversation": { + "auth": true, + "display-name": "Remove tag from a conversation", + "docs": "You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Conversation not found", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "conversation_id": "64619700005694", + "id": "7522907", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "102", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/conversations/{conversation_id}/tags/{id}", + "path-parameters": { + "conversation_id": { + "docs": "conversation_id", + "type": "string", + }, + "id": { + "docs": "id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachTagFromConversationRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "detachTagFromTicket": { + "auth": true, + "display-name": "Remove tag from a ticket", + "docs": "You can remove tag from a specific ticket. This will return a tag object for the tag that was removed from the ticket.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Ticket not found", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + { + "name": "Tag not found", + "path-parameters": { + "id": "7522907", + "ticket_id": "64619700005694", + }, + "request": { + "admin_id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "137", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "DELETE", + "pagination": undefined, + "path": "/tickets/{ticket_id}/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the tag which is given by Intercom", + "type": "string", + }, + "ticket_id": { + "docs": "ticket_id", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "admin_id": { + "docs": "The unique identifier for the admin which is given by Intercom.", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "DetachTagFromTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "findTag": { + "auth": true, + "display-name": "Find a specific tag", + "docs": "You can fetch the details of tags that are on the workspace by their id. +This will return a tag object. +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Tag found", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "applied_at": 1663597223, + "applied_by": { + "id": "1a2b3c", + "type": "contact", + }, + "id": "126", + "name": "Manual tag", + "type": "tag", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tags/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given tag", + "type": "string", + }, + }, + "response": { + "docs": "Tag found", + "type": "Tag", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTags": { + "auth": true, + "display-name": "List all tags", + "docs": "You can fetch a list of all tags for a given workspace. + +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "data": [ + { + "applied_at": 1663597223, + "applied_by": { + "type": "contact", + }, + "id": "115", + "name": "Manual tag 1", + "type": "tag", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tags", + "response": { + "docs": "successful", + "type": "root.Tags", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateTagRequestBody": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "root.CreateOrUpdateTagRequest", + }, + { + "type": "root.TagCompanyRequest", + }, + { + "type": "root.UntagCompanyRequest", + }, + { + "type": "root.TagMultipleUsersRequest", + }, + ], + }, + "Tag": { + "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "properties": { + "applied_at": { + "docs": "The time when the tag was applied to the object", + "type": "optional", + }, + "applied_by": { + "type": "optional", + }, + "id": { + "docs": "The id of the tag", + "type": "optional", + }, + "name": { + "docs": "The name of the tag", + "type": "optional", + }, + "type": { + "docs": "value is "tag"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + attachTagToContact: + path: /contacts/{contact_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific contact. This will return a tag object for the + tag that was added to the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + display-name: Add tag to a contact + request: + name: AttachTagToContactRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '7522907' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Contact not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '7522907' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + request: + id: '123' + response: + body: + type: tag + id: '94' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromContact: + path: /contacts/{contact_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific contact. This will return a tag + object for the tag that was removed from the contact. + source: + openapi: ../openapi.yml + path-parameters: + contact_id: + type: string + docs: The unique identifier for the contact which is given by Intercom + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + display-name: Remove tag from a contact + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + contact_id: 63a07ddf05a32042dffac965 + id: '7522907' + response: + body: + type: tag + id: '97' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + attachTagToConversation: + path: /conversations/{conversation_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific conversation. This will return a tag object for + the tag that was added to the conversation. + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: conversation_id + display-name: Add tag to a conversation + request: + name: AttachTagToConversationRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + conversation_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '99' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Conversation not found + path-parameters: + conversation_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '99' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromConversation: + path: /conversations/{conversation_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific conversation. This will return a tag + object for the tag that was removed from the conversation. + source: + openapi: ../openapi.yml + path-parameters: + conversation_id: + type: string + docs: conversation_id + id: + type: string + docs: id + display-name: Remove tag from a conversation + request: + name: DetachTagFromConversationRequest + body: + properties: + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Conversation not found + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + conversation_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '102' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + listTags: + path: /tags + method: GET + auth: true + docs: |+ + You can fetch a list of all tags for a given workspace. + + source: + openapi: ../openapi.yml + display-name: List all tags + response: + docs: successful + type: root.Tags + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + data: + - type: tag + id: '115' + name: Manual tag 1 + applied_at: 1663597223 + applied_by: + type: contact + createTag: + path: /tags + method: POST + auth: true + docs: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + source: + openapi: ../openapi.yml + display-name: Create or update a tag, Tag or untag companies, Tag contacts + request: + body: CreateTagRequestBody + content-type: application/json + response: + docs: Action successful + type: Tag + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Action successful + request: + name: test + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Invalid parameters + request: + name: Independent + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Company not found + request: + name: test + companies: + - company_id: '123' + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: User not found + request: + name: test + users: + - id: '123' + response: + body: + type: tag + id: '118' + name: test + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + findTag: + path: /tags/{id} + method: GET + auth: true + docs: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given tag + display-name: Find a specific tag + response: + docs: Tag found + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Tag found + path-parameters: + id: '123' + response: + body: + type: tag + id: '126' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + deleteTag: + path: /tags/{id} + method: DELETE + auth: true + docs: >- + You can delete the details of tags that are on the workspace by passing + in the id. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given tag + display-name: Delete tag + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.NotFoundError + examples: + - path-parameters: + id: '123' + attachTagToTicket: + path: /tickets/{ticket_id}/tags + method: POST + auth: true + docs: >- + You can tag a specific ticket. This will return a tag object for the tag + that was added to the ticket. + source: + openapi: ../openapi.yml + path-parameters: + ticket_id: + type: string + docs: ticket_id + display-name: Add tag to a ticket + request: + name: AttachTagToTicketRequest + body: + properties: + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + ticket_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '134' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Ticket not found + path-parameters: + ticket_id: '64619700005694' + request: + id: '7522907' + admin_id: '780' + response: + body: + type: tag + id: '134' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + detachTagFromTicket: + path: /tickets/{ticket_id}/tags/{id} + method: DELETE + auth: true + docs: >- + You can remove tag from a specific ticket. This will return a tag object + for the tag that was removed from the ticket. + source: + openapi: ../openapi.yml + path-parameters: + ticket_id: + type: string + docs: ticket_id + id: + type: string + docs: The unique identifier for the tag which is given by Intercom + display-name: Remove tag from a ticket + request: + name: DetachTagFromTicketRequest + body: + properties: + admin_id: + type: string + docs: The unique identifier for the admin which is given by Intercom. + content-type: application/json + response: + docs: successful + type: Tag + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Ticket not found + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + - name: Tag not found + path-parameters: + ticket_id: '64619700005694' + id: '7522907' + request: + admin_id: '123' + response: + body: + type: tag + id: '137' + name: Manual tag + applied_at: 1663597223 + applied_by: + type: contact + id: 1a2b3c + source: + openapi: ../openapi.yml + display-name: Tags +docs: Everything about tags +types: + CreateTagRequestBody: + discriminated: false + union: + - type: root.CreateOrUpdateTagRequest + - type: root.TagCompanyRequest + - type: root.UntagCompanyRequest + - type: root.TagMultipleUsersRequest + source: + openapi: ../openapi.yml + Tag: + docs: >- + A tag allows you to label your contacts, companies, and conversations and + list them using that tag. + properties: + type: + type: optional + docs: value is "tag" + id: + type: optional + docs: The id of the tag + name: + type: optional + docs: The name of the tag + applied_at: + type: optional + docs: The time when the tag was applied to the object + applied_by: + type: optional + source: + openapi: ../openapi.yml +", + }, + "teams.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Teams", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Teams", + "endpoints": { + "listTeams": { + "auth": true, + "display-name": "List all teams", + "docs": "This will return a list of team objects for the App.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "teams": [ + { + "admin_ids": [ + 493881, + ], + "id": "814865", + "name": "Example Team", + "type": "team", + }, + ], + "type": "team.list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/teams", + "response": { + "docs": "successful", + "type": "root.TeamList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveTeam": { + "auth": true, + "display-name": "Retrieve a team", + "docs": "You can fetch the details of a single team, containing an array of admins that belong to this team.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "path-parameters": { + "id": "123", + }, + "response": { + "body": { + "admin_ids": [ + 493881, + ], + "admin_priority_level": { + "primary_admin_ids": [ + 493881, + ], + "secondary_admin_ids": [ + 814865, + ], + }, + "id": "991267802", + "name": "team 1", + "type": "team", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/teams/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier of a given team.", + "type": "string", + }, + }, + "response": { + "docs": "successful", + "type": "Team", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Team": { + "docs": "Teams are groups of admins in Intercom.", + "properties": { + "admin_ids": { + "docs": "The list of admin IDs that are a part of the team.", + "type": "optional>", + }, + "admin_priority_level": { + "type": "optional", + }, + "id": { + "docs": "The id of the team", + "type": "optional", + }, + "name": { + "docs": "The name of the team", + "type": "optional", + }, + "type": { + "docs": "Value is always "team"", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + listTeams: + path: /teams + method: GET + auth: true + docs: This will return a list of team objects for the App. + source: + openapi: ../openapi.yml + display-name: List all teams + response: + docs: successful + type: root.TeamList + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: team.list + teams: + - type: team + id: '814865' + name: Example Team + admin_ids: + - 493881 + retrieveTeam: + path: /teams/{id} + method: GET + auth: true + docs: >- + You can fetch the details of a single team, containing an array of + admins that belong to this team. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier of a given team. + display-name: Retrieve a team + response: + docs: successful + type: Team + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + path-parameters: + id: '123' + response: + body: + type: team + id: '991267802' + name: team 1 + admin_ids: + - 493881 + admin_priority_level: + primary_admin_ids: + - 493881 + secondary_admin_ids: + - 814865 + source: + openapi: ../openapi.yml + display-name: Teams +docs: Everything about your Teams +types: + Team: + docs: Teams are groups of admins in Intercom. + properties: + type: + type: optional + docs: Value is always "team" + id: + type: optional + docs: The id of the team + name: + type: optional + docs: The name of the team + admin_ids: + type: optional> + docs: The list of admin IDs that are a part of the team. + admin_priority_level: + type: optional + source: + openapi: ../openapi.yml +", + }, + "ticketTypeAttributes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your ticket type attributes", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Ticket Type Attributes", + "endpoints": { + "createTicketTypeAttribute": { + "auth": true, + "display-name": "Create a new attribute for a ticket type", + "docs": "You can create a new attribute for a ticket type.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket Type Attribute created", + "path-parameters": { + "ticket_type_id": "ticket_type_id", + }, + "request": { + "data_type": "string", + "description": "Attribute Description", + "name": "Attribute Title", + "required_to_create": false, + }, + "response": { + "body": { + "archived": false, + "created_at": 1719493013, + "data_type": "string", + "default": false, + "description": "Attribute Description", + "id": "210", + "input_options": { + "multiline": false, + }, + "name": "Attribute Title", + "order": 2, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 81, + "type": "ticket_type_attribute", + "updated_at": 1719493013, + "visible_on_create": true, + "visible_to_contacts": true, + "workspace_id": "this_is_an_id600_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/ticket_types/{ticket_type_id}/attributes", + "path-parameters": { + "ticket_type_id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "allow_multiple_values": { + "docs": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "type": "optional", + }, + "data_type": { + "docs": "The data type of the attribute", + "type": "CreateTicketTypeAttributeRequestDataType", + }, + "description": { + "docs": "The description of the attribute presented to the teammate or contact", + "type": "string", + }, + "list_items": { + "docs": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "type": "optional", + }, + "multiline": { + "docs": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "string", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateTicketTypeAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Ticket Type Attribute created", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicketTypeAttribute": { + "auth": true, + "display-name": "Update an existing attribute for a ticket type", + "docs": "You can update an existing attribute for a ticket type.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket Type Attribute updated", + "path-parameters": { + "id": "id", + "ticket_type_id": "ticket_type_id", + }, + "request": { + "description": "New Attribute Description", + }, + "response": { + "body": { + "archived": false, + "created_at": 1719493013, + "data_type": "string", + "default": false, + "description": "New Attribute Description", + "id": "215", + "input_options": { + "key": "value", + }, + "name": "name", + "order": 0, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 83, + "type": "ticket_type_attribute", + "updated_at": 1719493014, + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "this_is_an_id604_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/ticket_types/{ticket_type_id}/attributes/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type attribute which is given by Intercom.", + "type": "string", + }, + "ticket_type_id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "allow_multiple_values": { + "docs": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)", + "type": "optional", + }, + "archived": { + "docs": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)", + "type": "optional", + }, + "description": { + "docs": "The description of the attribute presented to the teammate or contact", + "type": "optional", + }, + "list_items": { + "docs": "A comma delimited list of items for the attribute value (only applicable to list attributes)", + "type": "optional", + }, + "multiline": { + "docs": "Whether the attribute allows multiple lines of text (only applicable to string attributes)", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type attribute", + "type": "optional", + }, + "required_to_create": { + "default": false, + "docs": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.", + "type": "optional", + }, + "required_to_create_for_contacts": { + "default": false, + "docs": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.", + "type": "optional", + }, + "visible_on_create": { + "default": true, + "docs": "Whether the attribute is visible to teammates when creating a ticket in Inbox.", + "type": "optional", + }, + "visible_to_contacts": { + "default": true, + "docs": "Whether the attribute is visible to contacts when creating a ticket in Messenger.", + "type": "optional", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateTicketTypeAttributeRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Ticket Type Attribute updated", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "CreateTicketTypeAttributeRequestDataType": { + "docs": "The data type of the attribute", + "enum": [ + "string", + "list", + "integer", + "decimal", + "boolean", + "datetime", + "files", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "types: + CreateTicketTypeAttributeRequestDataType: + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + docs: The data type of the attribute + source: + openapi: ../openapi.yml +imports: + root: __package__.yml +service: + auth: false + base-path: '' + endpoints: + createTicketTypeAttribute: + path: /ticket_types/{ticket_type_id}/attributes + method: POST + auth: true + docs: You can create a new attribute for a ticket type. + source: + openapi: ../openapi.yml + path-parameters: + ticket_type_id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Create a new attribute for a ticket type + request: + name: CreateTicketTypeAttributeRequest + body: + properties: + name: + type: string + docs: The name of the ticket type attribute + description: + type: string + docs: >- + The description of the attribute presented to the teammate or + contact + data_type: + type: CreateTicketTypeAttributeRequestDataType + docs: The data type of the attribute + required_to_create: + type: optional + docs: >- + Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + required_to_create_for_contacts: + type: optional + docs: >- + Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + visible_on_create: + type: optional + docs: >- + Whether the attribute is visible to teammates when creating a + ticket in Inbox. + default: true + visible_to_contacts: + type: optional + docs: >- + Whether the attribute is visible to contacts when creating a + ticket in Messenger. + default: true + multiline: + type: optional + docs: >- + Whether the attribute allows multiple lines of text (only + applicable to string attributes) + list_items: + type: optional + docs: >- + A comma delimited list of items for the attribute value (only + applicable to list attributes) + allow_multiple_values: + type: optional + docs: >- + Whether the attribute allows multiple files to be attached to it + (only applicable to file attributes) + content-type: application/json + response: + docs: Ticket Type Attribute created + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket Type Attribute created + path-parameters: + ticket_type_id: ticket_type_id + request: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + response: + body: + type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id600_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + order: 2 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: false + ticket_type_id: 81 + archived: false + created_at: 1719493013 + updated_at: 1719493013 + updateTicketTypeAttribute: + path: /ticket_types/{ticket_type_id}/attributes/{id} + method: PUT + auth: true + docs: You can update an existing attribute for a ticket type. + source: + openapi: ../openapi.yml + path-parameters: + ticket_type_id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + id: + type: string + docs: >- + The unique identifier for the ticket type attribute which is given + by Intercom. + display-name: Update an existing attribute for a ticket type + request: + name: UpdateTicketTypeAttributeRequest + body: + properties: + name: + type: optional + docs: The name of the ticket type attribute + description: + type: optional + docs: >- + The description of the attribute presented to the teammate or + contact + required_to_create: + type: optional + docs: >- + Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + required_to_create_for_contacts: + type: optional + docs: >- + Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + visible_on_create: + type: optional + docs: >- + Whether the attribute is visible to teammates when creating a + ticket in Inbox. + default: true + visible_to_contacts: + type: optional + docs: >- + Whether the attribute is visible to contacts when creating a + ticket in Messenger. + default: true + multiline: + type: optional + docs: >- + Whether the attribute allows multiple lines of text (only + applicable to string attributes) + list_items: + type: optional + docs: >- + A comma delimited list of items for the attribute value (only + applicable to list attributes) + allow_multiple_values: + type: optional + docs: >- + Whether the attribute allows multiple files to be attached to it + (only applicable to file attributes) + archived: + type: optional + docs: >- + Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously + created tickets) + content-type: application/json + response: + docs: Ticket Type Attribute updated + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket Type Attribute updated + path-parameters: + ticket_type_id: ticket_type_id + id: id + request: + description: New Attribute Description + response: + body: + type: ticket_type_attribute + id: '215' + workspace_id: this_is_an_id604_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + input_options: + key: value + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 83 + archived: false + created_at: 1719493013 + updated_at: 1719493014 + source: + openapi: ../openapi.yml + display-name: Ticket Type Attributes +docs: Everything about your ticket type attributes +", + }, + "ticketTypes.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your ticket types", + "imports": { + "root": "__package__.yml", + "tickets": "tickets.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Ticket Types", + "endpoints": { + "createTicketType": { + "auth": true, + "display-name": "Create a ticket type", + "docs": "You can create a new ticket type. +> 📘 Creating ticket types. +> +> Every ticket type will be created with two default attributes: _default_title_ and _default_description_. +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type created", + "request": { + "category": "Customer", + "description": "Customer Report Template", + "icon": "🎟️", + "name": "Customer Issue", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493016, + "description": "Customer Report Template", + "icon": "🎟️", + "id": "88", + "name": "Customer Issue", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493016, + "workspace_id": "this_is_an_id612_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/ticket_types", + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Ticket type created", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getTicketType": { + "auth": true, + "display-name": "Retrieve a ticket type", + "docs": "You can fetch the details of a single ticket type.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type found", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493017, + "description": "Bug Report Template", + "icon": "🎟️", + "id": "90", + "name": "Bug Report", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493017, + "workspace_id": "this_is_an_id616_that_should_be_at_least_", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/ticket_types/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Ticket type found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "listTicketTypes": { + "auth": true, + "display-name": "List all ticket types", + "docs": "You can get a list of all ticket types for a workspace.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "response": { + "body": { + "ticket_types": [ + { + "archived": false, + "category": "Customer", + "created_at": 1, + "description": "A bug that has been reported.", + "icon": "🐞", + "id": "1295", + "name": "Bug", + "type": "ticket_type", + "updated_at": 1, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/ticket_types", + "response": { + "docs": "successful", + "type": "root.TicketTypeList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicketType": { + "auth": true, + "display-name": "Update a ticket type", + "docs": " +You can update a ticket type. + +> 📘 Updating a ticket type. +> +> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket type updated", + "path-parameters": { + "id": "id", + }, + "request": { + "name": "Bug Report 2", + }, + "response": { + "body": { + "archived": false, + "category": "Customer", + "created_at": 1719493018, + "description": "Bug Report Template", + "icon": "🎟️", + "id": "92", + "name": "Bug Report 2", + "ticket_type_attributes": { + "ticket_type_attributes": [ + { + "archived": false, + "data_type": "string", + "default": true, + "description": "Bug title.", + "id": "1", + "input_options": { + "key": "value", + }, + "name": "Title", + "order": 1, + "required_to_create": false, + "required_to_create_for_contacts": false, + "ticket_type_id": 42, + "type": "ticket_type_attribute", + "visible_on_create": false, + "visible_to_contacts": false, + "workspace_id": "ecahpwf5", + }, + ], + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493018, + "workspace_id": "this_is_an_id620_that_should_be_at_least_", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/ticket_types/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket type which is given by Intercom.", + "type": "string", + }, + }, + "request": { + "body": { + "type": "optional", + }, + "content-type": "application/json", + }, + "response": { + "docs": "Ticket type updated", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + tickets: tickets.yml +service: + auth: false + base-path: '' + endpoints: + listTicketTypes: + path: /ticket_types + method: GET + auth: true + docs: You can get a list of all ticket types for a workspace. + source: + openapi: ../openapi.yml + display-name: List all ticket types + response: + docs: successful + type: root.TicketTypeList + errors: + - root.UnauthorizedError + examples: + - name: successful + response: + body: + type: list + ticket_types: + - type: ticket_type + id: '1295' + category: Customer + name: Bug + description: A bug that has been reported. + icon: 🐞 + workspace_id: ecahpwf5 + archived: false + created_at: 1 + updated_at: 1 + createTicketType: + path: /ticket_types + method: POST + auth: true + docs: > + You can create a new ticket type. + + > 📘 Creating ticket types. + + > + + > Every ticket type will be created with two default attributes: + _default_title_ and _default_description_. + + > For the `icon` propery, use an emoji from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + source: + openapi: ../openapi.yml + display-name: Create a ticket type + request: + body: + type: optional + content-type: application/json + response: + docs: Ticket type created + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket type created + request: + name: Customer Issue + description: Customer Report Template + category: Customer + icon: 🎟️ + response: + body: + type: ticket_type + id: '88' + category: Customer + name: Customer Issue + description: Customer Report Template + icon: 🎟️ + workspace_id: this_is_an_id612_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493016 + updated_at: 1719493016 + getTicketType: + path: /ticket_types/{id} + method: GET + auth: true + docs: You can fetch the details of a single ticket type. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Retrieve a ticket type + response: + docs: Ticket type found + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket type found + path-parameters: + id: id + response: + body: + type: ticket_type + id: '90' + category: Customer + name: Bug Report + description: Bug Report Template + icon: 🎟️ + workspace_id: this_is_an_id616_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493017 + updated_at: 1719493017 + updateTicketType: + path: /ticket_types/{id} + method: PUT + auth: true + docs: > + + You can update a ticket type. + + + > 📘 Updating a ticket type. + + > + + > For the `icon` propery, use an emoji from [Twemoji + Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: >- + The unique identifier for the ticket type which is given by + Intercom. + display-name: Update a ticket type + request: + body: + type: optional + content-type: application/json + response: + docs: Ticket type updated + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket type updated + path-parameters: + id: id + request: + name: Bug Report 2 + response: + body: + type: ticket_type + id: '92' + category: Customer + name: Bug Report 2 + description: Bug Report Template + icon: 🎟️ + workspace_id: this_is_an_id620_that_should_be_at_least_ + ticket_type_attributes: + type: list + ticket_type_attributes: + - type: ticket_type_attribute + id: '1' + workspace_id: ecahpwf5 + name: Title + description: Bug title. + data_type: string + input_options: + key: value + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: true + ticket_type_id: 42 + archived: false + archived: false + created_at: 1719493018 + updated_at: 1719493018 + source: + openapi: ../openapi.yml + display-name: Ticket Types +docs: Everything about your ticket types +", + }, + "tickets.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your tickets", + "imports": { + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Tickets", + "endpoints": { + "createTicket": { + "auth": true, + "display-name": "Create a ticket", + "docs": "You can create a new ticket.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Successful response", + "request": { + "contacts": [ + { + "id": "667d61b78a68186f43bafe8d", + }, + ], + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_type_id": "1234", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "70", + "id": "667d61b78a68186f43bafe8d", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493048, + "id": "489", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "48", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id648_that_should_be_at_least_@intercom.io", + "id": "991267871", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493048, + "id": "125", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493048, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493047, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "106", + "name": "my-ticket-type-15", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493047, + "workspace_id": "this_is_an_id648_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493048, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets", + "request": { + "body": { + "properties": { + "company_id": { + "docs": "The ID of the company that the ticket is associated with. The ID that you set upon company creation.", + "type": "optional", + }, + "contacts": { + "docs": "The list of contacts (users or leads) affected by this ticket. Currently only one is allowed", + "type": "list", + }, + "created_at": { + "docs": "The time the ticket was created. If not provided, the current time will be used.", + "type": "optional", + }, + "ticket_attributes": { + "type": "optional", + }, + "ticket_type_id": { + "docs": "The ID of the type of ticket you want to create", + "type": "string", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "CreateTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "getTicket": { + "auth": true, + "display-name": "Retrieve a ticket", + "docs": "You can fetch the details of a single ticket.", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "Ticket found", + "path-parameters": { + "id": "id", + }, + "response": { + "body": { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "038050f6-d917-4b9d-89cb-539b1d371172", + "id": "667d61c48a68186f43bafe91", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493061, + "id": "493", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "ticket_attributes", + "_default_title_": "attribute_value", + }, + "ticket_id": "52", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin445@email.com", + "id": "991267912", + "name": "Ciaran445 Lee", + "type": "admin", + }, + "created_at": 1719493061, + "id": "134", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493061, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493060, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "112", + "name": "my-ticket-type-21", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493060, + "workspace_id": "this_is_an_id660_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493061, + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/tickets/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom.", + "type": "string", + }, + }, + "response": { + "docs": "Ticket found", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "replyTicket": { + "auth": true, + "display-name": "Reply to a ticket", + "docs": "You can reply to a ticket with a message from an admin or on behalf of a contact, or with a note for admins.", + "errors": [ + "root.BadRequestError", + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "User reply", + "path-parameters": { + "id": "123", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d619d8a68186f43bafe82", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + { + "name": "Admin note reply", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "3156780", + "body": "

An Unordered HTML List

  • Coffee
  • Tea
  • Milk

An Ordered HTML List

  1. Coffee
  2. Tea
  3. Milk
", + "message_type": "note", + "type": "admin", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + { + "name": "Admin quick_reply reply", + "path-parameters": { + "id": "123", + }, + "request": { + "admin_id": "3156780", + "message_type": "quick_reply", + "reply_options": [ + { + "text": "Yes", + "uuid": "22d6d1f4-1a19-41d0-94c2-e54031f78aca", + }, + { + "text": "No", + "uuid": "fbc3dbe0-ec0c-4fb6-826d-e19127191906", + }, + ], + "type": "admin", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin379@email.com", + "id": "991267834", + "name": "Ciaran379 Lee", + "type": "admin", + }, + "body": "

Okay!

", + "created_at": 1719493029, + "id": "124", + "part_type": "quick_reply", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493029, + }, + }, + }, + { + "name": "Not found", + "path-parameters": { + "id": "123", + }, + "request": { + "body": "Thanks again :)", + "intercom_user_id": "667d61a68a68186f43bafe85", + "message_type": "comment", + "type": "user", + }, + "response": { + "body": { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin375@email.com", + "id": "991267829", + "name": "Ciaran375 Lee", + "type": "admin", + }, + "body": "

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
", + "created_at": 1719493024, + "id": "122", + "part_type": "note", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493024, + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/{id}/reply", + "path-parameters": { + "id": "string", + }, + "request": { + "body": "ReplyTicketRequestBody", + "content-type": "application/json", + }, + "response": { + "docs": "Admin quick_reply reply", + "type": "root.TicketReply", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "searchTickets": { + "auth": true, + "display-name": "Search tickets", + "docs": "You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + +To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + +This will accept a query object in the body which will define your filters. +{% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. +{% /admonition %} + +### Nesting & Limitations + +You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). +There are some limitations to the amount of multiples there can be: +- There's a limit of max 2 nested filters +- There's a limit of max 15 filters for each AND or OR group + +### Accepted Fields + +Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + +| Field | Type | +| :---------------------------------------- | :--------------------------------------------------------------------------------------- | +| id | String | +| created_at | Date (UNIX timestamp) | +| updated_at | Date (UNIX timestamp) | +| _default_title_ | String | +| _default_description_ | String | +| category | String | +| ticket_type_id | String | +| contact_ids | String | +| teammate_ids | String | +| admin_assignee_id | String | +| team_assignee_id | String | +| open | Boolean | +| state | String | +| snoozed_until | Date (UNIX timestamp) | +| ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + +### Accepted Operators + +{% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. +{% /admonition %} + +The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + +| Operator | Valid Types | Description | +| :------- | :----------------------------- | :----------------------------------------------------------- | +| = | All | Equals | +| != | All | Doesn't Equal | +| IN | All | In Shortcut for `OR` queries Values most be in Array | +| NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | +| > | Integer Date (UNIX Timestamp) | Greater (or equal) than | +| < | Integer Date (UNIX Timestamp) | Lower (or equal) than | +| ~ | String | Contains | +| !~ | String | Doesn't Contain | +| ^ | String | Starts With | +| $ | String | Ends With | +", + "examples": [ + { + "name": "successful", + "request": { + "pagination": { + "per_page": 5, + }, + "query": { + "operator": "AND", + "value": [ + { + "field": "created_at", + "operator": ">", + "value": "1306054154", + }, + ], + }, + }, + "response": { + "body": { + "pages": { + "next": { + "per_page": 2, + "starting_after": "your-cursor-from-response", + }, + "page": 1, + "per_page": 5, + "total_pages": 1, + "type": "pages", + }, + "tickets": [ + { + "admin_assignee_id": "0", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "6895b33e-2768-4611-908e-da6632dfc8ea", + "id": "667d61c98a68186f43bafe92", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493065, + "id": "494", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1663597260, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_title_": "attribute_value", + }, + "ticket_id": "53", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin472@email.com", + "id": "991267940", + "name": "Ciaran472 Lee", + "type": "admin", + }, + "created_at": 1719493066, + "id": "135", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493066, + }, + ], + "total_count": 1, + "type": "ticket_part.list", + }, + "ticket_state": "submitted", + "ticket_state_external_label": "Submitted", + "ticket_state_internal_label": "Submitted", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493065, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "117", + "name": "my-ticket-type-26", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493065, + "workspace_id": "this_is_an_id667_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493066, + }, + ], + "total_count": 1, + "type": "ticket.list", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/tickets/search", + "request": { + "body": { + "type": "root.SearchRequest", + }, + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "root.TicketList", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateTicket": { + "auth": true, + "display-name": "Update a ticket", + "docs": "You can update a ticket.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "Successful response", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "991267883", + "assignee_id": "991267885", + }, + "open": true, + "snoozed_until": 1673609604, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + { + "name": "Admin not found", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "123", + "assignee_id": "991267893", + }, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + { + "name": "Assignee not found", + "path-parameters": { + "id": "id", + }, + "request": { + "assignment": { + "admin_id": "991267899", + "assignee_id": "456", + }, + "state": "in_progress", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + }, + "response": { + "body": { + "admin_assignee_id": "991267885", + "category": "Back-office", + "contacts": { + "contacts": [ + { + "external_id": "cd63b6b5-ea75-4ad9-b72c-9d7a647baf08", + "id": "667d61bb8a68186f43bafe8e", + "type": "contact", + }, + ], + "type": "contact.list", + }, + "created_at": 1719493051, + "id": "490", + "is_shared": false, + "linked_objects": { + "data": [ + { + "id": "7583", + }, + ], + "has_more": false, + "total_count": 0, + "type": "list", + }, + "open": true, + "snoozed_until": 1719590400, + "team_assignee_id": "0", + "ticket_attributes": { + "_default_description_": "there is a problem", + "_default_title_": "example", + }, + "ticket_id": "49", + "ticket_parts": { + "ticket_parts": [ + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493051, + "id": "126", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "submitted", + "type": "ticket_part", + "updated_at": 1719493051, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "127", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "128", + "part_type": "ticket_attribute_updated_by_admin", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493053, + "id": "129", + "part_type": "ticket_state_updated_by_admin", + "previous_ticket_state": "submitted", + "redacted": false, + "ticket_state": "in_progress", + "type": "ticket_part", + "updated_at": 1719493053, + }, + { + "assigned_to": { + "id": "991267885", + "type": "admin", + }, + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "admin419@email.com", + "id": "991267883", + "name": "Ciaran419 Lee", + "type": "admin", + }, + "created_at": 1719493054, + "id": "130", + "part_type": "assignment", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + { + "attachments": [ + { + "content_type": "image/png", + "filesize": 100, + "height": 100, + "name": "example.png", + "type": "upload", + "url": "https://picsum.photos/200/300", + "width": 100, + }, + ], + "author": { + "email": "operator+this_is_an_id652_that_should_be_at_least_@intercom.io", + "id": "991267884", + "name": "Operator", + "type": "bot", + }, + "created_at": 1719493054, + "id": "131", + "part_type": "snoozed", + "redacted": false, + "type": "ticket_part", + "updated_at": 1719493054, + }, + ], + "total_count": 6, + "type": "ticket_part.list", + }, + "ticket_state": "in_progress", + "ticket_state_external_label": "In progress", + "ticket_state_internal_label": "In progress", + "ticket_type": { + "archived": false, + "category": "Back-office", + "created_at": 1719493050, + "description": "my ticket type description is awesome.", + "icon": "🦁", + "id": "108", + "name": "my-ticket-type-17", + "ticket_type_attributes": { + "type": "list", + }, + "type": "ticket_type", + "updated_at": 1719493050, + "workspace_id": "this_is_an_id652_that_should_be_at_least_", + }, + "type": "ticket", + "updated_at": 1719493054, + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/tickets/{id}", + "path-parameters": { + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom", + "type": "string", + }, + }, + "request": { + "body": { + "properties": { + "assignment": { + "type": "optional", + }, + "is_shared": { + "docs": "Specify whether the ticket is visible to users.", + "type": "optional", + }, + "open": { + "docs": "Specify if a ticket is open. Set to false to close a ticket. Closing a ticket will also unsnooze it.", + "type": "optional", + }, + "snoozed_until": { + "docs": "The time you want the ticket to reopen.", + "type": "optional", + }, + "state": { + "docs": "The state of the ticket.", + "type": "optional", + }, + "ticket_attributes": { + "docs": "The attributes set on the ticket.", + "type": "optional>", + }, + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "UpdateTicketRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "Successful response", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "types": { + "Contacts": { + "docs": "The list of contacts affected by a ticket.", + "properties": { + "contacts": { + "docs": "The list of contacts affected by this ticket.", + "type": "optional>", + }, + "type": { + "docs": "always contact.list", + "type": "optional>", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "CreateTicketRequestContactsItem": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "ID", + }, + { + "type": "CreateTicketRequestContactsItemExternalId", + }, + { + "type": "Email", + }, + ], + }, + "CreateTicketRequestContactsItemExternalId": { + "docs": undefined, + "properties": { + "external_id": { + "docs": "The external_id you have defined for the contact who is being added as a participant.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "Email": { + "docs": undefined, + "properties": { + "email": { + "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ID": { + "docs": undefined, + "properties": { + "id": { + "docs": "The identifier for the contact as given by Intercom.", + "type": "string", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "ReplyTicketRequestBody": { + "discriminated": false, + "docs": undefined, + "encoding": undefined, + "source": { + "openapi": "../openapi.yml", + }, + "union": [ + { + "type": "root.ContactReplyTicketRequest", + }, + { + "type": "root.AdminReplyTicketRequest", + }, + ], + }, + "Ticket": { + "docs": "Tickets are how you track requests from your users.", + "properties": { + "admin_assignee_id": { + "docs": "The id representing the admin assigned to the ticket.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket.", + "type": "optional", + }, + "contacts": { + "type": "optional", + }, + "created_at": { + "docs": "The time the ticket was created as a UTC Unix timestamp.", + "type": "optional", + }, + "id": { + "docs": "The unique identifier for the ticket which is given by Intercom.", + "type": "optional", + }, + "is_shared": { + "docs": "Whether or not the ticket is shared with the customer.", + "type": "optional", + }, + "linked_objects": { + "type": "optional", + }, + "open": { + "docs": "Whether or not the ticket is open. If false, the ticket is closed.", + "type": "optional", + }, + "snoozed_until": { + "docs": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.", + "type": "optional", + }, + "team_assignee_id": { + "docs": "The id representing the team assigned to the ticket.", + "type": "optional", + }, + "ticket_attributes": { + "type": "optional", + }, + "ticket_id": { + "docs": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.", + "type": "optional", + }, + "ticket_parts": { + "type": "optional", + }, + "ticket_state": { + "docs": "The state the ticket is currently in", + "type": "optional", + }, + "ticket_state_external_label": { + "docs": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.", + "type": "optional", + }, + "ticket_state_internal_label": { + "docs": "The state the ticket is currently in, in a human readable form - visible in Intercom", + "type": "optional", + }, + "ticket_type": { + "type": "optional", + }, + "type": { + "docs": "Always ticket", + "type": "optional>", + }, + "updated_at": { + "docs": "The last time the ticket was updated as a UTC Unix timestamp.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketCategory": { + "docs": "Category of the Ticket.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPart": { + "docs": "A Ticket Part represents a message in the ticket.", + "properties": { + "assigned_to": { + "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", + "type": "optional", + }, + "attachments": { + "docs": "A list of attachments for the part.", + "type": "optional>", + }, + "author": { + "type": "optional", + }, + "body": { + "docs": "The message body, which may contain HTML.", + "type": "optional", + }, + "created_at": { + "docs": "The time the ticket part was created.", + "type": "optional", + }, + "external_id": { + "docs": "The external id of the ticket part", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket part.", + "type": "optional", + }, + "part_type": { + "docs": "The type of ticket part.", + "type": "optional", + }, + "previous_ticket_state": { + "docs": "The previous state of the ticket.", + "type": "optional", + }, + "redacted": { + "docs": "Whether or not the ticket part has been redacted.", + "type": "optional", + }, + "ticket_state": { + "docs": "The state of the ticket.", + "type": "optional", + }, + "type": { + "docs": "Always ticket_part", + "type": "optional", + }, + "updated_at": { + "docs": "The last time the ticket part was updated.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartPreviousTicketState": { + "docs": "The previous state of the ticket.", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketPartTicketState": { + "docs": "The state of the ticket.", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTicketState": { + "docs": "The state the ticket is currently in", + "enum": [ + "submitted", + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketType": { + "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "properties": { + "archived": { + "docs": "Whether the ticket type is archived or not.", + "type": "optional", + }, + "category": { + "docs": "Category of the Ticket Type.", + "type": "optional", + }, + "created_at": { + "docs": "The date and time the ticket type was created.", + "type": "optional", + }, + "description": { + "docs": "The description of the ticket type", + "type": "optional", + }, + "icon": { + "docs": "The icon of the ticket type", + "type": "optional", + }, + "id": { + "docs": "The id representing the ticket type.", + "type": "optional", + }, + "name": { + "docs": "The name of the ticket type", + "type": "optional", + }, + "ticket_type_attributes": { + "type": "optional", + }, + "type": { + "docs": "String representing the object's type. Always has the value `ticket_type`.", + "type": "optional", + }, + "updated_at": { + "docs": "The date and time the ticket type was last updated.", + "type": "optional", + }, + "workspace_id": { + "docs": "The id of the workspace that the ticket type belongs to.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "TicketTypeCategory": { + "docs": "Category of the Ticket Type.", + "enum": [ + "Customer", + { + "name": "BackOffice", + "value": "Back-office", + }, + "Tracker", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketRequestAssignment": { + "docs": undefined, + "properties": { + "admin_id": { + "docs": "The ID of the admin performing the action.", + "type": "optional", + }, + "assignee_id": { + "docs": "The ID of the admin or team to which the ticket is assigned. Set this 0 to unassign it.", + "type": "optional", + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "UpdateTicketRequestState": { + "docs": "The state of the ticket.", + "enum": [ + "in_progress", + "waiting_on_customer", + "resolved", + ], + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + }, + "rawContents": "imports: + root: __package__.yml +types: + ReplyTicketRequestBody: + discriminated: false + union: + - type: root.ContactReplyTicketRequest + - type: root.AdminReplyTicketRequest + source: + openapi: ../openapi.yml + ID: + properties: + id: + type: string + docs: The identifier for the contact as given by Intercom. + source: + openapi: ../openapi.yml + CreateTicketRequestContactsItemExternalId: + properties: + external_id: + type: string + docs: >- + The external_id you have defined for the contact who is being added as + a participant. + source: + openapi: ../openapi.yml + Email: + properties: + email: + type: string + docs: >- + The email you have defined for the contact who is being added as a + participant. If a contact with this email does not exist, one will be + created. + source: + openapi: ../openapi.yml + CreateTicketRequestContactsItem: + discriminated: false + union: + - type: ID + - type: CreateTicketRequestContactsItemExternalId + - type: Email + source: + openapi: ../openapi.yml + UpdateTicketRequestState: + enum: + - in_progress + - waiting_on_customer + - resolved + docs: The state of the ticket. + source: + openapi: ../openapi.yml + UpdateTicketRequestAssignment: + properties: + admin_id: + type: optional + docs: The ID of the admin performing the action. + assignee_id: + type: optional + docs: >- + The ID of the admin or team to which the ticket is assigned. Set this + 0 to unassign it. + source: + openapi: ../openapi.yml + TicketCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket. + source: + openapi: ../openapi.yml + TicketTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The state the ticket is currently in + source: + openapi: ../openapi.yml + Ticket: + docs: Tickets are how you track requests from your users. + properties: + type: + type: optional> + docs: Always ticket + id: + type: optional + docs: The unique identifier for the ticket which is given by Intercom. + ticket_id: + type: optional + docs: >- + The ID of the Ticket used in the Intercom Inbox and Messenger. Do not + use ticket_id for API queries. + category: + type: optional + docs: Category of the Ticket. + ticket_attributes: + type: optional + ticket_state: + type: optional + docs: The state the ticket is currently in + ticket_type: + type: optional + contacts: + type: optional + admin_assignee_id: + type: optional + docs: The id representing the admin assigned to the ticket. + team_assignee_id: + type: optional + docs: The id representing the team assigned to the ticket. + created_at: + type: optional + docs: The time the ticket was created as a UTC Unix timestamp. + updated_at: + type: optional + docs: The last time the ticket was updated as a UTC Unix timestamp. + open: + type: optional + docs: Whether or not the ticket is open. If false, the ticket is closed. + snoozed_until: + type: optional + docs: >- + The time the ticket will be snoozed until as a UTC Unix timestamp. If + null, the ticket is not currently snoozed. + linked_objects: + type: optional + ticket_parts: + type: optional + is_shared: + type: optional + docs: Whether or not the ticket is shared with the customer. + ticket_state_internal_label: + type: optional + docs: >- + The state the ticket is currently in, in a human readable form - + visible in Intercom + ticket_state_external_label: + type: optional + docs: >- + The state the ticket is currently in, in a human readable form - + visible to customers, in the messenger, email and tickets portal. + source: + openapi: ../openapi.yml + Contacts: + docs: The list of contacts affected by a ticket. + properties: + type: + type: optional> + docs: always contact.list + contacts: + type: optional> + docs: The list of contacts affected by this ticket. + source: + openapi: ../openapi.yml + TicketPartPreviousTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The previous state of the ticket. + source: + openapi: ../openapi.yml + TicketPartTicketState: + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + docs: The state of the ticket. + source: + openapi: ../openapi.yml + TicketPart: + docs: A Ticket Part represents a message in the ticket. + properties: + type: + type: optional + docs: Always ticket_part + id: + type: optional + docs: The id representing the ticket part. + part_type: + type: optional + docs: The type of ticket part. + body: + type: optional + docs: The message body, which may contain HTML. + previous_ticket_state: + type: optional + docs: The previous state of the ticket. + ticket_state: + type: optional + docs: The state of the ticket. + created_at: + type: optional + docs: The time the ticket part was created. + updated_at: + type: optional + docs: The last time the ticket part was updated. + assigned_to: + type: optional + docs: >- + The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + type: optional + attachments: + type: optional> + docs: A list of attachments for the part. + external_id: + type: optional + docs: The external id of the ticket part + redacted: + type: optional + docs: Whether or not the ticket part has been redacted. + source: + openapi: ../openapi.yml + TicketTypeCategory: + enum: + - Customer + - value: Back-office + name: BackOffice + - Tracker + docs: Category of the Ticket Type. + source: + openapi: ../openapi.yml + TicketType: + docs: A ticket type, used to define the data fields to be captured in a ticket. + properties: + type: + type: optional + docs: >- + String representing the object's type. Always has the value + `ticket_type`. + id: + type: optional + docs: The id representing the ticket type. + category: + type: optional + docs: Category of the Ticket Type. + name: + type: optional + docs: The name of the ticket type + description: + type: optional + docs: The description of the ticket type + icon: + type: optional + docs: The icon of the ticket type + workspace_id: + type: optional + docs: The id of the workspace that the ticket type belongs to. + ticket_type_attributes: + type: optional + archived: + type: optional + docs: Whether the ticket type is archived or not. + created_at: + type: optional + docs: The date and time the ticket type was created. + updated_at: + type: optional + docs: The date and time the ticket type was last updated. + source: + openapi: ../openapi.yml +service: + auth: false + base-path: '' + endpoints: + replyTicket: + path: /tickets/{id}/reply + method: POST + auth: true + docs: >- + You can reply to a ticket with a message from an admin or on behalf of a + contact, or with a note for admins. + source: + openapi: ../openapi.yml + path-parameters: + id: string + display-name: Reply to a ticket + request: + body: ReplyTicketRequestBody + content-type: application/json + response: + docs: Admin quick_reply reply + type: root.TicketReply + errors: + - root.BadRequestError + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: User reply + path-parameters: + id: '123' + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d619d8a68186f43bafe82 + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Admin note reply + path-parameters: + id: '123' + request: + message_type: note + type: admin + body: >- +

An Unordered HTML List

    +
  • Coffee
  • Tea
  • Milk

An + Ordered HTML List

  1. Coffee
  2. Tea
  3. +
  4. Milk
+ admin_id: '3156780' + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Admin quick_reply reply + path-parameters: + id: '123' + request: + message_type: quick_reply + type: admin + admin_id: '3156780' + reply_options: + - text: 'Yes' + uuid: 22d6d1f4-1a19-41d0-94c2-e54031f78aca + - text: 'No' + uuid: fbc3dbe0-ec0c-4fb6-826d-e19127191906 + response: + body: + type: ticket_part + id: '124' + part_type: quick_reply + body:

Okay!

+ created_at: 1719493029 + updated_at: 1719493029 + author: + type: admin + id: '991267834' + name: Ciaran379 Lee + email: admin379@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - name: Not found + path-parameters: + id: '123' + request: + message_type: comment + type: user + body: Thanks again :) + intercom_user_id: 667d61a68a68186f43bafe85 + response: + body: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + type: admin + id: '991267829' + name: Ciaran375 Lee + email: admin375@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + createTicket: + path: /tickets + method: POST + auth: true + docs: You can create a new ticket. + source: + openapi: ../openapi.yml + display-name: Create a ticket + request: + name: CreateTicketRequest + body: + properties: + ticket_type_id: + type: string + docs: The ID of the type of ticket you want to create + contacts: + docs: >- + The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + type: list + company_id: + type: optional + docs: >- + The ID of the company that the ticket is associated with. The ID + that you set upon company creation. + created_at: + type: optional + docs: >- + The time the ticket was created. If not provided, the current + time will be used. + ticket_attributes: + type: optional + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Successful response + request: + ticket_type_id: '1234' + contacts: + - id: 667d61b78a68186f43bafe8d + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + response: + body: + type: ticket + id: '489' + ticket_id: '48' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '106' + category: Back-office + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id648_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493047 + updated_at: 1719493047 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61b78a68186f43bafe8d + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493048 + updated_at: 1719493048 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '125' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493048 + updated_at: 1719493048 + author: + type: bot + id: '991267871' + name: Operator + email: >- + operator+this_is_an_id648_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + getTicket: + path: /tickets/{id} + method: GET + auth: true + docs: You can fetch the details of a single ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the ticket which is given by Intercom. + display-name: Retrieve a ticket + response: + docs: Ticket found + type: optional + errors: + - root.UnauthorizedError + examples: + - name: Ticket found + path-parameters: + id: id + response: + body: + type: ticket + id: '493' + ticket_id: '52' + category: Back-office + ticket_attributes: + _default_title_: attribute_value + _default_description_: ticket_attributes + ticket_state: submitted + ticket_type: + type: ticket_type + id: '112' + category: Back-office + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id660_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493060 + updated_at: 1719493060 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c48a68186f43bafe91 + external_id: 038050f6-d917-4b9d-89cb-539b1d371172 + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493061 + updated_at: 1719493061 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '134' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493061 + updated_at: 1719493061 + author: + type: admin + id: '991267912' + name: Ciaran445 Lee + email: admin445@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + updateTicket: + path: /tickets/{id} + method: PUT + auth: true + docs: You can update a ticket. + source: + openapi: ../openapi.yml + path-parameters: + id: + type: string + docs: The unique identifier for the ticket which is given by Intercom + display-name: Update a ticket + request: + name: UpdateTicketRequest + body: + properties: + ticket_attributes: + type: optional> + docs: The attributes set on the ticket. + state: + type: optional + docs: The state of the ticket. + open: + type: optional + docs: >- + Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + is_shared: + type: optional + docs: Specify whether the ticket is visible to users. + snoozed_until: + type: optional + docs: The time you want the ticket to reopen. + assignment: + type: optional + content-type: application/json + response: + docs: Successful response + type: optional + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: Successful response + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + open: true + snoozed_until: 1673609604 + assignment: + admin_id: '991267883' + assignee_id: '991267885' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + - name: Admin not found + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991267893' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + - name: Assignee not found + path-parameters: + id: id + request: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267899' + assignee_id: '456' + response: + body: + type: ticket + id: '490' + ticket_id: '49' + category: Back-office + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + category: Back-office + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id652_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493050 + updated_at: 1719493050 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: in_progress + created_at: 1719493053 + updated_at: 1719493053 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + type: admin + id: '991267883' + name: Ciaran419 Lee + email: admin419@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + type: bot + id: '991267884' + name: Operator + email: >- + operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 6 + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + searchTickets: + path: /tickets/search + method: POST + auth: true + docs: > + You can search for multiple tickets by the value of their attributes in + order to fetch exactly which ones you want. + + + To search for tickets, you send a `POST` request to + `https://api.intercom.io/tickets/search`. + + + This will accept a query object in the body which will define your + filters. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + + ### Nesting & Limitations + + + You can nest these filters in order to get even more granular insights + that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + + There are some limitations to the amount of multiples there can be: + + - There's a limit of max 2 nested filters + + - There's a limit of max 15 filters for each AND or OR group + + + ### Accepted Fields + + + Most keys listed as part of the Ticket model are searchable, whether + writeable or not. The value you search for has to match the accepted + type, otherwise the query will fail (ie. as `created_at` accepts a date, + the `value` cannot be a string such as `"foobar"`). + + + | Field | + Type + | + + | :---------------------------------------- | + :--------------------------------------------------------------------------------------- + | + + | id | + String + | + + | created_at | Date (UNIX + timestamp) + | + + | updated_at | Date (UNIX + timestamp) + | + + | _default_title_ | + String + | + + | _default_description_ | + String + | + + | category | + String + | + + | ticket_type_id | + String + | + + | contact_ids | + String + | + + | teammate_ids | + String + | + + | admin_assignee_id | + String + | + + | team_assignee_id | + String + | + + | open | + Boolean + | + + | state | + String + | + + | snoozed_until | Date (UNIX + timestamp) + | + + | ticket_attribute.{id} | String or Boolean or Date + (UNIX timestamp) or Float or Integer | + + + ### Accepted Operators + + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + + The table below shows the operators you can use to define how you want + to search for the value. The operator should be put in as a string + (`"="`). The operator has to be compatible with the field's type (eg. + you cannot search with `>` for a given string value as it's only + compatible for integer's and dates). + + + | Operator | Valid Types | + Description | + + | :------- | :----------------------------- | + :----------------------------------------------------------- | + + | = | All | + Equals | + + | != | All | Doesn't + Equal | + + | IN | All | In Shortcut for `OR` + queries Values most be in Array | + + | NIN | All | Not In Shortcut for `OR + !` queries Values must be in Array | + + | > | Integer Date (UNIX Timestamp) | Greater (or equal) + than | + + | < | Integer Date (UNIX Timestamp) | Lower (or equal) + than | + + | ~ | String | + Contains | + + | !~ | String | Doesn't + Contain | + + | ^ | String | Starts + With | + + | $ | String | Ends + With | + source: + openapi: ../openapi.yml + display-name: Search tickets + request: + body: + type: root.SearchRequest + content-type: application/json + response: + docs: successful + type: root.TicketList + examples: + - name: successful + request: + query: + operator: AND + value: + - field: created_at + operator: '>' + value: '1306054154' + pagination: + per_page: 5 + response: + body: + type: ticket.list + tickets: + - type: ticket + id: '494' + ticket_id: '53' + category: Back-office + ticket_attributes: + _default_title_: attribute_value + ticket_state: submitted + ticket_type: + type: ticket_type + id: '117' + category: Back-office + name: my-ticket-type-26 + description: my ticket type description is awesome. + icon: 🦁 + workspace_id: this_is_an_id667_that_should_be_at_least_ + ticket_type_attributes: + type: list + archived: false + created_at: 1719493065 + updated_at: 1719493065 + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c98a68186f43bafe92 + external_id: 6895b33e-2768-4611-908e-da6632dfc8ea + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493065 + updated_at: 1719493066 + open: true + snoozed_until: 1663597260 + linked_objects: + type: list + total_count: 0 + has_more: false + data: + - id: '7583' + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '135' + part_type: ticket_state_updated_by_admin + previous_ticket_state: submitted + ticket_state: submitted + created_at: 1719493066 + updated_at: 1719493066 + author: + type: admin + id: '991267940' + name: Ciaran472 Lee + email: admin472@email.com + attachments: + - type: upload + name: example.png + url: https://picsum.photos/200/300 + content_type: image/png + filesize: 100 + width: 100 + height: 100 + redacted: false + total_count: 1 + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + total_count: 1 + pages: + type: pages + page: 1 + next: + per_page: 2 + starting_after: your-cursor-from-response + per_page: 5 + total_pages: 1 + source: + openapi: ../openapi.yml + display-name: Tickets +docs: Everything about your tickets +", + }, + "visitors.yml": { + "absoluteFilepath": "/DUMMY_PATH", + "contents": { + "docs": "Everything about your Visitors", + "imports": { + "contacts": "contacts.yml", + "root": "__package__.yml", + }, + "service": { + "auth": false, + "base-path": "", + "display-name": "Visitors", + "endpoints": { + "convertVisitor": { + "auth": true, + "display-name": "Convert a visitor", + "docs": "You can merge a Visitor to a Contact of role type `lead` or `user`. + +> 📘 What happens upon a visitor being converted? +> +> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers. +", + "errors": [ + "root.UnauthorizedError", + ], + "examples": [ + { + "name": "successful", + "request": { + "type": "user", + "user": { + "email": "foo@bar.com", + }, + "visitor": { + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + }, + }, + "response": { + "body": { + "android_app_name": "Intercom", + "android_app_version": "5.0.0", + "android_device": "Pixel 3", + "android_last_seen_at": 1571672154, + "android_os_version": "10", + "android_sdk_version": "28", + "avatar": { + "image_url": "https://example.org/128Wash.jpg", + "type": "avatar", + }, + "browser": "Chrome", + "browser_language": "en-US", + "browser_version": "80.0.3987.132", + "companies": { + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/companies", + }, + "created_at": 1719493072, + "custom_attributes": { + "key": "value", + }, + "email": "foo@bar.com", + "email_domain": "example.com", + "external_id": "f3b87a2e09d514c6c2e79b9a", + "formatted_phone": "+1123456789", + "has_hard_bounced": false, + "id": "667d61d08a68186f43bafea2", + "ios_app_name": "Intercom", + "ios_app_version": "5.0.0", + "ios_device": "iPhone 11", + "ios_last_seen_at": 1571672154, + "ios_os_version": "13.3.1", + "ios_sdk_version": "13.3.1", + "language_override": "en", + "last_contacted_at": 1571672154, + "last_email_clicked_at": 1571672154, + "last_email_opened_at": 1571672154, + "last_replied_at": 1571672154, + "last_seen_at": 1571672154, + "location": { + "city": "Dublin", + "country": "Ireland", + "region": "Dublin", + "type": "location", + }, + "marked_email_as_spam": false, + "name": "John Doe", + "notes": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/notes", + }, + "os": "Mac OS X", + "owner_id": 123, + "phone": "+1123456789", + "role": "user", + "signed_up_at": 1719493072, + "social_profiles": { + "data": [ + { + "name": "Facebook", + "type": "social_profile", + "url": "http://twitter.com/th1sland", + }, + ], + }, + "tags": { + "data": [ + { + "id": "123", + "type": "note", + "url": "/contacts/5ba682d23d7cf92bef87bfd4/notes", + }, + ], + "has_more": false, + "total_count": 0, + "url": "/contacts/667d61d08a68186f43bafea2/tags", + }, + "type": "contact", + "unsubscribed_from_emails": false, + "updated_at": 1719493072, + "workspace_id": "this_is_an_id683_that_should_be_at_least_", + }, + }, + }, + ], + "method": "POST", + "pagination": undefined, + "path": "/visitors/convert", + "request": { + "body": { + "properties": { + "type": { + "docs": "Represents the role of the Contact model. Accepts `lead` or `user`.", + "type": "string", + }, + "user": "unknown", + "visitor": "unknown", + }, + }, + "content-type": "application/json", + "headers": undefined, + "name": "ConvertVisitorRequest", + "query-parameters": undefined, + }, + "response": { + "docs": "successful", + "type": "contacts.Contact", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "retrieveVisitorWithUserId": { + "auth": true, + "display-name": "Retrieve a visitor with User ID", + "docs": "You can fetch the details of a single visitor.", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "query-parameters": { + "user_id": "user_id", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id677_that_should_be_at_least_", + "avatar": { + "image_url": "https://example.com/avatar.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493070, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61ce8a68186f43bafe9b", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Jane Doe", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Red Duck from Dublin", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493070, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493070, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493070, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + ], + "method": "GET", + "pagination": undefined, + "path": "/visitors", + "request": { + "name": "RetrieveVisitorWithUserIdRequest", + "query-parameters": { + "user_id": { + "docs": "The user_id of the Visitor you want to retrieve.", + "type": "string", + }, + }, + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + "updateVisitor": { + "auth": true, + "display-name": "Update a visitor", + "docs": "Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + +**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + +**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. +", + "errors": [ + "root.UnauthorizedError", + "root.NotFoundError", + ], + "examples": [ + { + "name": "successful", + "request": { + "id": "667d61cc8a68186f43bafe95", + "name": "Gareth Bale", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "avatar": { + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493068, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61cc8a68186f43bafe95", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Gareth Bale", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Indigo Ghost", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493068, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493068, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493068, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + { + "name": "visitor Not Found", + "request": { + "name": "Christian Fail", + "user_id": "fail", + }, + "response": { + "body": { + "anonymous": true, + "app_id": "this_is_an_id671_that_should_be_at_least_", + "avatar": { + "image_url": "https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png", + "type": "avatar", + }, + "companies": { + "companies": [ + { + "app_id": "ecahpwf5", + "company_id": "6", + "created_at": 1663597223, + "custom_attributes": { + "monthly_spend": "custom_attributes", + "paid_subscriber": "custom_attributes", + "team_mates": "custom_attributes", + }, + "id": "531ee472cce572a6ec000006", + "industry": "Software", + "last_request_at": 1663597223, + "monthly_spend": 100, + "name": "Blue Sun", + "remote_created_at": 1663597223, + "session_count": 100, + "size": 100, + "updated_at": 1663597223, + "user_count": 100, + "website": "https://www.intercom.com", + }, + ], + "type": "company.list", + }, + "created_at": 1719493068, + "custom_attributes": { + "key": "value", + }, + "do_not_track": false, + "email": "", + "has_hard_bounced": false, + "id": "667d61cc8a68186f43bafe95", + "las_request_at": 1663597260, + "location_data": { + "city_name": "Dublin", + "continent_code": "EU", + "country_code": "IRL", + "country_name": "Ireland", + "postal_code": "D02 N960", + "region_name": "Leinster", + "timezone": "Europe/Dublin", + "type": "location_data", + }, + "marked_email_as_spam": false, + "name": "Gareth Bale", + "owner_id": "5169261", + "phone": "555-555-5555", + "pseudonym": "Indigo Ghost", + "referrer": "https://www.google.com/", + "remote_created_at": 1719493068, + "segments": { + "segments": [ + "segments", + ], + "type": "segment.list", + }, + "session_count": 0, + "signed_up_at": 1719493068, + "social_profiles": { + "social_profiles": [ + "social_profiles", + ], + "type": "social_profile.list", + }, + "tags": { + "tags": [ + { + "id": "8482", + "name": "tag_name", + }, + ], + "type": "tag.list", + }, + "type": "visitor", + "unsubscribed_from_emails": false, + "updated_at": 1719493068, + "user_id": "3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3", + "utm_campaign": "intercom-link", + "utm_content": "banner", + "utm_medium": "email", + "utm_source": "Intercom", + "utm_term": "messenger", + }, + }, + }, + ], + "method": "PUT", + "pagination": undefined, + "path": "/visitors", + "request": { + "body": "root.UpdateVisitorRequestOne", + "content-type": "application/json", + }, + "response": { + "docs": "successful", + "type": "optional", + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "source": { + "openapi": "../openapi.yml", + }, + }, + }, + "rawContents": "imports: + root: __package__.yml + contacts: contacts.yml +service: + auth: false + base-path: '' + endpoints: + retrieveVisitorWithUserId: + path: /visitors + method: GET + auth: true + docs: You can fetch the details of a single visitor. + source: + openapi: ../openapi.yml + display-name: Retrieve a visitor with User ID + request: + name: RetrieveVisitorWithUserIdRequest + query-parameters: + user_id: + type: string + docs: The user_id of the Visitor you want to retrieve. + response: + docs: successful + type: optional + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + query-parameters: + user_id: user_id + response: + body: + type: visitor + id: 667d61ce8a68186f43bafe9b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Jane Doe + pseudonym: Red Duck from Dublin + avatar: + type: avatar + image_url: https://example.com/avatar.png + app_id: this_is_an_id677_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493070 + remote_created_at: 1719493070 + signed_up_at: 1719493070 + updated_at: 1719493070 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + updateVisitor: + path: /visitors + method: PUT + auth: true + docs: > + Sending a PUT request to `/visitors` will result in an update of an + existing Visitor. + + + **Option 1.** You can update a visitor by passing in the `user_id` of + the visitor in the Request body. + + + **Option 2.** You can update a visitor by passing in the `id` of the + visitor in the Request body. + source: + openapi: ../openapi.yml + display-name: Update a visitor + request: + body: root.UpdateVisitorRequestOne + content-type: application/json + response: + docs: successful + type: optional + errors: + - root.UnauthorizedError + - root.NotFoundError + examples: + - name: successful + request: + id: 667d61cc8a68186f43bafe95 + name: Gareth Bale + response: + body: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + - name: visitor Not Found + request: + user_id: fail + name: Christian Fail + response: + body: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: 555-555-5555 + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: >- + https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: + - id: 531ee472cce572a6ec000006 + name: Blue Sun + app_id: ecahpwf5 + company_id: '6' + remote_created_at: 1663597223 + created_at: 1663597223 + updated_at: 1663597223 + last_request_at: 1663597223 + size: 100 + website: https://www.intercom.com + industry: Software + monthly_spend: 100 + session_count: 100 + user_count: 100 + custom_attributes: + paid_subscriber: custom_attributes + monthly_spend: custom_attributes + team_mates: custom_attributes + location_data: + type: location_data + city_name: Dublin + continent_code: EU + country_code: IRL + country_name: Ireland + postal_code: D02 N960 + region_name: Leinster + timezone: Europe/Dublin + las_request_at: 1663597260 + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: + - social_profiles + owner_id: '5169261' + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: + - id: '8482' + name: tag_name + segments: + type: segment.list + segments: + - segments + custom_attributes: + key: value + referrer: https://www.google.com/ + utm_campaign: intercom-link + utm_content: banner + utm_medium: email + utm_source: Intercom + utm_term: messenger + do_not_track: false + convertVisitor: + path: /visitors/convert + method: POST + auth: true + docs: > + You can merge a Visitor to a Contact of role type `lead` or `user`. + + + > 📘 What happens upon a visitor being converted? + + > + + > If the User exists, then the Visitor will be merged into it, the + Visitor deleted and the User returned. If the User does not exist, the + Visitor will be converted to a User, with the User identifiers replacing + it's Visitor identifiers. + source: + openapi: ../openapi.yml + display-name: Convert a visitor + request: + name: ConvertVisitorRequest + body: + properties: + type: + type: string + docs: >- + Represents the role of the Contact model. Accepts `lead` or + `user`. + user: unknown + visitor: unknown + content-type: application/json + response: + docs: successful + type: contacts.Contact + errors: + - root.UnauthorizedError + examples: + - name: successful + request: + type: user + user: + email: foo@bar.com + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + response: + body: + type: contact + id: 667d61d08a68186f43bafea2 + external_id: f3b87a2e09d514c6c2e79b9a + workspace_id: this_is_an_id683_that_should_be_at_least_ + role: user + email: foo@bar.com + email_domain: example.com + phone: '+1123456789' + formatted_phone: '+1123456789' + name: John Doe + owner_id: 123 + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719493072 + updated_at: 1719493072 + signed_up_at: 1719493072 + last_seen_at: 1571672154 + last_replied_at: 1571672154 + last_contacted_at: 1571672154 + last_email_opened_at: 1571672154 + last_email_clicked_at: 1571672154 + language_override: en + browser: Chrome + browser_version: 80.0.3987.132 + browser_language: en-US + os: Mac OS X + android_app_name: Intercom + android_app_version: 5.0.0 + android_device: Pixel 3 + android_os_version: '10' + android_sdk_version: '28' + android_last_seen_at: 1571672154 + ios_app_name: Intercom + ios_app_version: 5.0.0 + ios_device: iPhone 11 + ios_os_version: 13.3.1 + ios_sdk_version: 13.3.1 + ios_last_seen_at: 1571672154 + custom_attributes: + key: value + avatar: + type: avatar + image_url: https://example.org/128Wash.jpg + tags: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d61d08a68186f43bafea2/tags + total_count: 0 + has_more: false + notes: + data: + - type: note + id: '123' + url: /contacts/5ba682d23d7cf92bef87bfd4/notes + url: /contacts/667d61d08a68186f43bafea2/notes + total_count: 0 + has_more: false + companies: + url: /contacts/667d61d08a68186f43bafea2/companies + total_count: 0 + has_more: false + location: + type: location + country: Ireland + region: Dublin + city: Dublin + social_profiles: + data: + - type: social_profile + name: Facebook + url: http://twitter.com/th1sland + source: + openapi: ../openapi.yml + display-name: Visitors +docs: Everything about your Visitors +", + }, + }, + "packageMarkers": {}, + "rootApiFile": { + "contents": { + "auth": "BearerAuthScheme", + "auth-schemes": { + "BearerAuthScheme": { + "scheme": "bearer", + }, + }, + "default-environment": "Default", + "display-name": "Intercom API", + "environments": { + "Default": "https://api.intercom.io", + }, + "error-discrimination": { + "strategy": "status-code", + }, + "headers": { + "Intercom-Version": { + "name": "intercomVersion", + "type": "optional", + }, + }, + "imports": { + "root": "__package__.yml", + }, + "name": "api", + }, + "defaultUrl": undefined, + "rawContents": "name: api +error-discrimination: + strategy: status-code +display-name: Intercom API +environments: + Default: https://api.intercom.io +default-environment: Default +imports: + root: __package__.yml +headers: + Intercom-Version: + type: optional + name: intercomVersion +auth-schemes: + BearerAuthScheme: + scheme: bearer +auth: BearerAuthScheme +", + }, +} \ No newline at end of file diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/fern.config.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/fern.config.json new file mode 100644 index 00000000000..7980537f564 --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization": "fern", + "version": "*" +} \ No newline at end of file diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml new file mode 100644 index 00000000000..602118874c2 --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml @@ -0,0 +1,3 @@ +api: + specs: + - openapi: ../openapi.yml diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/openapi.yml b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/openapi.yml new file mode 100644 index 00000000000..d5b09adb2c9 --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/openapi.yml @@ -0,0 +1,17297 @@ +--- +openapi: 3.0.1 +info: + title: Intercom API + version: '2.11' + description: The intercom API reference. + contact: + name: Intercom Developer Hub + url: https://developers.intercom.com + license: + name: MIT + url: https://spdx.org/licenses/MIT +paths: + "/me": + get: + summary: Identify an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: identifyAdmin + description: "\nYou can view the currently authorised admin along with the embedded + app object (a \"workspace\" in legacy terminology).\n\n> \U0001F6A7 Single + Sign On\n>\n> If you are building a custom \"Log in with Intercom\" flow for + your site, and you call the `/me` endpoint to identify the logged-in user, + you should not accept any sign-ins from users with unverified email addresses + as it poses a potential impersonation security risk.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267390' + email: admin1@email.com + name: Ciaran1 Lee + email_verified: true + app: + type: app + id_code: this_is_an_id1_that_should_be_at_least_40 + name: MyApp 1 + created_at: 1719492696 + secure: false + identity_verification: false + timezone: America/Los_Angeles + region: US + avatar: + type: avatar + image_url: https://static.intercomassets.com/assets/default-avatars/admins/128.png + has_inbox_seat: true + schema: + "$ref": "#/components/schemas/admin_with_app" + "/admins/{id}/away": + put: + summary: Set an admin to away + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + schema: + type: integer + tags: + - Admins + operationId: setAwayAdmin + description: You can set an Admin as away for the Inbox. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin + id: '991267391' + name: Ciaran2 Lee + email: admin2@email.com + away_mode_enabled: true + away_mode_reassign: true + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 9818bd03-9cc6-4ab8-8e7c-20a45ac58e97 + errors: + - code: admin_not_found + message: Admin for admin_id not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18722269-a019-46c4-87d7-50d0f6f8a990 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - away_mode_enabled + - away_mode_reassign + properties: + away_mode_enabled: + type: boolean + description: Set to "true" to change the status of the admin to + away. + example: true + default: true + away_mode_reassign: + type: boolean + description: Set to "true" to assign any new conversation replies + to your default inbox. + example: false + default: false + examples: + successful_response: + summary: Successful response + value: + away_mode_enabled: true + away_mode_reassign: true + admin_not_found: + summary: Admin not found + value: + away_mode_enabled: true + away_mode_reassign: true + unauthorized: + summary: Unauthorized + value: + away_mode_enabled: true + away_mode_reassign: true + "/admins/activity_logs": + get: + summary: List all activity logs + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: created_at_after + in: query + required: true + description: The start date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677253093' + schema: + type: string + - name: created_at_before + in: query + required: false + description: The end date that you request data for. It must be formatted + as a UNIX timestamp. + example: '1677861493' + schema: + type: string + tags: + - Admins + operationId: listActivityLogs + description: You can get a log of activities by all admins in an app. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: activity_log.list + pages: + type: pages + next: + page: 1 + per_page: 20 + total_pages: 1 + activity_logs: + - id: ddee3a18-0032-4061-b9b9-26230c3dd5f7 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + message: + id: 123 + title: Initial message title + before: Initial message title + after: Eventual message title + created_at: 1719492702 + activity_type: message_state_change + activity_description: Ciaran5 Lee changed your Initial message + title message from Initial message title to Eventual message + title. + - id: 5eec951b-db7a-4b5b-add5-95ffc90969b6 + performed_by: + type: admin + id: '991267395' + email: admin5@email.com + ip: 127.0.0.1 + metadata: + before: before + after: after + created_at: 1719492702 + activity_type: app_name_change + activity_description: Ciaran5 Lee changed your app name from + before to after. + schema: + "$ref": "#/components/schemas/activity_log_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 06d9eefd-2b3a-48f7-938a-5a10383a4ebf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins": + get: + summary: List all admins + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Admins + operationId: listAdmins + description: You can fetch a list of admins for a given workspace. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: admin.list + admins: + - type: admin + email: admin7@email.com + id: '991267397' + name: Ciaran7 Lee + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4ba8121e-4a4a-4668-adb2-363c561f3c52 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/admins/{id}": + get: + summary: Retrieve an admin + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given admin + example: 123 + schema: + type: integer + tags: + - Admins + operationId: retrieveAdmin + description: You can retrieve the details of a single admin. + responses: + '200': + description: Admin found + content: + application/json: + examples: + Admin found: + value: + type: admin + id: '991267399' + name: Ciaran9 Lee + email: admin9@email.com + away_mode_enabled: false + away_mode_reassign: false + has_inbox_seat: true + team_ids: [] + schema: + "$ref": "#/components/schemas/admin" + '404': + description: Admin not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 989bdb0b-1e8c-46cc-8953-9733dad40562 + errors: + - code: admin_not_found + message: Admin not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 83978032-1473-4696-b755-b497d46a23cf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles": + get: + summary: List all articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: listArticles + description: "You can fetch a list of all articles by making a GET request to + `https://api.intercom.io/articles`.\n\n> \U0001F4D8 How are the articles sorted + and ordered?\n>\n> Articles will be returned in descending order on the `updated_at` + attribute. This means if you need to iterate through results then we'll show + the most recently updated articles first.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + type: pages + page: 1 + per_page: 25 + total_pages: 1 + total_count: 1 + data: + - id: '39' + type: article + workspace_id: this_is_an_id33_that_should_be_at_least_4 + parent_id: 143 + parent_type: collection + parent_ids: [] + title: This is the article title + description: '' + body: '' + author_id: 991267402 + state: published + created_at: 1719492707 + updated_at: 1719492707 + url: http://help-center.test/myapp-33/en/articles/39-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 86d69044-5966-428e-9a40-2b39fba3f823 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Articles + operationId: createArticle + description: You can create a new article by making a POST request to `https://api.intercom.io/articles`. + responses: + '200': + description: article created + content: + application/json: + examples: + article created: + value: + id: '42' + type: article + workspace_id: this_is_an_id37_that_should_be_at_least_4 + parent_id: 145 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Thanks for everything + description: Description of the Article + body:

Body of the Article

+ author_id: 991267407 + state: published + created_at: 1719492710 + updated_at: 1719492710 + url: http://help-center.test/myapp-37/en/articles/42-thanks-for-everything + schema: + "$ref": "#/components/schemas/article" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: e0ea220d-8030-4e0c-9fa9-6b40e9ed4fbd + errors: + - code: parameter_not_found + message: author_id must be in the main body or default locale + translated_content object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f223a1d9-5377-4337-92bb-00fb39157f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_article_request" + examples: + article_created: + summary: article created + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + author_id: 991267407 + state: published + parent_id: 145 + parent_type: collection + translated_content: + fr: + title: Merci pour tout + description: Description de l'article + body: Corps de l'article + author_id: 991267407 + state: published + bad_request: + summary: Bad Request + value: + title: Thanks for everything + description: Description of the Article + body: Body of the Article + state: published + "/articles/{id}": + get: + summary: Retrieve an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: retrieveArticle + description: You can fetch the details of a single article by making a GET request + to `https://api.intercom.io/articles/`. + responses: + '200': + description: Article found + content: + application/json: + examples: + Article found: + value: + id: '45' + type: article + workspace_id: this_is_an_id43_that_should_be_at_least_4 + parent_id: 148 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: This is the article title + description: '' + body: '' + author_id: 991267412 + state: published + created_at: 1719492712 + updated_at: 1719492712 + url: http://help-center.test/myapp-43/en/articles/45-this-is-the-article-title + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article not found + content: + application/json: + examples: + Article not found: + value: + type: error.list + request_id: 99c73902-e8ea-4872-b412-1d55ce4582fb + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 62ab4791-7e4d-4400-a56b-b06a0ce3ba1a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: updateArticle + description: You can update the details of a single article by making a PUT + request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '48' + type: article + workspace_id: this_is_an_id49_that_should_be_at_least_4 + parent_id: 151 + parent_type: collection + parent_ids: [] + statistics: + type: article_statistics + views: 0 + conversations: 0 + reactions: 0 + happy_reaction_percentage: 0 + neutral_reaction_percentage: 0 + sad_reaction_percentage: 0 + title: Christmas is here! + description: '' + body:

New gifts in store for the jolly season

+ author_id: 991267418 + state: published + created_at: 1719492714 + updated_at: 1719492714 + url: http://help-center.test/myapp-49/en/articles/48-christmas-is-here + schema: + "$ref": "#/components/schemas/article" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 891b6ff4-181f-4b98-861b-d34ef16bfc4b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 15b4f214-c670-43d7-ad8f-648791fddf9b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_article_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + article_not_found: + summary: Article Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + delete: + summary: Delete an article + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the article which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Articles + operationId: deleteArticle + description: You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '51' + object: article + deleted: true + schema: + "$ref": "#/components/schemas/deleted_article_object" + '404': + description: Article Not Found + content: + application/json: + examples: + Article Not Found: + value: + type: error.list + request_id: 60da5f23-613c-4f84-84bd-e9dbd3d67187 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 85d43c53-f28f-4295-b937-9a43ea71d0c3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/articles/search": + get: + summary: Search for articles + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: phrase + in: query + required: false + description: The phrase within your articles to search for. + example: Getting started + schema: + type: string + - name: state + in: query + required: false + description: The state of the Articles returned. One of `published`, `draft` + or `all`. + example: published + schema: + type: string + - name: help_center_id + in: query + required: false + description: The ID of the Help Center to search in. + example: 123 + schema: + type: integer + - name: highlight + in: query + required: false + description: Return a highlighted version of the matching content within your + articles. Refer to the response schema for more details. + example: false + schema: + type: boolean + tags: + - Articles + operationId: searchArticles + description: You can search for articles by making a GET request to `https://api.intercom.io/articles/search`. + responses: + '200': + description: Search successful + content: + application/json: + examples: + Search successful: + value: + type: list + total_count: 1 + data: + articles: + - id: '55' + type: article + workspace_id: this_is_an_id61_that_should_be_at_least_4 + parent_id: + parent_type: + parent_ids: [] + title: Title 1 + description: '' + body: '' + author_id: 991267431 + state: draft + created_at: 1719492719 + updated_at: 1719492719 + url: + highlights: [] + pages: + type: pages + page: 1 + total_pages: 1 + per_page: 10 + schema: + "$ref": "#/components/schemas/article_search_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 626c6766-ee1a-489d-b87a-230d9b980c7d + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/collections": + get: + summary: List all collections + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listAllCollections + description: | + You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`. + + Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - id: '159' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-65/collection-17 + order: 17 + created_at: 1719492720 + updated_at: 1719492720 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 79 + - id: '160' + workspace_id: this_is_an_id65_that_should_be_at_least_4 + name: English section title + url: http://help-center.test/myapp-65/section-1 + order: 1 + created_at: 1719492720 + updated_at: 1719492720 + description: + icon: bookmark + parent_id: '159' + help_center_id: + total_count: 2 + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + schema: + "$ref": "#/components/schemas/collection_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ccedcb48-7d08-4cc9-bcff-0622f70daf74 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: createCollection + description: You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.` + responses: + '200': + description: collection created + content: + application/json: + examples: + collection created: + value: + id: '165' + workspace_id: this_is_an_id69_that_should_be_at_least_4 + name: Thanks for everything + url: http://help-center.test/myapp-69/ + order: 1 + created_at: 1719492721 + updated_at: 1719492721 + description: '' + icon: book-bookmark + parent_id: + help_center_id: 81 + schema: + "$ref": "#/components/schemas/collection" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 1f4fd741-8681-4c21-911a-47d7bb39d080 + errors: + - code: parameter_not_found + message: Name is a required parameter. + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8afa14e4-0e7c-4159-8aab-dfa3dcb6a8b4 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_collection_request" + examples: + collection_created: + summary: collection created + value: + name: Thanks for everything + bad_request: + summary: Bad Request + value: + description: Missing required parameter + "/help_center/collections/{id}": + get: + summary: Retrieve a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveCollection + description: You can fetch the details of a single collection by making a GET + request to `https://api.intercom.io/help_center/collections/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '170' + workspace_id: this_is_an_id75_that_should_be_at_least_4 + name: English collection title + url: http://help-center.test/myapp-75/collection-22 + order: 22 + created_at: 1719492723 + updated_at: 1719492723 + description: english collection description + icon: bookmark + parent_id: + help_center_id: 84 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: 2970f0f3-7020-4382-8892-eac24818ca88 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bf1acd76-8c6e-45f4-8dbe-54391843270a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: updateCollection + description: You can update the details of a single collection by making a PUT + request to `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '176' + workspace_id: this_is_an_id81_that_should_be_at_least_4 + name: Update collection name + url: http://help-center.test/myapp-81/collection-25 + order: 25 + created_at: 1719492724 + updated_at: 1719492724 + description: english collection description + icon: folder + parent_id: + help_center_id: 87 + schema: + "$ref": "#/components/schemas/collection" + '404': + description: Collection Not Found + content: + application/json: + examples: + Collection Not Found: + value: + type: error.list + request_id: 35e7f185-f547-4ae1-a23d-afc9027fc5a6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 67002700-07f8-4a56-a9bc-464254c3a5bd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_collection_request" + examples: + successful: + summary: successful + value: + name: Update collection name + collection_not_found: + summary: Collection Not Found + value: + name: Update collection name + delete: + summary: Delete a collection + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: deleteCollection + description: You can delete a single collection by making a DELETE request to + `https://api.intercom.io/collections/`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '182' + object: collection + deleted: true + schema: + "$ref": "#/components/schemas/deleted_collection_object" + '404': + description: collection Not Found + content: + application/json: + examples: + collection Not Found: + value: + type: error.list + request_id: a35712b4-90b6-47fb-843d-757d9fdd81e6 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e00bc89b-b9a9-4bc2-84a0-5c9d4710bfcf + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers/{id}": + get: + summary: Retrieve a Help Center + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the collection which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - Help Center + operationId: retrieveHelpCenter + description: You can fetch the details of a single Help Center by making a GET + request to `https://api.intercom.io/help_center/help_center/`. + responses: + '200': + description: Collection found + content: + application/json: + examples: + Collection found: + value: + id: '93' + workspace_id: this_is_an_id93_that_should_be_at_least_4 + created_at: 1719492727 + updated_at: 1719492727 + identifier: help-center-1 + website_turned_on: false + display_name: Intercom Help Center + schema: + "$ref": "#/components/schemas/help_center" + '404': + description: Collection not found + content: + application/json: + examples: + Collection not found: + value: + type: error.list + request_id: c6e7d3f6-8a46-460e-8264-e07c2e7302aa + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 794a475b-0155-40b2-a288-ba0d48fdbd3f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/help_center/help_centers": + get: + summary: List all Help Centers + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Help Center + operationId: listHelpCenters + description: You can list all Help Centers by making a GET request to `https://api.intercom.io/help_center/help_centers`. + responses: + '200': + description: Help Centers found + content: + application/json: + examples: + Help Centers found: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/help_center_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c96a4779-a06d-45bb-aa39-eb96c587c2c7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies": + post: + summary: Create or Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Companies + operationId: createOrUpdateCompany + description: | + You can create or update a company. + + Companies will be only visible in Intercom when there is at least one associated user. + + Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated. + + {% admonition type="attention" name="Using `company_id`" %} + You can set a unique `company_id` value when creating a company. However, it is not possible to update `company_id`. Be sure to set a unique value once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: company_remote_id + id: 667d607c8a68186f43bafd1e + app_id: this_is_an_id116_that_should_be_at_least_ + name: my company + remote_created_at: 1374138000 + created_at: 1719492732 + updated_at: 1719492732 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: + creation_source: api + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: + errors: + - code: bad_request + message: bad 'test' parameter + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 9b0d6fb9-d2d7-4904-a13c-97557a802323 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_or_update_company_request" + examples: + successful: + summary: Successful + value: + company_id: company_remote_id + name: my company + remote_created_at: 1374138000 + bad_request: + summary: Bad Request + value: + test: invalid + get: + summary: Retrieve companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: name + in: query + required: false + description: The `name` of the company to filter by. + example: my company + schema: + type: string + - name: company_id + in: query + required: false + description: The `company_id` of the company to filter by. + example: '12345' + schema: + type: string + - name: tag_id + in: query + required: false + description: The `tag_id` of the company to filter by. + example: '678910' + schema: + type: string + - name: segment_id + in: query + required: false + description: The `segment_id` of the company to filter by. + example: '98765' + schema: + type: string + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to display per page. Defaults to 15 + example: 15 + schema: + type: integer + tags: + - Companies + operationId: retrieveCompany + description: | + You can fetch a single company by passing in `company_id` or `name`. + + `https://api.intercom.io/companies?name={name}` + + `https://api.intercom.io/companies?company_id={company_id}` + + You can fetch all companies and filter by `segment_id` or `tag_id` as a query parameter. + + `https://api.intercom.io/companies?tag_id={tag_id}` + + `https://api.intercom.io/companies?segment_id={segment_id}` + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d607e8a68186f43bafd26 + app_id: this_is_an_id122_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492734 + created_at: 1719492734 + updated_at: 1719492734 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: c97dd75f-a434-4c83-a8e8-c4d1887d6c48 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6ef54f1c-70a4-4779-b3a6-29e4fd65d9dd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}": + get: + summary: Retrieve a company by ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: RetrieveACompanyById + description: You can fetch a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60808a68186f43bafd31 + app_id: this_is_an_id128_that_should_be_at_least_ + name: company1 + remote_created_at: 1719492736 + created_at: 1719492736 + updated_at: 1719492736 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b49593ed-49a6-4497-8fb7-220ff74527f6 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c4e2fcb8-815e-4bee-80c7-9d5b1ab0f6fe + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: UpdateCompany + description: | + You can update a single company using the Intercom provisioned `id`. + + {% admonition type="attention" name="Using `company_id`" %} + When updating a company it is not possible to update `company_id`. This can only be set once upon creation of the company. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60828a68186f43bafd3b + app_id: this_is_an_id134_that_should_be_at_least_ + name: company2 + remote_created_at: 1719492738 + created_at: 1719492738 + updated_at: 1719492738 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: b1ce72df-630f-4925-b212-fca6e833eb8d + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3f26a216-ddff-4782-9529-514f5bad56ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: deleteCompany + description: You can delete a single company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 667d60848a68186f43bafd45 + object: company + deleted: true + schema: + "$ref": "#/components/schemas/deleted_company_object" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 35a9b551-331e-499e-a63f-20396bfd29f5 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0a1a5065-69fe-47a4-9804-4cb2347671ef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/contacts": + get: + summary: List attached contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + - Contacts + operationId: ListAttachedContacts + description: You can fetch a list of all contacts that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 50 + total_pages: 0 + schema: + "$ref": "#/components/schemas/company_attached_contacts" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: a6381081-a166-4e8e-952d-38bb2cd1c2b4 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe20b681-f988-4154-bec9-a5087fe0842e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/{id}/segments": + get: + summary: List attached segments for companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632 + schema: + type: string + tags: + - Companies + operationId: ListAttachedSegmentsForCompanies + description: You can fetch a list of all segments that belong to a company. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: [] + schema: + "$ref": "#/components/schemas/company_attached_segments" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 22add598-fd33-4c34-971f-cf215117aab3 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 66fcc654-48ed-4f53-824e-831b5c96c9dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/list": + post: + summary: List all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: page + in: query + required: false + description: The page of results to fetch. Defaults to first page + example: 1 + schema: + type: integer + - name: per_page + in: query + required: false + description: How many results to return per page. Defaults to 15 + example: 15 + schema: + type: integer + - name: order + in: query + required: false + description: "`asc` or `desc`. Return the companies in ascending or descending + order. Defaults to desc" + example: desc + schema: + type: string + tags: + - Companies + operationId: listAllCompanies + description: | + You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first. + + Note that the API does not include companies who have no associated users in list responses. + + When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies). + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608a8a68186f43bafd61 + app_id: this_is_an_id158_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492746 + created_at: 1719492746 + updated_at: 1719492746 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 15 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/company_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6f8cb4ca-9a95-43bd-aee1-597b85d1d13f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/companies/scroll": + get: + summary: Scroll over all companies + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: scroll_param + in: query + required: false + description: '' + schema: + type: string + tags: + - Companies + operationId: scrollOverAllCompanies + description: |2 + The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset. + + - Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app. + - If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail + - If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire + + {% admonition type="info" name="Scroll Parameter" %} + You can get the first page of companies by simply sending a GET request to the scroll endpoint. + For subsequent requests you will need to use the scroll parameter from the response. + {% /admonition %} + {% admonition type="danger" name="Scroll network timeouts" %} + Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message: + "Request failed due to an internal network error. Please restart the scroll operation." + If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll. + {% /admonition %} + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: company + company_id: remote_companies_scroll_2 + id: 667d608b8a68186f43bafd67 + app_id: this_is_an_id162_that_should_be_at_least_ + name: IntercomQATest1 + remote_created_at: 1719492747 + created_at: 1719492747 + updated_at: 1719492747 + monthly_spend: 0 + session_count: 0 + user_count: 4 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + total_count: + scroll_param: 12d403b5-dc79-47b5-8ea1-01a5ac8cb6cc + schema: + "$ref": "#/components/schemas/company_scroll" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4b3ca8b1-8983-4fb8-abc5-b20a4ece5d32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/companies": + post: + summary: Attach a Contact to a Company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + schema: + type: string + tags: + - Companies + - Contacts + operationId: attachContactToACompany + description: You can attach a company to a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d608d8a68186f43bafd70 + app_id: this_is_an_id166_that_should_be_at_least_ + name: company6 + remote_created_at: 1719492749 + created_at: 1719492749 + updated_at: 1719492749 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '400': + description: Bad Request + content: + application/json: + examples: + Bad Request: + value: + type: error.list + request_id: 9297dcfc-1896-43a3-a3f9-131238422ed2 + errors: + - code: parameter_not_found + message: company not specified + schema: + "$ref": "#/components/schemas/error" + '404': + description: Company Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: 32d121d8-fcbf-4c59-9c60-204f7d602f36 + errors: + - code: company_not_found + message: Company Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99739bbd-2dbe-4ce3-ae91-af23379b5cd7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + x-fern-property-name: companyId + type: string + description: The unique identifier for the company which is given + by Intercom + example: 58a430d35458202d41b1e65b + examples: + successful: + summary: Successful + value: + id: 667d608d8a68186f43bafd70 + bad_request: + summary: Bad Request + value: + company_not_found: + summary: Company Not Found + value: + id: '123' + get: + summary: List attached companies for contact + parameters: + - name: id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Companies + operationId: listCompaniesForAContact + description: You can fetch a list of companies that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: company + company_id: '1' + id: 667d60938a68186f43bafd91 + app_id: this_is_an_id182_that_should_be_at_least_ + name: company12 + remote_created_at: 1719492755 + created_at: 1719492755 + updated_at: 1719492755 + last_request_at: 1719319955 + monthly_spend: 0 + session_count: 0 + user_count: 1 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + total_count: 1 + schema: + "$ref": "#/components/schemas/contact_attached_companies" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: b9d7374d-1780-4668-bb62-0e1ff9cdab45 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d211ec8c-df9b-420c-86df-23c27ad54bc5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/companies/{id}": + delete: + summary: Detach a contact from a company + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + required: true + description: The unique identifier for the contact which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the company which is given by Intercom + example: 58a430d35458202d41b1e65b + schema: + type: string + tags: + - Companies + - Contacts + operationId: detachContactFromACompany + description: You can detach a company from a single contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: company + company_id: '1' + id: 667d60918a68186f43bafd80 + app_id: this_is_an_id174_that_should_be_at_least_ + name: company8 + remote_created_at: 1719492753 + created_at: 1719492753 + updated_at: 1719492753 + monthly_spend: 0 + session_count: 0 + user_count: 0 + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + plan: {} + custom_attributes: {} + schema: + "$ref": "#/components/schemas/company" + '404': + description: Contact Not Found + content: + application/json: + examples: + Company Not Found: + value: + type: error.list + request_id: cd4f1648-724c-45f0-b6e1-72a1bc6479ee + errors: + - code: company_not_found + message: Company Not Found + Contact Not Found: + value: + type: error.list + request_id: d316defc-0a2f-49e7-b8ff-4cb6ccf46c90 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d8c1ab2d-4044-4c4f-98f0-176860747112 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}/notes": + get: + summary: List all notes + parameters: + - name: id + in: path + required: true + description: The unique identifier of a contact. + schema: + type: integer + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Notes + - Contacts + operationId: listNotes + description: You can fetch a list of notes that are associated to a contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: note + id: '29' + created_at: 1718887958 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '28' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + - type: note + id: '27' + created_at: 1718801558 + contact: + type: contact + id: 667d60968a68186f43bafd9c + author: + type: admin + id: '991267491' + name: Ciaran101 Lee + email: admin101@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + total_count: 3 + pages: + type: pages + next: + page: 1 + per_page: 50 + total_pages: 1 + schema: + "$ref": "#/components/schemas/note_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: e93f90a6-4c85-4dbf-b063-96b649318371 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given contact. + example: '123' + schema: + type: integer + tags: + - Notes + - Contacts + operationId: createNote + description: You can add a note to a single contact. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: note + id: '34' + created_at: 1719492759 + contact: + type: contact + id: 667d60978a68186f43bafd9e + author: + type: admin + id: '991267493' + name: Ciaran103 Lee + email: admin103@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

Hello

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Contact not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: d7c69ce6-3195-46be-b2cb-0dce355d2919 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 2e3bd274-9ac6-43c3-a419-bcc8e6a03a1d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - body + properties: + body: + type: string + description: The text of the note. + example: New note + contact_id: + type: string + description: The unique identifier of a given contact. + example: '123' + admin_id: + type: string + description: The unique identifier of a given admin. + example: '123' + examples: + successful_response: + summary: Successful response + value: + contact_id: 667d60978a68186f43bafd9e + admin_id: 991267493 + body: Hello + admin_not_found: + summary: Admin not found + value: + contact_id: 667d60988a68186f43bafd9f + admin_id: 123 + body: Hello + contact_not_found: + summary: Contact not found + value: + contact_id: 123 + admin_id: 991267495 + body: Hello + "/contacts/{contact_id}/segments": + get: + summary: List attached segments for contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Segments + operationId: listSegmentsForAContact + description: You can fetch a list of segments that are associated to a contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: segment + id: 667d60998a68186f43bafda1 + name: segment + created_at: 1719492761 + updated_at: 1719492761 + person_type: user + schema: + "$ref": "#/components/schemas/contact_segments" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7d4ab1a9-5990-4338-b5d9-0f3f55f1acb7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d2927c64-9c5a-4593-997b-381f8c2356ea + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/subscriptions": + get: + summary: List subscriptions for a contact + parameters: + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + - Subscription Types + operationId: listSubscriptionsForAContact + description: | + You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type. + This will return a list of Subscription Type objects that the contact is associated with. + + The data property will show a combined list of: + + 1.Opt-out subscription types that the user has opted-out from. + 2.Opt-in subscription types that the user has opted-in to receiving. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '93' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + - type: subscription + id: '95' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 3f481052-cf49-4b95-a492-734223865981 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82a95655-569d-4e5d-b0d9-f8a6c7a379f3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add subscription to a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachSubscriptionTypeToContact + description: | + You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in: + + 1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type. + + 2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type. + + This will return a subscription type model for the subscription type that was added to the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '108' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: cf0f6fd6-7c5e-492b-909d-f60b35eea1c4 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 3f852f45-1a80-4ade-9bc6-72b377d2bbd8 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 377d162e-82a5-4148-a26f-29c9c760dadc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - consent_type + properties: + id: + type: string + description: The unique identifier for the subscription which is + given by Intercom + example: '37846' + consent_type: + type: string + description: The consent_type of a subscription, opt_out or opt_in. + example: opt_in + examples: + successful: + summary: Successful + value: + id: 108 + consent_type: opt_in + contact_not_found: + summary: Contact not found + value: + id: 112 + consent_type: opt_in + resource_not_found: + summary: Resource not found + value: + id: invalid_id + consent_type: opt_in + "/contacts/{contact_id}/subscriptions/{id}": + delete: + summary: Remove subscription from a contact + tags: + - Subscription Types + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the subscription type which is given + by Intercom + example: '37846' + required: true + schema: + type: string + operationId: detachSubscriptionTypeToContact + description: You can remove a specific subscription from a contact. This will + return a subscription type model for the subscription type that was removed + from the contact. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: subscription + id: '124' + state: live + consent_type: opt_in + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - sms_message + schema: + "$ref": "#/components/schemas/subscription_type" + '404': + description: Resource not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 7bc429e4-e887-4f53-b69c-94e6e55d2125 + errors: + - code: not_found + message: User Not Found + Resource not found: + value: + type: error.list + request_id: 66ebc1f5-5e02-4584-8028-f2559a41e8df + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 99fba0c6-2252-4658-abd2-1d2ff16a508b + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{contact_id}/tags": + get: + summary: List tags attached to a contact + tags: + - Contacts + - Tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: listTagsForAContact + description: You can fetch a list of all tags that are attached to a specific + contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '93' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag_list" + '404': + description: Contact not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 2b513026-b78c-4c67-b073-da0266f62cc7 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 97383559-0fb0-4084-8a9a-8e3407c46108 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Add tag to a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + operationId: attachTagToContact + description: You can tag a specific contact. This will return a tag object for + the tag that was added to the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '94' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 1bbd7e4b-718e-46f4-b682-a429aea78f01 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: a1a28017-728a-423b-adc0-2705d375f533 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 63a2828f-107e-4d51-9398-a220b81a7bce + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + examples: + successful: + summary: successful + value: + id: 94 + contact_not_found: + summary: Contact not found + value: + id: 95 + tag_not_found: + summary: Tag not found + value: + id: '123' + "/contacts/{contact_id}/tags/{id}": + delete: + summary: Remove tag from a contact + tags: + - Tags + - Contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: contact_id + in: path + description: The unique identifier for the contact which is given by Intercom + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + operationId: detachTagFromContact + description: You can remove tag from a specific contact. This will return a + tag object for the tag that was removed from the contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '97' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Contact not found: + value: + type: error.list + request_id: 6f735483-c309-4e94-b9ab-143aedc0c691 + errors: + - code: not_found + message: User Not Found + Tag not found: + value: + type: error.list + request_id: 9e780671-29b3-4913-b4be-15234ea0bc6a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e97d9f1b-8c9e-4caf-b473-3bce411c697e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/{id}": + put: + summary: Update a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UpdateContact + description: You can update an existing contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a88a68186f43bafdb8 + workspace_id: this_is_an_id248_that_should_be_at_least_ + external_id: '70' + role: user + email: joebloggs@intercom.io + phone: + name: joe bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492776 + updated_at: 1719492776 + signed_up_at: 1719492776 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a88a68186f43bafdb8/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1b88e2d-938c-4a26-b65d-26ff65a0af36 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/update_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + name: joe bloggs + get: + summary: Get a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ShowContact + description: You can fetch the details of a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60a98a68186f43bafdb9 + workspace_id: this_is_an_id252_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492777 + updated_at: 1719492777 + signed_up_at: 1719492777 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60a98a68186f43bafdb9/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f70085f1-f655-43ee-9585-d2061b260fcd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete a contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + required: true + schema: + type: string + tags: + - Contacts + operationId: DeleteContact + description: You can delete a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60aa8a68186f43bafdba + external_id: '70' + type: contact + deleted: true + schema: + "$ref": "#/components/schemas/contact_deleted" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0bce3945-d2ec-4b8e-a790-b16fd52d9f11 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/contacts/merge": + post: + summary: Merge a lead and a user + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: MergeContact + description: You can merge a contact with a `role` of `lead` into a contact + with a `role` of `user`. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60ac8a68186f43bafdbc + workspace_id: this_is_an_id260_that_should_be_at_least_ + external_id: '70' + role: user + email: joe@bloggs.com + phone: + name: Joe Bloggs + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492780 + updated_at: 1719492780 + signed_up_at: 1719492780 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60ac8a68186f43bafdbc/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 57b64228-0e60-4e35-833d-39c4e4067dde + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/merge_contacts_request" + examples: + successful: + summary: successful + value: + from: 667d60ac8a68186f43bafdbb + into: 667d60ac8a68186f43bafdbc + "/contacts/search": + post: + summary: Search contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: SearchContacts + description: | + You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want. + + To search for contacts, you need to send a `POST` request to `https://api.intercom.io/contacts/search`. + + This will accept a query object in the body which will define your filters in order to search for contacts. + + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + ### Contact Creation Delay + + If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified it is recommended to use webhooks and iterate to see if they match your search filters. + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + * There's a limit of max 2 nested filters + * There's a limit of max 15 filters for each AND or OR group + + ### Searching for Timestamp Fields + + All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second. + For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards. + If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM). + This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly. + + ### Accepted Fields + + Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | ---------------------------------- | ------------------------------ | + | id | String | + | role | String
Accepts user or lead | + | name | String | + | avatar | String | + | owner_id | Integer | + | email | String | + | email_domain | String | + | phone | String | + | formatted_phone | String | + | external_id | String | + | created_at | Date (UNIX Timestamp) | + | signed_up_at | Date (UNIX Timestamp) | + | updated_at | Date (UNIX Timestamp) | + | last_seen_at | Date (UNIX Timestamp) | + | last_contacted_at | Date (UNIX Timestamp) | + | last_replied_at | Date (UNIX Timestamp) | + | last_email_opened_at | Date (UNIX Timestamp) | + | last_email_clicked_at | Date (UNIX Timestamp) | + | language_override | String | + | browser | String | + | browser_language | String | + | os | String | + | location.country | String | + | location.region | String | + | location.city | String | + | unsubscribed_from_emails | Boolean | + | marked_email_as_spam | Boolean | + | has_hard_bounced | Boolean | + | ios_last_seen_at | Date (UNIX Timestamp) | + | ios_app_version | String | + | ios_device | String | + | ios_app_device | String | + | ios_os_version | String | + | ios_app_name | String | + | ios_sdk_version | String | + | android_last_seen_at | Date (UNIX Timestamp) | + | android_app_version | String | + | android_device | String | + | android_app_name | String | + | andoid_sdk_version | String | + | segment_id | String | + | tag_id | String | + | custom_attributes.{attribute_name} | String | + + ### Accepted Operators + + {% admonition type="attention" name="Searching based on `created_at`" %} + You cannot use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :------------------------------- | :--------------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In
Shortcut for `OR` queries
Values must be in Array | + | NIN | All | Not In
Shortcut for `OR !` queries
Values must be in Array | + | > | Integer
Date (UNIX Timestamp) | Greater than | + | < | Integer
Date (UNIX Timestamp) | Lower than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b28c47b-8fa3-4e17-8fc1-6ba80f1cc844 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/contacts": + get: + summary: List all contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: ListContacts + description: | + You can fetch a list of all contacts (ie. users or leads) in your workspace. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `50` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: [] + total_count: 0 + pages: + type: pages + page: 1 + per_page: 10 + total_pages: 0 + schema: + "$ref": "#/components/schemas/contact_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d5bac7ff-7961-4fe5-8aed-6f1b031b38af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Contacts + operationId: CreateContact + description: You can create a new contact (ie. user or lead). + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d60b08a68186f43bafdbf + workspace_id: this_is_an_id272_that_should_be_at_least_ + external_id: + role: user + email: joebloggs@intercom.io + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719492784 + updated_at: 1719492784 + signed_up_at: + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d60b08a68186f43bafdbf/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c18ca0d4-ad2c-41e7-9a71-1df806f9c954 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_contact_request" + examples: + successful: + summary: successful + value: + email: joebloggs@intercom.io + "/contacts/{id}/archive": + post: + summary: Archive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: ArchiveContact + description: You can archive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b18a68186f43bafdc0 + external_id: '70' + type: contact + archived: true + schema: + "$ref": "#/components/schemas/contact_archived" + "/contacts/{id}/unarchive": + post: + summary: Unarchive contact + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: id + example: 63a07ddf05a32042dffac965 + required: true + schema: + type: string + tags: + - Contacts + operationId: UnarchiveContact + description: You can unarchive a single contact. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: 667d60b28a68186f43bafdc1 + external_id: '70' + type: contact + archived: false + schema: + "$ref": "#/components/schemas/contact_unarchived" + "/conversations/{conversation_id}/tags": + post: + summary: Add tag to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: attachTagToConversation + description: You can tag a specific conversation. This will return a tag object + for the tag that was added to the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '99' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Conversation not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 840d35aa-2414-402a-b3c6-763a410e0d16 + errors: + - code: not_found + message: Conversation not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 95cacea0-4744-4de8-a2bf-da4419f75732 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 99 + admin_id: 991267526 + conversation_not_found: + summary: Conversation not found + value: + id: 100 + admin_id: 991267528 + "/conversations/{conversation_id}/tags/{id}": + delete: + summary: Remove tag from a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + description: conversation_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: id + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Conversations + operationId: detachTagFromConversation + description: You can remove tag from a specific conversation. This will return + a tag object for the tag that was removed from the conversation. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '102' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: f78f63ba-911d-47b8-a389-b33e3ccbe77e + errors: + - code: not_found + message: Conversation not found + Tag not found: + value: + type: error.list + request_id: 0d00d069-2cf1-496f-b887-a4db74ee320d + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f083d6b1-e9d2-43b3-86df-67539007fc3e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267530 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267532 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267533 + "/conversations": + get: + summary: List all conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: per_page + in: query + schema: + type: integer + default: 20 + maximum: 150 + required: false + description: How many results per page + - name: starting_after + in: query + required: false + description: String used to get the next page of conversations. + schema: + type: string + tags: + - Conversations + operationId: listConversations + description: | + You can fetch a list of all conversations. + + You can optionally request the result page size and the cursor to start after to fetch the result. + {% admonition type="warning" name="Pagination" %} + You can use pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#pagination-for-list-apis) for more details on how to use the `starting_after` param. + {% /admonition %} + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 20 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '335' + created_at: 1719492795 + updated_at: 1719492795 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918241' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267536' + name: Ciaran143 Lee + email: admin143@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60bb8a68186f43bafdc5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 18db64a8-7a08-4967-9ec6-0416178306f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a91eac55-8d70-454d-a01d-c6bb875aaa35 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + post: + summary: Creates a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: createConversation + description: |+ + You can create a conversation that has been initiated by a contact (ie. user or lead). + The conversation can be an in-app message only. + + {% admonition type="info" name="Sending for visitors" %} + You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`. + This visitor will be automatically converted to a contact with a lead role once the conversation is created. + {% /admonition %} + + This will return the Message model that has been created. + + responses: + '200': + description: conversation created + content: + application/json: + examples: + conversation created: + value: + type: user_message + id: '403918251' + created_at: 1719492819 + body: Hello there + message_type: inapp + conversation_id: '363' + schema: + "$ref": "#/components/schemas/message" + '404': + description: Contact Not Found + content: + application/json: + examples: + Contact Not Found: + value: + type: error.list + request_id: ed0ab0c5-57b8-4413-a7a9-bbc134b40876 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: af9757fc-4e1d-463c-ac9d-788503f04a95 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7a35217-6720-48bd-a2ae-c2acb5adea30 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_conversation_request" + examples: + conversation_created: + summary: conversation created + value: + from: + type: user + id: 667d60d18a68186f43bafddd + body: Hello there + contact_not_found: + summary: Contact Not Found + value: + from: + type: user + id: 123_doesnt_exist + body: Hello there + "/conversations/{id}": + get: + summary: Retrieve a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: retrieveConversation + description: |2 + + You can fetch the details of a single conversation. + + This will return a single Conversation model with all its conversation parts. + + {% admonition type="warning" name="Hard limit of 500 parts" %} + The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts. + {% /admonition %} + + For AI agent conversation metadata, please note that you need to have the agent enabled in your workspace, which is a [paid feature](https://www.intercom.com/help/en/articles/8205718-fin-resolutions#h_97f8c2e671). + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '367' + created_at: 1719492825 + updated_at: 1719492825 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918255' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267553' + name: Ciaran153 Lee + email: admin153@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60d88a68186f43bafde1 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 978c1e65-1eba-4995-9acb-ff8f33b283e3 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b1f6adfd-f7da-4880-8d11-d842235126ae + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: c7b0a10f-d482-4352-8d7b-1ad26b902473 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + - name: display_as + in: query + required: false + description: Set to plaintext to retrieve conversation messages in plain text. + example: plaintext + schema: + type: string + tags: + - Conversations + operationId: updateConversation + description: |2+ + + You can update an existing conversation. + + {% admonition type="info" name="Replying and other actions" %} + If you want to reply to a coveration or take an action such as assign, unassign, open, close or snooze, take a look at the reply and manage endpoints. + {% /admonition %} + + responses: + '200': + description: conversation found + content: + application/json: + examples: + conversation found: + value: + type: conversation + id: '371' + created_at: 1719492832 + updated_at: 1719492834 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918259' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267561' + name: Ciaran157 Lee + email: admin157@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60e08a68186f43bafde5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: + issue_type: Billing + priority: High + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '96' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + - type: conversation_part + id: '97' + part_type: conversation_attribute_updated_by_admin + body: + created_at: 1719492834 + updated_at: 1719492834 + notified_at: 1719492834 + assigned_to: + author: + id: '991267562' + type: bot + name: Operator + email: operator+this_is_an_id321_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 2 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: e4c692dd-cccd-46bf-834a-cda7a3a9029c + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 58e6b9ee-4a28-4597-9c20-faf34b6894dc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: cf6fb162-88c9-45ec-9f97-c3fcad93b7c1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_conversation_request" + examples: + conversation_found: + summary: conversation found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + not_found: + summary: Not found + value: + read: true + custom_attributes: + issue_type: Billing + priority: High + "/conversations/search": + post: + summary: Search conversations + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: searchConversations + description: | + You can search for multiple conversations by the value of their attributes in order to fetch exactly which ones you want. + + To search for conversations, you need to send a `POST` request to `https://api.intercom.io/conversations/search`. + + This will accept a query object in the body which will define your filters in order to search for conversations. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page and maximum is `150`. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiple's there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the The conversation model is searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`). + + | Field | Type | + | :---------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | source.type | String
Accepted fields are `conversation`, `email`, `facebook`, `instagram`, `phone_call`, `phone_switch`, `push`, `sms`, `twitter` and `whatsapp`. | + | source.id | String | + | source.delivered_as | String | + | source.subject | String | + | source.body | String | + | source.author.id | String | + | source.author.type | String | + | source.author.name | String | + | source.author.email | String | + | source.url | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | channel_initiated | String | + | open | Boolean | + | read | Boolean | + | state | String | + | waiting_since | Date (UNIX timestamp) | + | snoozed_until | Date (UNIX timestamp) | + | tag_ids | String | + | priority | String | + | statistics.time_to_assignment | Integer | + | statistics.time_to_admin_reply | Integer | + | statistics.time_to_first_close | Integer | + | statistics.time_to_last_close | Integer | + | statistics.median_time_to_reply | Integer | + | statistics.first_contact_reply_at | Date (UNIX timestamp) | + | statistics.first_assignment_at | Date (UNIX timestamp) | + | statistics.first_admin_reply_at | Date (UNIX timestamp) | + | statistics.first_close_at | Date (UNIX timestamp) | + | statistics.last_assignment_at | Date (UNIX timestamp) | + | statistics.last_assignment_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_contact_reply_at | Date (UNIX timestamp) | + | statistics.last_admin_reply_at | Date (UNIX timestamp) | + | statistics.last_close_at | Date (UNIX timestamp) | + | statistics.last_closed_by_id | String | + | statistics.count_reopens | Integer | + | statistics.count_assignments | Integer | + | statistics.count_conversation_parts | Integer | + | conversation_rating.requested_at | Date (UNIX timestamp) | + | conversation_rating.replied_at | Date (UNIX timestamp) | + | conversation_rating.score | Integer | + | conversation_rating.remark | String | + | conversation_rating.contact_id | String | + | conversation_rating.admin_d | String | + | ai_agent_participated | Boolean | + | ai_agent.resolution_state | String | + | ai_agent.last_answer_type | String | + | ai_agent.rating | Integer | + | ai_agent.rating_remark | String | + | ai_agent.source_type | String | + | ai_agent.source_title | String | + + ### Accepted Operators + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: conversation.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + conversations: + - type: conversation + id: '378' + created_at: 1719492843 + updated_at: 1719492843 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918266' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267591' + name: Ciaran180 Lee + email: admin180@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ea8a68186f43bafdec + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + schema: + "$ref": "#/components/schemas/conversation_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/conversations/{id}/reply": + post: + summary: Reply to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The Intercom provisioned identifier for the conversation or the + string "last" to reply to the last part of the conversation + example: 123 or "last" + schema: + type: string + tags: + - Conversations + operationId: replyConversation + description: You can reply to a conversation with a message from an admin or + on behalf of a contact, or with a note for admins. + responses: + '200': + description: User last conversation reply + content: + application/json: + examples: + User reply: + value: + type: conversation + id: '387' + created_at: 1719492849 + updated_at: 1719492850 + waiting_since: 1719492850 + snoozed_until: + source: + type: conversation + id: '403918269' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267594' + name: Ciaran182 Lee + email: admin182@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f18a68186f43bafdf4 + external_id: '70' + first_contact_reply: + created_at: 1719492850 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '99' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492850 + updated_at: 1719492850 + notified_at: 1719492850 + assigned_to: + author: + id: 667d60f18a68186f43bafdf4 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Admin note reply: + value: + type: conversation + id: '388' + created_at: 1719492852 + updated_at: 1719492853 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918270' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267596' + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f38a68186f43bafdf5 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '100' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719492853 + updated_at: 1719492853 + notified_at: 1719492853 + assigned_to: + author: + id: '991267596' + type: admin + name: Ciaran183 Lee + email: admin183@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + User last conversation reply: + value: + type: conversation + id: '390' + created_at: 1719492855 + updated_at: 1719492856 + waiting_since: 1719492856 + snoozed_until: + source: + type: conversation + id: '403918272' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267600' + name: Ciaran185 Lee + email: admin185@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60f78a68186f43bafdf7 + external_id: '70' + first_contact_reply: + created_at: 1719492856 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '101' + part_type: open + body: "

Thanks again :)

" + created_at: 1719492856 + updated_at: 1719492856 + notified_at: 1719492856 + assigned_to: + author: + id: 667d60f78a68186f43bafdf7 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 8193a639-aba8-4b0e-9fdd-ee48807e3ee7 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7435aa28-13bd-40b1-ba99-66009e92a1ba + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 9fe5809c-cf0b-4a0f-af80-9913d3beb1eb + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/reply_conversation_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f18a68186f43bafdf4 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267596 + body: "

An Unordered HTML List

  • Coffee
  • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + user_last_conversation_reply: + summary: User last conversation reply + value: + message_type: comment + type: user + intercom_user_id: 667d60f78a68186f43bafdf7 + body: Thanks again :) + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d60f98a68186f43bafdf8 + body: Thanks again :) + "/conversations/{id}/parts": + post: + summary: Manage a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: manageConversation + description: | + For managing conversations you can: + - Close a conversation + - Snooze a conversation to reopen on a future date + - Open a conversation which is `snoozed` or `closed` + - Assign a conversation to an admin and/or team. + responses: + '200': + description: Assign a conversation + content: + application/json: + examples: + Close a conversation: + value: + type: conversation + id: '394' + created_at: 1719492862 + updated_at: 1719492862 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918276' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267608' + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60fd8a68186f43bafdfb + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '102' + part_type: close + body: "

Goodbye :)

" + created_at: 1719492862 + updated_at: 1719492862 + notified_at: 1719492862 + assigned_to: + author: + id: '991267608' + type: admin + name: Ciaran189 Lee + email: admin189@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Snooze a conversation: + value: + type: conversation + id: '395' + created_at: 1719492864 + updated_at: 1719492864 + waiting_since: + snoozed_until: 1719496464 + source: + type: conversation + id: '403918277' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267610' + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d60ff8a68186f43bafdfc + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: snoozed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '103' + part_type: snoozed + body: + created_at: 1719492864 + updated_at: 1719492864 + notified_at: 1719492864 + assigned_to: + author: + id: '991267610' + type: admin + name: Ciaran190 Lee + email: admin190@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Open a conversation: + value: + type: conversation + id: '400' + created_at: 1719492863 + updated_at: 1719492873 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918278' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267612' + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61038a68186f43bafe01 + external_id: '74' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: '' + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '105' + part_type: open + body: + created_at: 1719492873 + updated_at: 1719492873 + notified_at: 1719492873 + assigned_to: + author: + id: '991267612' + type: admin + name: Ciaran191 Lee + email: admin191@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + Assign a conversation: + value: + type: conversation + id: '405' + created_at: 1719492874 + updated_at: 1719492875 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918281' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267615' + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d610a8a68186f43bafe05 + external_id: '70' + first_contact_reply: + admin_assignee_id: 991267615 + team_assignee_id: + open: true + state: open + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '106' + part_type: assign_and_reopen + body: + created_at: 1719492875 + updated_at: 1719492875 + notified_at: 1719492875 + assigned_to: + type: admin + id: '991267615' + author: + id: '991267615' + type: admin + name: Ciaran193 Lee + email: admin193@email.com + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1bfc14e1-07ef-4999-9448-f029b112cf1b + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ae0581d2-199e-437c-bf51-1eb9fe2e12fc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: a7e069bb-f013-45bc-8e0a-f58c3de4e034 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/close_conversation_request" + - "$ref": "#/components/schemas/snooze_conversation_request" + - "$ref": "#/components/schemas/open_conversation_request" + - "$ref": "#/components/schemas/assign_conversation_request" + examples: + close_a_conversation: + summary: Close a conversation + value: + message_type: close + type: admin + admin_id: 991267608 + body: Goodbye :) + snooze_a_conversation: + summary: Snooze a conversation + value: + message_type: snoozed + admin_id: 991267610 + snoozed_until: 1719496464 + open_a_conversation: + summary: Open a conversation + value: + message_type: open + admin_id: 991267612 + assign_a_conversation: + summary: Assign a conversation + value: + message_type: assignment + type: admin + admin_id: 991267615 + assignee_id: 991267615 + not_found: + summary: Not found + value: + message_type: close + type: admin + admin_id: 991267617 + body: Goodbye :) + "/conversations/{id}/run_assignment_rules": + post: + summary: Run Assignment Rules on a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: autoAssignConversation + description: | + You can let a conversation be automatically assigned following assignment rules. + {% admonition type="attention" name="When using workflows" %} + It is not possible to use this endpoint with Workflows. + {% /admonition %} + responses: + '200': + description: Assign a conversation using assignment rules + content: + application/json: + examples: + Assign a conversation using assignment rules: + value: + type: conversation + id: '409' + created_at: 1719492880 + updated_at: 1719492881 + waiting_since: + snoozed_until: + source: + type: conversation + id: '403918285' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267623' + name: Ciaran197 Lee + email: admin197@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61108a68186f43bafe09 + external_id: '70' + first_contact_reply: + admin_assignee_id: + team_assignee_id: + open: false + state: closed + read: false + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '107' + part_type: default_assignment + body: + created_at: 1719492881 + updated_at: 1719492881 + notified_at: 1719492881 + assigned_to: + type: nobody_admin + id: + author: + id: '991267624' + type: bot + name: Operator + email: operator+this_is_an_id364_that_should_be_at_least_@intercom.io + attachments: [] + external_id: + redacted: false + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 9d88a5a7-6df9-42ff-b324-2387db7be984 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 8aeac960-c7fb-41f7-8cc9-cd3d62f6ff92 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: '037980c4-84cb-4d3a-ad64-66e4e563a275' + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + "/conversations/{id}/customers": + post: + summary: Attach a contact to a conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: attachContactToConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Attach a contact to a conversation + content: + application/json: + examples: + Attach a contact to a conversation: + value: + customers: + - type: user + id: 667d61168a68186f43bafe0d + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 1fd64942-5bf0-4a51-a6cb-db4a778bb1f4 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 4f00c4c6-a8f7-436e-bf95-d1adfa315906 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: 3d1c3371-6ba4-4d5a-9368-ac983292136d + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/attach_contact_to_conversation_request" + examples: + attach_a_contact_to_a_conversation: + summary: Attach a contact to a conversation + value: + admin_id: 991267631 + customer: + intercom_user_id: 667d61168a68186f43bafe0d + not_found: + summary: Not found + value: + admin_id: 991267633 + customer: + intercom_user_id: 667d61188a68186f43bafe0e + "/conversations/{conversation_id}/customers/{contact_id}": + delete: + summary: Detach a contact from a group conversation + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: conversation_id + in: path + required: true + description: The identifier for the conversation as given by Intercom. + example: '123' + schema: + type: string + - name: contact_id + in: path + required: true + description: The identifier for the contact as given by Intercom. + example: '123' + schema: + type: string + tags: + - Conversations + operationId: detachContactFromConversation + description: |+ + You can add participants who are contacts to a conversation, on behalf of either another contact or an admin. + + {% admonition type="attention" name="Contacts without an email" %} + If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`. + {% /admonition %} + + responses: + '200': + description: Detach a contact from a group conversation + content: + application/json: + examples: + Detach a contact from a group conversation: + value: + customers: + - type: user + id: 667d61228a68186f43bafe19 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Contact not found + content: + application/json: + examples: + Conversation not found: + value: + type: error.list + request_id: 579f0f7a-d773-41d6-9d36-8cc0b3fbcc41 + errors: + - code: not_found + message: Resource Not Found + Contact not found: + value: + type: error.list + request_id: 44531412-2973-4b92-b14d-80abac5c1b4d + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '422': + description: Last customer + content: + application/json: + examples: + Last customer: + value: + type: error.list + request_id: 35a0444f-8a1e-40e9-a5fc-dd1ae2df8bc6 + errors: + - code: parameter_invalid + message: Removing the last customer is not allowed + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d35f1b37-765c-4afe-8738-81c0560710a6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: d30f18d4-2e0a-4528-a66b-4590b733713c + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/detach_contact_from_conversation_request" + examples: + detach_a_contact_from_a_group_conversation: + summary: Detach a contact from a group conversation + value: + admin_id: 991267639 + customer: + intercom_user_id: 667d611c8a68186f43bafe11 + conversation_not_found: + summary: Conversation not found + value: + admin_id: 991267642 + customer: + intercom_user_id: 667d61248a68186f43bafe1a + contact_not_found: + summary: Contact not found + value: + admin_id: 991267645 + customer: + intercom_user_id: 667d612b8a68186f43bafe22 + last_customer: + summary: Last customer + value: + admin_id: 991267648 + customer: + intercom_user_id: 667d61338a68186f43bafe2a + "/conversations/redact": + post: + summary: Redact a conversation part + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Conversations + operationId: redactConversation + description: |+ + You can redact a conversation part or the source message of a conversation (as seen in the source object). + + {% admonition type="info" name="Redacting parts and messages" %} + If you are redacting a conversation part, it must have a `body`. If you are redacting a source message, it must have been created by a contact. We will return a `conversation_part_not_redactable` error if these criteria are not met. + {% /admonition %} + + responses: + '200': + description: Redact a conversation part + content: + application/json: + examples: + Redact a conversation part: + value: + type: conversation + id: '471' + created_at: 1719492938 + updated_at: 1719492940 + waiting_since: 1719492939 + snoozed_until: + source: + type: conversation + id: '403918311' + delivered_as: admin_initiated + subject: '' + body: "

this is the message body

" + author: + type: admin + id: '991267657' + name: Ciaran217 Lee + email: admin217@email.com + attachments: [] + url: + redacted: false + contacts: + type: contact.list + contacts: + - type: contact + id: 667d614a8a68186f43bafe42 + external_id: '70' + first_contact_reply: + created_at: 1719492939 + type: conversation + url: + admin_assignee_id: + team_assignee_id: + open: true + state: open + read: true + tags: + type: tag.list + tags: [] + priority: not_priority + sla_applied: + statistics: + conversation_rating: + teammates: + title: + custom_attributes: {} + topics: {} + ticket: + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + ai_agent: + ai_agent_participated: false + conversation_parts: + type: conversation_part.list + conversation_parts: + - type: conversation_part + id: '115' + part_type: open + body: "

This message was deleted

" + created_at: 1719492939 + updated_at: 1719492940 + notified_at: 1719492939 + assigned_to: + author: + id: 667d614a8a68186f43bafe42 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + external_id: + redacted: true + total_count: 1 + schema: + "$ref": "#/components/schemas/conversation" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: 0c016386-49f4-431f-92dc-7e739cbf98e1 + errors: + - code: conversation_part_or_message_not_found + message: Conversation part or message not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 1b830d07-a249-4ff8-a7bf-41bf83fd53b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/redact_conversation_request" + examples: + redact_a_conversation_part: + summary: Redact a conversation part + value: + type: conversation_part + conversation_id: 471 + conversation_part_id: 115 + not_found: + summary: Not found + value: + type: conversation_part + conversation_id: really_123_doesnt_exist + conversation_part_id: really_123_doesnt_exist + "/conversations/{id}/convert": + post: + summary: Convert a conversation to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The id of the conversation to target + example: 123 + schema: + type: integer + tags: + - Conversations + description: You can convert a conversation to a ticket. + operationId: convertConversationToTicket + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket + id: '474' + ticket_id: '37' + ticket_attributes: {} + ticket_state: submitted + ticket_type: + type: ticket_type + id: '79' + name: my-ticket-type-1 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id404_that_should_be_at_least_ + archived: false + created_at: 1719492947 + updated_at: 1719492947 + is_internal: false + ticket_type_attributes: + type: list + data: [] + category: Customer + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61518a68186f43bafe45 + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719492945 + updated_at: 1719492947 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '117' + part_type: comment + body: "

Comment for message

" + created_at: 1719492945 + updated_at: 1719492945 + author: + id: 667d61518a68186f43bafe45 + type: user + name: Joe Bloggs + email: joe@bloggs.com + attachments: [] + redacted: false + - type: ticket_part + id: '118' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719492947 + updated_at: 1719492947 + author: + id: '991267667' + type: bot + name: Operator + email: operator+this_is_an_id404_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 2 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Customer + is_shared: true + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '400': + description: Bad request + content: + application/json: + examples: + Bad request: + value: + type: error.list + request_id: 74656c1a-0a17-4c80-a7b9-66fa45c6d71b + errors: + - code: parameter_invalid + message: Ticket type is not a customer ticket type + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_conversation_to_ticket_request" + examples: + successful: + summary: successful + value: + ticket_type_id: '79' + bad_request: + summary: Bad request + value: + ticket_type_id: '80' + "/data_attributes": + get: + summary: List all data attributes + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: model + in: query + required: false + description: Specify the data attribute model to return. + schema: + type: string + enum: + - contact + - company + - conversation + example: company + - name: include_archived + in: query + required: false + description: Include archived attributes in the list. By default we return + only non archived data attributes. + example: false + schema: + type: boolean + tags: + - Data Attributes + operationId: lisDataAttributes + description: You can fetch a list of all data attributes belonging to a workspace + for contacts, companies or conversations. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: list + data: + - type: data_attribute + name: name + full_name: name + label: Company name + description: The name of a company + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: company_id + full_name: company_id + label: Company ID + description: A number identifying a company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: last_request_at + full_name: last_request_at + label: Company last seen + description: The last day anyone from a company visited your + site or app + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: remote_created_at + full_name: remote_created_at + label: Company created at + description: The day a company was added to Intercom + data_type: date + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: user_count + full_name: user_count + label: People + description: The number of people in a company + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: session_count + full_name: session_count + label: Company web sessions + description: All visits from anyone in a company to your product's + site or app + data_type: integer + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: name + full_name: plan.name + label: Plan + description: A specific plan or level within your product that + companies have signed up to + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: monthly_spend + full_name: monthly_spend + label: Monthly Spend + description: The monthly revenue you receive from a company + data_type: float + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: size + full_name: size + label: Company size + description: The number of people employed in this company, + expressed as a single number + data_type: integer + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: industry + full_name: industry + label: Company industry + description: The category or domain this company belongs to + e.g. 'ecommerce' or 'SaaS' + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: website + full_name: website + label: Company website + description: The web address for the company's primary marketing + site + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - id: 34 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: One ring to rule them all, one ring to find them, + One ring to bring them all and in the darkness bind them. + data_type: string + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267684' + created_at: 1719492954 + updated_at: 1719492954 + model: company + - type: data_attribute + name: id + full_name: id + label: ID + description: The Intercom defined id representing the company + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: created_at + full_name: created_at + label: Created at + description: The time the company was added to Intercom + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: updated_at + full_name: updated_at + label: Updated at + description: The last time the company was updated + data_type: date + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: id + full_name: plan.id + label: Plan ID + description: The Intercom defined id representing the plan + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + - type: data_attribute + name: app_id + full_name: app_id + label: App ID + description: The Intercom defined id representing the app + data_type: string + api_writable: false + ui_writable: false + messenger_writable: true + custom: false + archived: false + model: company + schema: + "$ref": "#/components/schemas/data_attribute_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e76e914-a34d-4125-8310-62fdfc4e651e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Attributes + operationId: createDataAttribute + description: You can create a data attributes for a `contact` or a `company`. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 37 + type: data_attribute + name: Mithril Shirt + full_name: custom_attributes.Mithril Shirt + label: Mithril Shirt + data_type: string + api_writable: true + ui_writable: false + messenger_writable: false + custom: true + archived: false + admin_id: '991267686' + created_at: 1719492955 + updated_at: 1719492955 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options for list + content: + application/json: + examples: + Same name already exists: + value: + type: error.list + request_id: bcd93885-3f01-4b92-9918-c96a3f4492e8 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new people data, use a different name. + Invalid name: + value: + type: error.list + request_id: 7420c5e3-22c3-46be-8a23-72fef8f8ec0e + errors: + - code: parameter_invalid + message: Your name for this attribute must only contain alphanumeric + characters, currency symbols, and hyphens + Attribute already exists: + value: + type: error.list + request_id: c844551a-05d3-4f8c-931a-32e96bf3a508 + errors: + - code: parameter_invalid + message: You already have 'The One Ring' in your company data. + To save this as new company data, use a different name. + Invalid Data Type: + value: + type: error.list + request_id: b8c58b81-8445-473d-8fe3-7880c04f9547 + errors: + - code: parameter_invalid + message: Data Type isn't an option + Too few options for list: + value: + type: error.list + request_id: 119e3822-3a45-48cf-b5ab-037f27a948c8 + errors: + - code: parameter_invalid + message: The Data Attribute model field must be either contact + or company + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b74d8980-6e99-44db-a3d8-2a65a63fe590 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_attribute_request" + examples: + successful: + summary: Successful + value: + name: Mithril Shirt + model: company + data_type: string + same_name_already_exists: + summary: Same name already exists + value: + name: The One Ring + model: contact + data_type: integer + invalid_name: + summary: Invalid name + value: + name: "!nv@l!d n@me" + model: company + data_type: string + attribute_already_exists: + summary: Attribute already exists + value: + name: The One Ring + model: company + data_type: string + invalid_data_type: + summary: Invalid Data Type + value: + name: The Second Ring + model: company + data_type: mithril + too_few_options_for_list: + summary: Too few options for list + value: + description: Just a plain old ring + options: + - value: 1-10 + archived: false + "/data_attributes/{id}": + put: + summary: Update a data attribute + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The data attribute id + example: 1 + schema: + type: integer + tags: + - Data Attributes + operationId: updateDataAttribute + description: "\nYou can update a data attribute.\n\n> \U0001F6A7 Updating the + data type is not possible\n>\n> It is currently a dangerous action to execute + changing a data attribute's type via the API. You will need to update the + type via the UI instead.\n" + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + id: 44 + type: data_attribute + name: The One Ring + full_name: custom_attributes.The One Ring + label: The One Ring + description: Just a plain old ring + data_type: string + options: + - 1-10 + - 11-20 + api_writable: true + ui_writable: false + messenger_writable: true + custom: true + archived: false + admin_id: '991267693' + created_at: 1719492958 + updated_at: 1719492959 + model: company + schema: + "$ref": "#/components/schemas/data_attribute" + '400': + description: Too few options in list + content: + application/json: + examples: + Too few options in list: + value: + type: error.list + request_id: 6615f20c-01df-443c-9ea1-c954ba6b09d6 + errors: + - code: parameter_invalid + message: Options isn't an array + schema: + "$ref": "#/components/schemas/error" + '404': + description: Attribute Not Found + content: + application/json: + examples: + Attribute Not Found: + value: + type: error.list + request_id: 2680a225-4f79-4098-8438-8db993c639fe + errors: + - code: field_not_found + message: We couldn't find that data attribute to update + schema: + "$ref": "#/components/schemas/error" + '422': + description: Has Dependant Object + content: + application/json: + examples: + Has Dependant Object: + value: + type: error.list + request_id: fbc508f1-9cbf-4134-90ea-baa1065760d2 + errors: + - code: data_invalid + message: The Data Attribute you are trying to archive has a + dependant object + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0cfc97c0-32be-4e68-aef2-f5744e4e85f7 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_data_attribute_request" + examples: + successful: + summary: Successful + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + too_few_options_in_list: + summary: Too few options in list + value: + description: Too few options + options: + value: 1-10 + archived: false + attribute_not_found: + summary: Attribute Not Found + value: + description: Just a plain old ring + options: + - value: 1-10 + - value: 11-20 + archived: false + has_dependant_object: + summary: Has Dependant Object + value: + description: Trying to archieve + archived: true + "/events": + post: + summary: Submit a data event + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: createDataEvent + description: |2+ + + You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`. + + When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event. + + With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`). + + **NB: For the JSON object types, please note that we do not currently support nested JSON structure.** + + | Type | Description | Example | + | :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- | + | String | The value is a JSON String | `"source":"desktop"` | + | Number | The value is a JSON Number | `"load": 3.67` | + | Date | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272` | + | Link | The value is a HTTP or HTTPS URI. | `"article": "https://example.org/ab1de.html"` | + | Rich Link | The value is a JSON object that contains `url` and `value` keys. | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` | + | Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99. | `"price": {"amount": 34999, "currency": "eur"}` | + + **Lead Events** + + When submitting events for Leads, you will need to specify the Lead's `id`. + + **Metadata behaviour** + + - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event. + - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one. + - There might be up to 24 hrs delay when you send a new metadata for an existing event. + + **Event de-duplication** + + The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field. + + Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place. + + ### HTTP API Responses + + - Successful responses to submitted events return `202 Accepted` with an empty body. + - Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code. + - Events sent about users that cannot be found will return a `404 Not Found`. + - Event lists containing duplicate events will have those duplicates ignored. + - Server errors will return a `500` response code and may contain an error message in the body. + + responses: + '202': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c6b3dcbd-33be-4a80-abb4-c5b3315250d0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_request" + get: + summary: List all data events + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - in: query + name: filter + required: true + style: form + explode: true + schema: + type: object + oneOf: + - title: user_id query parameter + properties: + user_id: + type: string + required: + - user_id + additionalProperties: false + - title: intercom_user_id query parameter + properties: + intercom_user_id: + type: string + required: + - intercom_user_id + additionalProperties: false + - title: email query parameter + properties: + email: + type: string + required: + - email + additionalProperties: false + - name: type + in: query + required: true + description: The value must be user + schema: + type: string + - name: summary + in: query + required: false + description: summary flag + schema: + type: boolean + tags: + - Data Events + operationId: lisDataEvents + description: "\n> \U0001F6A7\n>\n> Please note that you can only 'list' events + that are less than 90 days old. Event counts and summaries will still include + your events older than 90 days but you cannot 'list' these events individually + if they are older than 90 days\n\nThe events belonging to a customer can be + listed by sending a GET request to `https://api.intercom.io/events` with a + user or lead identifier along with a `type` parameter. The identifier parameter + can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter + value must be `user`.\n\n- `https://api.intercom.io/events?type=user&user_id={user_id}`\n- + `https://api.intercom.io/events?type=user&email={email}`\n- `https://api.intercom.io/events?type=user&intercom_user_id={id}` + (this call can be used to list leads)\n\nThe `email` parameter value should + be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.\n\nYou + can optionally define the result page size as well with the `per_page` parameter.\n" + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: event.summary + events: [] + pages: + next: http://api.intercom.test/events?next page + email: user26@email.com + intercom_user_id: 667d61648a68186f43bafe4b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + schema: + "$ref": "#/components/schemas/data_event_summary" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bfdcc6de-2dcb-4725-acc7-232c10838586 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/events/summaries": + post: + summary: Create event summaries + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Events + operationId: dataEventSummaries + description: "Create event summaries for a user. Event summaries are used to + track the number of times an event has occurred, the first time it occurred + and the last time it occurred.\n\n" + responses: + '200': + description: successful + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110801d1-2f7b-436f-8f03-2245545a1432 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_event_summaries_request" + "/export/content/data": + post: + summary: Create content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Data Export + operationId: createDataExport + description: "To create your export job, you need to send a `POST` request to + the export endpoint `https://api.intercom.io/export/content/data`.\n\nThe + only parameters you need to provide are the range of dates that you want exported.\n\n>\U0001F6A7 + Limit of one active job\n>\n> You can only have one active job per workspace. + You will receive a HTTP status code of 429 with the message Exceeded rate + limit of 1 pending message data export jobs if you attempt to create a second + concurrent job.\n\n>❗️ Updated_at not included\n>\n> It should be noted that + the timeframe only includes messages sent during the time period and not messages + that were only updated during this period. For example, if a message was updated + yesterday but sent two days ago, you would need to set the created_at_after + date before the message was sent to include that in your retrieval job.\n\n>\U0001F4D8 + Date ranges are inclusive\n>\n> Requesting data for 2018-06-01 until 2018-06-30 + will get all data for those days including those specified - e.g. 2018-06-01 + 00:00:00 until 2018-06-30 23:59:99.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: bxe9awlish03jkq8 + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_data_exports_request" + examples: + successful: + summary: successful + value: + created_at_after: 1719474967 + created_at_before: 1719492967 + "/export/content/data/{job_identifier}": + get: + summary: Show content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: getDataExport + description: "You can view the status of your job by sending a `GET` request + to the URL\n`https://api.intercom.io/export/content/data/{job_identifier}` + - the `{job_identifier}` is the value returned in the response when you first + created the export job. More on it can be seen in the Export Job Model.\n\n> + \U0001F6A7 Jobs expire after two days\n> All jobs that have completed processing + (and are thus available to download from the provided URL) will have an expiry + limit of two days from when the export ob completed. After this, the data + will no longer be available.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: b1ppo8h93fj386fk + status: pending + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/export/cancel/{job_identifier}": + post: + summary: Cancel content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: cancelDataExport + description: You can cancel your job + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + job_identifier: pwrbmmimhakvlfsh + status: canceled + download_url: '' + download_expires_at: '' + schema: + "$ref": "#/components/schemas/data_export" + "/download/content/data/{job_identifier}": + get: + summary: Download content data export + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: job_identifier + in: path + description: job_identifier + required: true + schema: + type: string + tags: + - Data Export + operationId: downloadDataExport + description: "When a job has a status of complete, and thus a filled download_url, + you can download your data by hitting that provided URL, formatted like so: + https://api.intercom.io/download/content/data/xyz1234.\n\nYour exported message + data will be streamed continuously back down to you in a gzipped CSV format.\n\n> + \U0001F4D8 Octet header required\n>\n> You will have to specify the header + Accept: `application/octet-stream` when hitting this endpoint.\n" + responses: + '200': + description: successful + "/messages": + post: + summary: Create a message + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Messages + operationId: createMessage + description: "You can create a message that has been initiated by an admin. + The conversation can be either an in-app message or an email.\n\n> \U0001F6A7 + Sending for visitors\n>\n> There can be a short delay between when a contact + is created and when a contact becomes available to be messaged through the + API. A 404 Not Found error will be returned in this case.\n\nThis will return + the Message model that has been created.\n\n> \U0001F6A7 Retrieving Associated + Conversations\n>\n> As this is a message, there will be no conversation present + until the contact responds. Once they do, you will have to search for a contact's + conversations with the id of the message.\n" + responses: + '200': + description: admin message created + content: + application/json: + examples: + user message created: + value: + type: user_message + id: '403918316' + created_at: 1719492969 + body: heyy + message_type: inapp + conversation_id: '476' + lead message created: + value: + type: user_message + id: '403918317' + created_at: 1719492971 + body: heyy + message_type: inapp + conversation_id: '477' + admin message created: + value: + type: admin_message + id: '15' + created_at: 1719492972 + subject: heyy + body: heyy + message_type: inapp + owner: + type: admin + id: '991267716' + name: Ciaran269 Lee + email: admin269@email.com + away_mode_enabled: false + away_mode_reassign: false + schema: + "$ref": "#/components/schemas/message" + '400': + description: No body supplied for email message + content: + application/json: + examples: + No body supplied for message: + value: + type: error.list + request_id: 4a52a34f-c7e2-4e70-adf2-ea7f41beb2a1 + errors: + - code: parameter_invalid + message: Body is required + No body supplied for email message: + value: + type: error.list + request_id: 7d54191b-c0fc-4860-a01c-9da6b4e45b7f + errors: + - code: parameter_invalid + message: Body is required + schema: + "$ref": "#/components/schemas/error" + '422': + description: No subject supplied for email message + content: + application/json: + examples: + No subject supplied for email message: + value: + type: error.list + request_id: f54ba906-3255-4fc6-a660-0dab0043ff2b + errors: + - code: parameter_not_found + message: No subject supplied for email message + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: ee3ea56e-d0ce-47db-871a-57740e165e5c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + '403': + description: API plan restricted + content: + application/json: + examples: + API plan restricted: + value: + type: error.list + request_id: fab7034a-78bd-4413-a652-8f38783e7bf1 + errors: + - code: api_plan_restricted + message: Active subscription needed. + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_message_request" + examples: + user_message_created: + summary: user message created + value: + from: + type: user + id: 667d61698a68186f43bafe50 + body: heyy + referer: https://twitter.com/bob + lead_message_created: + summary: lead message created + value: + from: + type: lead + id: 667d616a8a68186f43bafe51 + body: heyy + referer: https://twitter.com/bob + admin_message_created: + summary: admin message created + value: + from: + type: admin + id: '991267716' + to: + type: user + id: 667d616c8a68186f43bafe52 + message_type: conversation + body: heyy + no_body_supplied_for_message: + summary: No body supplied for message + value: + from: + type: admin + id: '991267718' + to: + type: user + id: 667d616d8a68186f43bafe53 + message_type: inapp + body: + subject: heyy + no_subject_supplied_for_email_message: + summary: No subject supplied for email message + value: + from: + type: admin + id: '991267719' + to: + type: user + user_id: '70' + message_type: email + body: hey there + no_body_supplied_for_email_message: + summary: No body supplied for email message + value: + from: + type: admin + id: '991267720' + to: + type: user + id: 667d616e8a68186f43bafe55 + message_type: email + body: + subject: heyy + "/news/news_items": + get: + summary: List all news items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsItems + description: You can fetch a list of all news items + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '29' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267725 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + - id: '30' + type: news-item + workspace_id: this_is_an_id494_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267727 + state: draft + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492976 + updated_at: 1719492976 + newsfeed_assignments: [] + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7b27151d-7bb0-402e-87fe-5780690d9f32 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: createNewsItem + description: You can create a news item + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '33' + type: news-item + workspace_id: this_is_an_id498_that_should_be_at_least_ + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + sender_id: 991267734 + state: live + labels: + - New + - Product + - Update + cover_image_url: + reactions: + - "\U0001F606" + - "\U0001F605" + deliver_silently: true + created_at: 1719492978 + updated_at: 1719492978 + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + schema: + "$ref": "#/components/schemas/news_item" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c36202f1-6bf3-4ea6-9442-192123f506b0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Halloween is here! + body: "

New costumes in store for this spooky season

" + labels: + - Product + - Update + - New + sender_id: 991267734 + deliver_silently: true + reactions: + - "\U0001F606" + - "\U0001F605" + state: live + newsfeed_assignments: + - newsfeed_id: 53 + published_at: 1664638214 + "/news/news_items/{id}": + get: + summary: Retrieve a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: retrieveNewsItem + description: You can fetch the details of a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '34' + type: news-item + workspace_id: this_is_an_id502_that_should_be_at_least_ + title: We have news + body: "

Hello there,

" + sender_id: 991267737 + state: live + labels: [] + cover_image_url: + reactions: + - + - + - + - + deliver_silently: false + created_at: 1719492979 + updated_at: 1719492979 + newsfeed_assignments: + - newsfeed_id: 55 + published_at: 1719492980 + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: 0f4b439e-9b57-4019-886e-15cc08582914 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: cc6af01d-81e3-4a74-8a62-807a3239e1ad + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: updateNewsItem + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '37' + type: news-item + workspace_id: this_is_an_id508_that_should_be_at_least_ + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + state: live + labels: [] + cover_image_url: + reactions: + - "\U0001F61D" + - "\U0001F602" + deliver_silently: false + created_at: 1719492982 + updated_at: 1719492982 + newsfeed_assignments: [] + schema: + "$ref": "#/components/schemas/news_item" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: fe6e217d-70bc-4090-b33a-b32ec0e6a391 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: f780a591-4aa2-4382-80c4-e0f2d655bf2e + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/news_item_request" + examples: + successful: + summary: successful + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267745 + reactions: + - "\U0001F61D" + - "\U0001F602" + news_item_not_found: + summary: News Item Not Found + value: + title: Christmas is here! + body: "

New gifts in store for the jolly season

" + sender_id: 991267748 + reactions: + - "\U0001F61D" + - "\U0001F602" + delete: + summary: Delete a news item + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news item which is given by Intercom. + example: 123 + schema: + type: integer + tags: + - News + operationId: deleteNewsItem + description: You can delete a single news item. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '40' + object: news-item + deleted: true + schema: + "$ref": "#/components/schemas/deleted_object" + '404': + description: News Item Not Found + content: + application/json: + examples: + News Item Not Found: + value: + type: error.list + request_id: a191b999-6f71-4676-a8db-1a79ccc4f114 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 521cb8a5-4d47-43dd-94cb-ef54f6f8ce0a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}/items": + get: + summary: List all live newsfeed items + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: listLiveNewsfeedItems + description: You can fetch a list of all news items that are live on a given + newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 20 + total_pages: 0 + type: pages + data: [] + total_count: 0 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: de07bbcf-64ff-4fc8-a7e5-fcbe772b85a5 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds": + get: + summary: List all newsfeeds + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - News + operationId: listNewsfeeds + description: You can fetch a list of all newsfeeds + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + pages: + page: 1 + per_page: 10 + total_pages: 1 + type: pages + data: + - id: '68' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + - id: '69' + type: newsfeed + name: Visitor Feed + created_at: 1719492987 + updated_at: 1719492987 + total_count: 2 + schema: + "$ref": "#/components/schemas/paginated_response" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d00f8d67-1e7c-464b-b0b7-b2409d706076 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/news/newsfeeds/{id}": + get: + summary: Retrieve a newsfeed + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the news feed item which is given by + Intercom. + example: '123' + schema: + type: string + tags: + - News + operationId: retrieveNewsfeed + description: You can fetch the details of a single newsfeed + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + id: '72' + type: newsfeed + name: Visitor Feed + created_at: 1719492988 + updated_at: 1719492988 + schema: + "$ref": "#/components/schemas/newsfeed" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 185ce494-34e2-4cda-85cb-c51ad7281292 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/notes/{id}": + get: + summary: Retrieve a note + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given note + example: 1 + schema: + type: integer + tags: + - Notes + operationId: retrieveNote + description: You can fetch the details of a single note. + responses: + '200': + description: Note found + content: + application/json: + examples: + Note found: + value: + type: note + id: '37' + created_at: 1718801789 + contact: + type: contact + id: 667d617d8a68186f43bafe58 + author: + type: admin + id: '991267764' + name: Ciaran316 Lee + email: admin316@email.com + away_mode_enabled: false + away_mode_reassign: false + body: "

This is a note.

" + schema: + "$ref": "#/components/schemas/note" + '404': + description: Note not found + content: + application/json: + examples: + Note not found: + value: + type: error.list + request_id: 7e37eb4e-9f1e-47fa-a393-8d9b2c20983a + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b29ebc05-ba35-4db8-aac6-d74617769643 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments": + get: + summary: List all segments + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: include_count + in: query + required: false + description: It includes the count of contacts that belong to each segment. + example: true + schema: + type: boolean + tags: + - Segments + operationId: listSegments + description: You can fetch a list of all segments. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment.list + segments: + - type: segment + id: 667d617f8a68186f43bafe5b + name: John segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + - type: segment + id: 667d617f8a68186f43bafe5c + name: Jane segment + created_at: 1719492991 + updated_at: 1719492991 + person_type: user + schema: + "$ref": "#/components/schemas/segment_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: d70c184d-852a-4f67-8298-3cf9a327adb3 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/segments/{id}": + get: + summary: Retrieve a segment + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identified of a given segment. + example: '123' + schema: + type: string + tags: + - Segments + operationId: retrieveSegment + description: You can fetch the details of a single segment. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: segment + id: 667d61808a68186f43bafe5f + name: John segment + created_at: 1719492992 + updated_at: 1719492992 + person_type: user + schema: + "$ref": "#/components/schemas/segment" + '404': + description: Segment not found + content: + application/json: + examples: + Segment not found: + value: + type: error.list + request_id: fe79fa5e-c8eb-40a6-be76-d618833c2840 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a9c190ff-16eb-43f9-94fc-7c22da2766af + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/subscription_types": + get: + summary: List subscription types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Subscription Types + operationId: listSubscriptionTypes + description: You can list all subscription types. A list of subscription type + objects will be returned. + responses: + '200': + description: Successful + content: + application/json: + examples: + Successful: + value: + type: list + data: + - type: subscription + id: '137' + state: live + consent_type: opt_out + default_translation: + name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + translations: + - name: Newsletters + description: Lorem ipsum dolor sit amet + locale: en + content_types: + - email + schema: + "$ref": "#/components/schemas/subscription_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5fb6b003-d6a6-4641-b71b-c5c468c87448 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/phone_call_redirects": + post: + summary: Create a phone Switch + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Switch + operationId: createPhoneSwitch + description: | + You can use the API to deflect phone calls to the Intercom Messenger. + Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified. + + If custom attributes are specified, they will be added to the user or lead's custom data attributes. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + url: http://via.intercom.io/msgr/6eb60123-dadb-4881-80fd-4fc2cf272b12 + type: phone_call_redirect + schema: + "$ref": "#/components/schemas/phone_switch" + '400': + description: bad request - invalid number + content: + application/json: + examples: + bad request - exception sending sms: + value: + error_key: sms_failed + message: SMS was not sent due to an unknown error + bad request - invalid number: + value: + error_key: invalid_phone_number + message: Invalid phone number + '422': + description: unprocessable entity + content: + application/json: + examples: + unprocessable entity: + value: + error_key: some_error + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 5da7a3e7-dcb0-4378-8575-0a0e9bae3862 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_phone_switch_request" + examples: + successful: + summary: successful + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_exception_sending_sms: + summary: bad request - exception sending sms + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + bad_request_-_invalid_number: + summary: bad request - invalid number + value: + phone: "+353832345678" + custom_attributes: + issue_type: Billing + priority: High + unprocessable_entity: + summary: unprocessable entity + value: + phone: "+40241100100" + custom_attributes: + issue_type: Billing + priority: High + "/tags": + get: + summary: List all tags + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: listTags + description: "You can fetch a list of all tags for a given workspace.\n\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: tag + id: '115' + name: Manual tag 1 + schema: + "$ref": "#/components/schemas/tag_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: c83a3efe-433a-4555-a5e2-e393588be29f + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create or update a tag, Tag or untag companies, Tag contacts + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tags + operationId: createTag + description: | + You can use this endpoint to perform the following operations: + + **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below. + + **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below. + + **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically. + + **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below. + + **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below. + + Each operation will return a tag object. + responses: + '200': + description: Action successful + content: + application/json: + examples: + Action successful: + value: + type: tag + id: '118' + name: test + schema: + "$ref": "#/components/schemas/tag" + '400': + description: Invalid parameters + content: + application/json: + examples: + Invalid parameters: + value: + type: error.list + request_id: a7afe3c5-be52-4b69-9268-50ef1d917a1b + errors: + - code: parameter_invalid + message: invalid tag parameters + schema: + "$ref": "#/components/schemas/error" + '404': + description: User not found + content: + application/json: + examples: + Company not found: + value: + type: error.list + request_id: f0f84d9b-3c51-4904-9c21-34faba76ebf5 + errors: + - code: company_not_found + message: Company Not Found + User not found: + value: + type: error.list + request_id: 786848c6-5b9f-4e9b-aa78-2bdec45a09f5 + errors: + - code: not_found + message: User Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3609e8b1-a6aa-4c57-a994-3d95743f20a2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/create_or_update_tag_request" + - "$ref": "#/components/schemas/tag_company_request" + - "$ref": "#/components/schemas/untag_company_request" + - "$ref": "#/components/schemas/tag_multiple_users_request" + examples: + action_successful: + summary: Action successful + value: + name: test + invalid_parameters: + summary: Invalid parameters + value: + test: invalid + company_not_found: + summary: Company not found + value: + name: test + companies: + - company_id: '123' + user_not_found: + summary: User not found + value: + name: test + users: + - id: '123' + "/tags/{id}": + get: + summary: Find a specific tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: findTag + description: | + You can fetch the details of tags that are on the workspace by their id. + This will return a tag object. + responses: + '200': + description: Tag found + content: + application/json: + examples: + Tag found: + value: + type: tag + id: '126' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Tag not found: + value: + type: error.list + request_id: 20b89fb6-f224-4f81-98ca-4cb4b36df959 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 76a1d79d-3f0d-49bb-8d15-38d1ae6df738 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + delete: + summary: Delete tag + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + description: The unique identifier of a given tag + example: '123' + required: true + schema: + type: string + tags: + - Tags + operationId: deleteTag + description: You can delete the details of tags that are on the workspace by + passing in the id. + responses: + '200': + description: Successful + '404': + description: Resource not found + content: + application/json: + examples: + Resource not found: + value: + type: error.list + request_id: 111586bb-ad78-43b9-b0a0-bf864d9a3744 + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '400': + description: Tag has dependent objects + content: + application/json: + examples: + Tag has dependent objects: + value: + type: error.list + request_id: 41086388-9b3b-4e07-9633-502b9b10c926 + errors: + - code: tag_has_dependent_objects + message: 'Unable to delete Tag with dependent objects. Segments: + Seg 1.' + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3dcedf54-ed30-4337-8992-94e36900e695 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams": + get: + summary: List all teams + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Teams + operationId: listTeams + description: This will return a list of team objects for the App. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team.list + teams: [] + schema: + "$ref": "#/components/schemas/team_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 006b2c8f-9a29-463e-be69-ad213576aee6 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/teams/{id}": + get: + summary: Retrieve a team + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier of a given team. + example: '123' + schema: + type: string + tags: + - Teams + operationId: retrieveTeam + description: You can fetch the details of a single team, containing an array + of admins that belong to this team. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: team + id: '991267802' + name: team 1 + admin_ids: [] + schema: + "$ref": "#/components/schemas/team" + '404': + description: Team not found + content: + application/json: + examples: + Team not found: + value: + type: error.list + request_id: 4745dfce-7275-4864-abfd-44e0d84bf52a + errors: + - code: team_not_found + message: Team not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 110ad8e4-99ed-461a-bd93-92a5cdbaa6b2 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/ticket_types/{ticket_type_id}/attributes": + post: + summary: Create a new attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can create a new attribute for a ticket type. + operationId: createTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute created + content: + application/json: + examples: + Ticket Type Attribute created: + value: + type: ticket_type_attribute + id: '210' + workspace_id: this_is_an_id600_that_should_be_at_least_ + name: Attribute Title + description: Attribute Description + data_type: string + input_options: + multiline: false + order: 2 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: false + ticket_type_id: 81 + archived: false + created_at: 1719493013 + updated_at: 1719493013 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 3bc672fa-e051-4ede-b6e9-79f518231ba9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_attribute_request" + examples: + ticket_type_attribute_created: + summary: Ticket Type Attribute created + value: + name: Attribute Title + description: Attribute Description + data_type: string + required_to_create: false + "/ticket_types/{ticket_type_id}/attributes/{id}": + put: + summary: Update an existing attribute for a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_type_id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + - name: id + in: path + required: true + description: The unique identifier for the ticket type attribute which is + given by Intercom. + schema: + type: string + tags: + - Ticket Type Attributes + description: You can update an existing attribute for a ticket type. + operationId: updateTicketTypeAttribute + responses: + '200': + description: Ticket Type Attribute updated + content: + application/json: + examples: + Ticket Type Attribute updated: + value: + type: ticket_type_attribute + id: '215' + workspace_id: this_is_an_id604_that_should_be_at_least_ + name: name + description: New Attribute Description + data_type: string + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 83 + archived: false + created_at: 1719493013 + updated_at: 1719493014 + schema: + "$ref": "#/components/schemas/ticket_type_attribute" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 6e45414c-e627-4769-bdbd-d51f2c19e1e9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_attribute_request" + examples: + ticket_type_attribute_updated: + summary: Ticket Type Attribute updated + value: + description: New Attribute Description + "/ticket_types": + get: + summary: List all ticket types + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: listTicketTypes + description: You can get a list of all ticket types for a workspace. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: list + data: + - type: ticket_type + id: '85' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id608_that_should_be_at_least_ + archived: false + created_at: 1719493014 + updated_at: 1719493014 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '218' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '220' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + - type: ticket_type_attribute + id: '219' + workspace_id: this_is_an_id608_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 85 + archived: false + created_at: 1719493014 + updated_at: 1719493014 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type_list" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 50823491-2ab1-4b84-9700-2d92c4f367fd + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + post: + summary: Create a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Ticket Types + operationId: createTicketType + description: "You can create a new ticket type.\n> \U0001F4D8 Creating ticket + types.\n>\n> Every ticket type will be created with two default attributes: + _default_title_ and _default_description_.\n> For the `icon` propery, use + an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type created + content: + application/json: + examples: + Ticket type created: + value: + type: ticket_type + id: '88' + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id612_that_should_be_at_least_ + archived: false + created_at: 1719493016 + updated_at: 1719493016 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '227' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + - type: ticket_type_attribute + id: '228' + workspace_id: this_is_an_id612_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 88 + archived: false + created_at: 1719493016 + updated_at: 1719493016 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 7c4784fe-d3e4-4182-b9c4-918bdf253eef + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_type_request" + examples: + ticket_type_created: + summary: Ticket type created + value: + name: Customer Issue + description: Customer Report Template + icon: "\U0001F39F️" + category: Customer + "/ticket_types/{id}": + get: + summary: Retrieve a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: getTicketType + description: You can fetch the details of a single ticket type. + responses: + '200': + description: Ticket type found + content: + application/json: + examples: + Ticket type found: + value: + type: ticket_type + id: '90' + name: Bug Report + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id616_that_should_be_at_least_ + archived: false + created_at: 1719493017 + updated_at: 1719493017 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '232' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '234' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + - type: ticket_type_attribute + id: '233' + workspace_id: this_is_an_id616_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 90 + archived: false + created_at: 1719493017 + updated_at: 1719493017 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: b0100f38-119c-4e30-8560-a25561d97c66 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + put: + summary: Update a ticket type + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket type which is given by Intercom. + schema: + type: string + tags: + - Ticket Types + operationId: updateTicketType + description: "\nYou can update a ticket type.\n\n> \U0001F4D8 Updating a ticket + type.\n>\n> For the `icon` propery, use an emoji from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/)\n" + responses: + '200': + description: Ticket type updated + content: + application/json: + examples: + Ticket type updated: + value: + type: ticket_type + id: '92' + name: Bug Report 2 + description: Bug Report Template + icon: "\U0001F39F️" + workspace_id: this_is_an_id620_that_should_be_at_least_ + archived: false + created_at: 1719493018 + updated_at: 1719493018 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '238' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_title_ + description: '' + data_type: string + input_options: + multiline: false + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '240' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: name + description: description + data_type: string + input_options: + order: 0 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: false + visible_to_contacts: false + default: false + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + - type: ticket_type_attribute + id: '239' + workspace_id: this_is_an_id620_that_should_be_at_least_ + name: _default_description_ + description: '' + data_type: string + input_options: + multiline: true + order: 1 + required_to_create: false + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: true + default: true + ticket_type_id: 92 + archived: false + created_at: 1719493018 + updated_at: 1719493018 + category: Customer + schema: + "$ref": "#/components/schemas/ticket_type" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 2b0554fe-ba10-41d4-ab7b-715c2b7b8e47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_type_request" + examples: + ticket_type_updated: + summary: Ticket type updated + value: + name: Bug Report 2 + "/tickets/{id}/reply": + post: + summary: Reply to a ticket + operationId: replyTicket + description: You can reply to a ticket with a message from an admin or on behalf + of a contact, or with a note for admins. + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + schema: + title: Ticket ID + type: string + description: The id of the ticket to target. + example: '123' + tags: + - Tickets + responses: + '400': + description: User reply + content: + application/json: + examples: + User reply: + value: + type: error.list + request_id: b8b42c55-347c-4704-b4c1-92220c01f4ac + errors: + - code: parameter_mismatch + message: User replies are not allowed on Backoffice tickets + schema: + "$ref": "#/components/schemas/error" + '200': + description: Admin quick_reply reply + content: + application/json: + examples: + Admin note reply: + value: + type: ticket_part + id: '122' + part_type: note + body: |- +

An Unordered HTML List

+
    +
  • Coffee
  • +
  • Tea
  • +
  • Milk
  • +
+

An Ordered HTML List

+
    +
  1. Coffee
  2. +
  3. Tea
  4. +
  5. Milk
  6. +
+ created_at: 1719493024 + updated_at: 1719493024 + author: + id: '991267829' + type: admin + name: Ciaran375 Lee + email: admin375@email.com + attachments: [] + redacted: false + Admin quick_reply reply: + value: + type: ticket_part + id: '124' + part_type: quick_reply + created_at: 1719493029 + updated_at: 1719493029 + author: + id: '991267834' + type: admin + name: Ciaran379 Lee + email: admin379@email.com + attachments: [] + redacted: false + schema: + "$ref": "#/components/schemas/ticket_reply" + '404': + description: Not found + content: + application/json: + examples: + Not found: + value: + type: error.list + request_id: c23e8dab-6102-483c-bb1b-c62923be35ab + errors: + - code: not_found + message: Resource Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: bb012854-cca8-4fa7-972e-6c38204e8294 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + examples: + user_reply: + summary: User reply + value: + message_type: comment + type: user + intercom_user_id: 667d619d8a68186f43bafe82 + body: Thanks again :) + admin_note_reply: + summary: Admin note reply + value: + message_type: note + type: admin + admin_id: 991267829 + body: "

An Unordered HTML List

  • Coffee
  • + \
  • Tea
  • Milk

An Ordered HTML List

+ \
  1. Coffee
  2. Tea
  3. Milk
+ \ " + admin_quick_reply_reply: + summary: Admin quick_reply reply + value: + message_type: quick_reply + type: admin + admin_id: 991267834 + reply_options: + - text: 'Yes' + uuid: 22d6d1f4-1a19-41d0-94c2-e54031f78aca + - text: 'No' + uuid: fbc3dbe0-ec0c-4fb6-826d-e19127191906 + not_found: + summary: Not found + value: + message_type: comment + type: user + intercom_user_id: 667d61a68a68186f43bafe85 + body: Thanks again :) + "/tickets/{ticket_id}/tags": + post: + summary: Add tag to a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: attachTagToTicket + description: You can tag a specific ticket. This will return a tag object for + the tag that was added to the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '134' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Ticket not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: e11d8f55-82fe-4c0d-b4c6-6f22c6a694e9 + errors: + - code: ticket_not_found + message: Ticket not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: a502f48f-c80d-48fd-bea5-cafe7e24d9f9 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - id + - admin_id + properties: + id: + type: string + description: The unique identifier for the tag which is given by + Intercom + example: '7522907' + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '780' + examples: + successful: + summary: successful + value: + id: 134 + admin_id: 991267844 + ticket_not_found: + summary: Ticket not found + value: + id: 135 + admin_id: 991267847 + "/tickets/{ticket_id}/tags/{id}": + delete: + summary: Remove tag from a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: ticket_id + in: path + description: ticket_id + example: '64619700005694' + required: true + schema: + type: string + - name: id + in: path + description: The unique identifier for the tag which is given by Intercom + example: '7522907' + required: true + schema: + type: string + tags: + - Tags + - Tickets + operationId: detachTagFromTicket + description: You can remove tag from a specific ticket. This will return a tag + object for the tag that was removed from the ticket. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: tag + id: '137' + name: Manual tag + schema: + "$ref": "#/components/schemas/tag" + '404': + description: Tag not found + content: + application/json: + examples: + Ticket not found: + value: + type: error.list + request_id: ffa08bb4-3994-4132-b9e3-14837e0723e8 + errors: + - code: ticket_not_found + message: Ticket not found + Tag not found: + value: + type: error.list + request_id: d2385995-502c-4c03-bf4b-93ef3d24037b + errors: + - code: tag_not_found + message: Tag not found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 0d3be117-0a9e-4e88-9a05-4fdd7f93d7bc + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + type: object + required: + - admin_id + properties: + admin_id: + type: string + description: The unique identifier for the admin which is given + by Intercom. + example: '123' + examples: + successful: + summary: successful + value: + admin_id: 991267853 + ticket_not_found: + summary: Ticket not found + value: + admin_id: 991267856 + tag_not_found: + summary: Tag not found + value: + admin_id: 991267859 + "/tickets": + post: + summary: Create a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: You can create a new ticket. + operationId: createTicket + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '489' + ticket_id: '48' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: submitted + ticket_type: + type: ticket_type + id: '106' + name: my-ticket-type-15 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id648_that_should_be_at_least_ + archived: false + created_at: 1719493047 + updated_at: 1719493047 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '252' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + - type: ticket_type_attribute + id: '253' + workspace_id: this_is_an_id648_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 106 + archived: false + created_at: 1719493047 + updated_at: 1719493047 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61b78a68186f43bafe8d + external_id: '70' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493048 + updated_at: 1719493048 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '125' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493048 + updated_at: 1719493048 + author: + id: '991267871' + type: bot + name: Operator + email: operator+this_is_an_id648_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 745c921a-7c5a-40d4-ab28-6d28a8d2ed47 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/create_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_type_id: 106 + contacts: + - id: 667d61b78a68186f43bafe8d + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + "/tickets/{id}": + put: + summary: Update a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom + schema: + type: string + tags: + - Tickets + operationId: updateTicket + description: You can update a ticket. + responses: + '200': + description: Successful response + content: + application/json: + examples: + Successful response: + value: + type: ticket + id: '490' + ticket_id: '49' + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + ticket_state: in_progress + ticket_type: + type: ticket_type + id: '108' + name: my-ticket-type-17 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id652_that_should_be_at_least_ + archived: false + created_at: 1719493050 + updated_at: 1719493050 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '257' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + - type: ticket_type_attribute + id: '258' + workspace_id: this_is_an_id652_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 108 + archived: false + created_at: 1719493050 + updated_at: 1719493050 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61bb8a68186f43bafe8e + external_id: cd63b6b5-ea75-4ad9-b72c-9d7a647baf08 + admin_assignee_id: '991267885' + team_assignee_id: '0' + created_at: 1719493051 + updated_at: 1719493054 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '126' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493051 + updated_at: 1719493051 + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '127' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '128' + part_type: ticket_attribute_updated_by_admin + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '129' + part_type: ticket_state_updated_by_admin + ticket_state: in_progress + previous_ticket_state: submitted + created_at: 1719493053 + updated_at: 1719493053 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + - type: ticket_part + id: '130' + part_type: assignment + created_at: 1719493054 + updated_at: 1719493054 + assigned_to: + type: admin + id: '991267885' + author: + id: '991267883' + type: admin + name: Ciaran419 Lee + email: admin419@email.com + attachments: [] + redacted: false + - type: ticket_part + id: '131' + part_type: snoozed + created_at: 1719493054 + updated_at: 1719493054 + author: + id: '991267884' + type: bot + name: Operator + email: operator+this_is_an_id652_that_should_be_at_least_@intercom.io + attachments: [] + redacted: false + total_count: 6 + open: true + snoozed_until: 1719590400 + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: In progress + ticket_state_external_label: In progress + schema: + "$ref": "#/components/schemas/ticket" + '404': + description: Assignee not found + content: + application/json: + examples: + Admin not found: + value: + type: error.list + request_id: 809aceaa-c073-4e2a-96c3-a25e15576946 + errors: + - code: assignee_not_found + message: Assignee not found + Assignee not found: + value: + type: error.list + request_id: 639b5b51-1eb9-4c06-8de4-d9b0e30fff05 + errors: + - code: assignee_not_found + message: Assignee not found + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e5202025-e8f9-400a-9107-192ae8bfd50c + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_ticket_request" + examples: + successful_response: + summary: Successful response + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267883' + assignee_id: '991267885' + open: true + snoozed_until: 1673609604 + admin_not_found: + summary: Admin not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '123' + assignee_id: '991267893' + assignee_not_found: + summary: Assignee not found + value: + ticket_attributes: + _default_title_: example + _default_description_: there is a problem + state: in_progress + assignment: + admin_id: '991267899' + assignee_id: '456' + get: + summary: Retrieve a ticket + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: id + in: path + required: true + description: The unique identifier for the ticket which is given by Intercom. + schema: + type: string + tags: + - Tickets + operationId: getTicket + description: You can fetch the details of a single ticket. + responses: + '200': + description: Ticket found + content: + application/json: + examples: + Ticket found: + value: + type: ticket + id: '493' + ticket_id: '52' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '112' + name: my-ticket-type-21 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id660_that_should_be_at_least_ + archived: false + created_at: 1719493060 + updated_at: 1719493060 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '268' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + - type: ticket_type_attribute + id: '269' + workspace_id: this_is_an_id660_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 112 + archived: false + created_at: 1719493060 + updated_at: 1719493060 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c48a68186f43bafe91 + external_id: '038050f6-d917-4b9d-89cb-539b1d371172' + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493061 + updated_at: 1719493061 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '134' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493061 + updated_at: 1719493061 + author: + id: '991267912' + type: admin + name: Ciaran445 Lee + email: admin445@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: e7ba89f2-3bc8-4fc3-97bc-56f62f342680 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/tickets/search": + post: + summary: Search tickets + operationId: searchTickets + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Tickets + description: | + You can search for multiple tickets by the value of their attributes in order to fetch exactly which ones you want. + + To search for tickets, you send a `POST` request to `https://api.intercom.io/tickets/search`. + + This will accept a query object in the body which will define your filters. + {% admonition type="warning" name="Optimizing search queries" %} + Search queries can be complex, so optimizing them can help the performance of your search. + Use the `AND` and `OR` operators to combine multiple filters to get the exact results you need and utilize + pagination to limit the number of results returned. The default is `20` results per page. + See the [pagination section](https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination/#example-search-conversations-request) for more details on how to use the `starting_after` param. + {% /admonition %} + + ### Nesting & Limitations + + You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4). + There are some limitations to the amount of multiples there can be: + - There's a limit of max 2 nested filters + - There's a limit of max 15 filters for each AND or OR group + + ### Accepted Fields + + Most keys listed as part of the Ticket model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foobar"`). + + | Field | Type | + | :---------------------------------------- | :--------------------------------------------------------------------------------------- | + | id | String | + | created_at | Date (UNIX timestamp) | + | updated_at | Date (UNIX timestamp) | + | _default_title_ | String | + | _default_description_ | String | + | category | String | + | ticket_type_id | String | + | contact_ids | String | + | teammate_ids | String | + | admin_assignee_id | String | + | team_assignee_id | String | + | open | Boolean | + | state | String | + | snoozed_until | Date (UNIX timestamp) | + | ticket_attribute.{id} | String or Boolean or Date (UNIX timestamp) or Float or Integer | + + ### Accepted Operators + + {% admonition type="info" name="Searching based on `created_at`" %} + You may use the `<=` or `>=` operators to search by `created_at`. + {% /admonition %} + + The table below shows the operators you can use to define how you want to search for the value. The operator should be put in as a string (`"="`). The operator has to be compatible with the field's type (eg. you cannot search with `>` for a given string value as it's only compatible for integer's and dates). + + | Operator | Valid Types | Description | + | :------- | :----------------------------- | :----------------------------------------------------------- | + | = | All | Equals | + | != | All | Doesn't Equal | + | IN | All | In Shortcut for `OR` queries Values most be in Array | + | NIN | All | Not In Shortcut for `OR !` queries Values must be in Array | + | > | Integer Date (UNIX Timestamp) | Greater (or equal) than | + | < | Integer Date (UNIX Timestamp) | Lower (or equal) than | + | ~ | String | Contains | + | !~ | String | Doesn't Contain | + | ^ | String | Starts With | + | $ | String | Ends With | + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: ticket.list + pages: + type: pages + page: 1 + per_page: 5 + total_pages: 1 + total_count: 1 + tickets: + - type: ticket + id: '494' + ticket_id: '53' + ticket_attributes: + _default_title_: attribute_value + _default_description_: + ticket_state: submitted + ticket_type: + type: ticket_type + id: '117' + name: my-ticket-type-26 + description: my ticket type description is awesome. + icon: "\U0001F981" + workspace_id: this_is_an_id667_that_should_be_at_least_ + archived: false + created_at: 1719493065 + updated_at: 1719493065 + is_internal: false + ticket_type_attributes: + type: list + data: + - type: ticket_type_attribute + id: '279' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_title_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + - type: ticket_type_attribute + id: '280' + workspace_id: this_is_an_id667_that_should_be_at_least_ + name: _default_description_ + description: ola + data_type: string + input_options: + order: 0 + required_to_create: true + required_to_create_for_contacts: false + visible_on_create: true + visible_to_contacts: false + default: false + ticket_type_id: 117 + archived: false + created_at: 1719493065 + updated_at: 1719493065 + category: Back-office + contacts: + type: contact.list + contacts: + - type: contact + id: 667d61c98a68186f43bafe92 + external_id: 6895b33e-2768-4611-908e-da6632dfc8ea + admin_assignee_id: '0' + team_assignee_id: '0' + created_at: 1719493065 + updated_at: 1719493066 + ticket_parts: + type: ticket_part.list + ticket_parts: + - type: ticket_part + id: '135' + part_type: ticket_state_updated_by_admin + ticket_state: submitted + previous_ticket_state: submitted + created_at: 1719493066 + updated_at: 1719493066 + author: + id: '991267940' + type: admin + name: Ciaran472 Lee + email: admin472@email.com + attachments: [] + redacted: false + total_count: 1 + open: true + linked_objects: + type: list + data: [] + total_count: 0 + has_more: false + category: Back-office + is_shared: false + ticket_state_internal_label: Submitted + ticket_state_external_label: Submitted + schema: + "$ref": "#/components/schemas/ticket_list" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/search_request" + examples: + successful: + summary: successful + value: + query: + operator: AND + value: + - field: created_at + operator: ">" + value: '1306054154' + pagination: + per_page: 5 + "/visitors": + put: + summary: Update a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: updateVisitor + description: | + Sending a PUT request to `/visitors` will result in an update of an existing Visitor. + + **Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body. + + **Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61cc8a68186f43bafe95 + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: Gareth Bale + pseudonym: Indigo Ghost + avatar: + type: avatar + image_url: https://static.intercomassets.com/app/pseudonym_avatars_2019/indigo-ghost.png + app_id: this_is_an_id671_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493068 + remote_created_at: 1719493068 + signed_up_at: 1719493068 + updated_at: 1719493068 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: visitor Not Found + content: + application/json: + examples: + visitor Not Found: + value: + type: error.list + request_id: 1f35dc86-17d2-4bfe-8cb1-9afa74adc24c + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 82df3971-fb7c-410d-a919-e8bc1b3d991a + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/update_visitor_request" + examples: + successful: + summary: successful + value: + id: 667d61cc8a68186f43bafe95 + name: Gareth Bale + visitor_not_found: + summary: visitor Not Found + value: + user_id: fail + name: Christian Fail + get: + summary: Retrieve a visitor with User ID + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + - name: user_id + in: query + description: The user_id of the Visitor you want to retrieve. + required: true + schema: + type: string + tags: + - Visitors + operationId: retrieveVisitorWithUserId + description: You can fetch the details of a single visitor. + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: visitor + id: 667d61ce8a68186f43bafe9b + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + anonymous: true + email: '' + phone: + name: + pseudonym: + avatar: + type: avatar + image_url: + app_id: this_is_an_id677_that_should_be_at_least_ + companies: + type: company.list + companies: [] + location_data: {} + last_request_at: + created_at: 1719493070 + remote_created_at: 1719493070 + signed_up_at: 1719493070 + updated_at: 1719493070 + session_count: 0 + social_profiles: + type: social_profile.list + social_profiles: [] + owner_id: + unsubscribed_from_emails: false + marked_email_as_spam: false + has_hard_bounced: false + tags: + type: tag.list + tags: [] + segments: + type: segment.list + segments: [] + custom_attributes: {} + referrer: + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + do_not_track: + schema: + "$ref": "#/components/schemas/visitor" + '404': + description: Visitor not found + content: + application/json: + examples: + Visitor not found: + value: + type: error.list + request_id: 7359afef-98f5-4b22-9de7-902f7a214729 + errors: + - code: not_found + message: Visitor Not Found + schema: + "$ref": "#/components/schemas/error" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: 25dace4f-4916-492c-823b-f0cca227dff0 + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + "/visitors/convert": + post: + summary: Convert a visitor + parameters: + - name: Intercom-Version + in: header + schema: + "$ref": "#/components/schemas/intercom_version" + tags: + - Visitors + operationId: convertVisitor + description: "You can merge a Visitor to a Contact of role type `lead` or `user`.\n\n> + \U0001F4D8 What happens upon a visitor being converted?\n>\n> If the User + exists, then the Visitor will be merged into it, the Visitor deleted and the + User returned. If the User does not exist, the Visitor will be converted to + a User, with the User identifiers replacing it's Visitor identifiers.\n" + responses: + '200': + description: successful + content: + application/json: + examples: + successful: + value: + type: contact + id: 667d61d08a68186f43bafea2 + workspace_id: this_is_an_id683_that_should_be_at_least_ + external_id: + role: user + email: foo@bar.com + phone: + name: + avatar: + owner_id: + social_profiles: + type: list + data: [] + has_hard_bounced: false + marked_email_as_spam: false + unsubscribed_from_emails: false + created_at: 1719493072 + updated_at: 1719493072 + signed_up_at: 1719493072 + last_seen_at: + last_replied_at: + last_contacted_at: + last_email_opened_at: + last_email_clicked_at: + language_override: + browser: + browser_version: + browser_language: + os: + location: + type: location + country: + region: + city: + country_code: + continent_code: + android_app_name: + android_app_version: + android_device: + android_os_version: + android_sdk_version: + android_last_seen_at: + ios_app_name: + ios_app_version: + ios_device: + ios_os_version: + ios_sdk_version: + ios_last_seen_at: + custom_attributes: {} + tags: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/tags" + total_count: 0 + has_more: false + notes: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/notes" + total_count: 0 + has_more: false + companies: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/companies" + total_count: 0 + has_more: false + opted_out_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + opted_in_subscription_types: + type: list + data: [] + url: "/contacts/667d61d08a68186f43bafea2/subscriptions" + total_count: 0 + has_more: false + utm_campaign: + utm_content: + utm_medium: + utm_source: + utm_term: + referrer: + schema: + "$ref": "#/components/schemas/contact" + '401': + description: Unauthorized + content: + application/json: + examples: + Unauthorized: + value: + type: error.list + request_id: fe1a587a-e682-4a96-bd30-ea08b726e6fa + errors: + - code: unauthorized + message: Access Token Invalid + schema: + "$ref": "#/components/schemas/error" + requestBody: + content: + application/json: + schema: + "$ref": "#/components/schemas/convert_visitor_request" + examples: + successful: + summary: successful + value: + visitor: + user_id: 3ecf64d0-9ed1-4e9f-88e1-da7d6e6782f3 + user: + email: foo@bar.com + type: user +components: + schemas: + activity_log: + title: Activity Log + type: object + description: Activities performed by Admins. + nullable: true + properties: + id: + type: string + description: The id representing the activity. + example: '6' + performed_by: + type: object + description: Details about the Admin involved in the activity. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + email: + type: string + description: The email of the admin. + example: john@example.com + ip: + type: string + description: The IP address of the admin. + example: 198.51.100.255 + metadata: + "$ref": "#/components/schemas/activity_log_metadata" + created_at: + type: integer + format: date-time + description: The time the activity was created. + example: 1671028894 + activity_type: + type: string + enum: + - admin_assignment_limit_change + - admin_away_mode_change + - admin_deletion + - admin_deprovisioned + - admin_impersonation_end + - admin_impersonation_start + - admin_invite_change + - admin_invite_creation + - admin_invite_deletion + - admin_login_failure + - admin_login_success + - admin_logout + - admin_password_reset_request + - admin_password_reset_success + - admin_permission_change + - admin_provisioned + - admin_two_factor_auth_change + - admin_unauthorized_sign_in_method + - app_admin_join + - app_authentication_method_change + - app_data_deletion + - app_data_export + - app_google_sso_domain_change + - app_identity_verification_change + - app_name_change + - app_outbound_address_change + - app_package_installation + - app_package_token_regeneration + - app_package_uninstallation + - app_team_creation + - app_team_deletion + - app_team_membership_modification + - app_timezone_change + - app_webhook_creation + - app_webhook_deletion + - articles_in_messenger_enabled_change + - bulk_delete + - bulk_export + - campaign_deletion + - campaign_state_change + - conversation_part_deletion + - conversation_topic_change + - conversation_topic_creation + - conversation_topic_deletion + - help_center_settings_change + - inbound_conversations_change + - inbox_access_change + - message_deletion + - message_state_change + - messenger_look_and_feel_change + - messenger_search_required_change + - messenger_spaces_change + - office_hours_change + - role_change + - role_creation + - role_deletion + - ruleset_activation_title_preview + - ruleset_creation + - ruleset_deletion + - search_browse_enabled_change + - search_browse_required_change + - seat_change + - seat_revoke + - security_settings_change + - temporary_expectation_change + - upfront_email_collection_change + - welcome_message_change + example: app_name_change + activity_description: + type: string + description: A sentence or two describing the activity. + example: Admin updated the app's name to "My App". + activity_log_list: + title: Paginated Response + type: object + description: A paginated list of activity logs. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `activity_log.list`. + example: activity_log.list + pages: + "$ref": "#/components/schemas/cursor_pages" + activity_logs: + type: array + description: An array of activity logs + items: + "$ref": "#/components/schemas/activity_log" + activity_log_metadata: + title: Activity Log Metadata + type: object + description: Additional data provided about Admin activity. + nullable: true + properties: + sign_in_method: + type: string + nullable: true + description: The way the admin signed in. + example: email_password + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + away_mode: + type: boolean + nullable: true + description: The away mode status which is set to true when away and false + when returned. + example: true + away_status_reason: + type: string + nullable: true + description: The reason the Admin is away. + example: "\U0001F60C On a break" + reassign_conversations: + type: boolean + nullable: true + description: Indicates if conversations should be reassigned while an Admin + is away. + example: false + source: + type: string + nullable: true + description: The action that initiated the status change. + example: 'admin update from web - Admin id: 93' + auto_changed: + type: string + nullable: true + description: Indicates if the status was changed automatically or manually. + example: false + update_by: + type: integer + nullable: true + description: The ID of the Admin who initiated the activity. + example: 93 + update_by_name: + type: string + nullable: true + description: The name of the Admin who initiated the activity. + example: Joe Bloggs + addressable_list: + title: Addressable List + type: object + nullable: false + description: A list used to access other resources from a parent model. + properties: + type: + type: string + format: uri + description: The addressable object type + example: note + id: + type: string + description: The id of the addressable object + example: '123' + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + admin: + title: Admin + type: object + x-tags: + - Admins + description: Admins are teammate accounts that have access to a workspace. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This object represents the avatar associated with the admin. + example: + - 814865 + items: + type: integer + avatar: + type: string + format: uri + nullable: true + description: Image for the associated team or teammate + example: https://picsum.photos/200/300 + team_priority_level: + "$ref": "#/components/schemas/team_priority_level" + admin_list: + title: Admins + type: object + description: A list of admins associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin.list`. + example: admin.list + admins: + type: array + description: A list of admins associated with a given workspace. + items: + "$ref": "#/components/schemas/admin" + admin_priority_level: + title: Admin Priority Level + type: object + nullable: true + description: Admin priority levels for the team + properties: + primary_admin_ids: + type: array + description: The primary admin ids for the team + nullable: true + example: + - 493881 + items: + type: integer + secondary_admin_ids: + type: array + description: The secondary admin ids for the team + nullable: true + example: + - 814865 + items: + type: integer + admin_reply_conversation_request: + title: Admin Reply + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_reply_ticket_request: + title: Admin Reply on ticket + type: object + description: Payload of the request to reply on behalf of an admin + properties: + message_type: + type: string + enum: + - comment + - note + - quick_reply + example: comment + type: + type: string + enum: + - admin + example: admin + body: + type: string + description: The text body of the reply. Notes accept some HTML formatting. + Must be present for comment and note message types. + example: Hello there! + admin_id: + type: string + description: The id of the admin who is authoring the comment. + example: '3156780' + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + reply_options: + title: Quick Reply Options + type: array + description: The quick reply options to display. Must be present for quick_reply + message types. + items: + title: Quick Reply Option + type: object + properties: + text: + type: string + description: The text to display in this quick reply option. + uuid: + type: string + format: uuid + description: A unique identifier for this quick reply option. This + value will be available within the metadata of the comment ticket + part that is created when a user clicks on this reply option. + required: + - text + - uuid + attachment_urls: + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - admin_id + admin_with_app: + title: Admin + type: object + description: Admins are the teammate accounts that have access to a workspace + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `admin`. + example: admin + id: + type: string + description: The id representing the admin. + example: '1295' + name: + type: string + description: The name of the admin. + example: Hoban Washburne + email: + type: string + description: The email of the admin. + example: wash@serenity.io + job_title: + type: string + description: The job title of the admin. + example: Philosopher + away_mode_enabled: + type: boolean + description: Identifies if this admin is currently set in away mode. + example: false + away_mode_reassign: + type: boolean + description: Identifies if this admin is set to automatically reassign new + conversations to the apps default inbox. + example: false + has_inbox_seat: + type: boolean + description: Identifies if this admin has a paid inbox seat to restrict/allow + features that require them. + example: true + team_ids: + type: array + description: This is a list of ids of the teams that this admin is part + of. + example: + - 814865 + items: + type: integer + avatar: + type: object + description: This object represents the avatar associated with the admin. + properties: + type: + type: string + description: This is a string that identifies the type of the object. + It will always have the value `avatar`. + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the admin. + example: https://example.com/avatar.png + email_verified: + type: boolean + description: Identifies if this admin's email is verified. + nullable: true + example: true + app: + "$ref": "#/components/schemas/app" + nullable: true + description: App that the admin belongs to. + ai_agent: + title: AI Agent + type: object + x-tags: + - Ai Agent + description: Data related to AI Agent involvement in the conversation. + properties: + source_type: + type: string + description: The type of the source that triggered AI Agent involvement + in the conversation. + enum: + - essentials_plan_setup + - profile + - workflow + - workflow_preview + - fin_preview + example: workflow + source_title: + type: string + description: The title of the source that triggered AI Agent involvement + in the conversation. If this is `essentials_plan_setup` then it will return + `null`. + example: My AI Workflow + nullable: true + last_answer_type: + type: string + description: The type of the last answer delivered by AI Agent. If no answer + was delivered then this will return `null` + enum: + - + - ai_answer + - custom_answer + example: ai_answer + nullable: true + resolution_state: + type: string + description: The resolution state of AI Agent. If no AI or custom answer + has been delivered then this will return `null`. + enum: + - assumed_resolution + - confirmed_resolution + - routed_to_team + - abandoned + - + example: assumed_resolution + nullable: true + rating: + type: integer + description: The customer satisfaction rating given to AI Agent, from 1-5. + example: 4 + nullable: true + rating_remark: + type: string + description: The customer satisfaction rating remark given to AI Agent. + example: Very helpful! + nullable: true + content_sources: + "$ref": "#/components/schemas/content_sources_list" + app: + title: App + type: object + description: App is a workspace on Intercom + nullable: true + properties: + type: + type: string + description: '' + default: app + example: app + id_code: + type: string + description: The id of the app. + example: xyz789 + name: + type: string + description: The name of the app. + example: ACME + region: + type: string + description: The Intercom region the app is located in. + example: US + timezone: + type: string + description: The timezone of the region where the app is located. + example: America/Los_Angeles + created_at: + type: integer + description: When the app was created. + example: 1671465577 + identity_verification: + type: boolean + description: Whether or not the app uses identity verification. + example: false + article: + title: Article + type: object + x-tags: + - Articles + description: The Articles API is a central place to gather all information and + take actions on your articles. Articles can live within collections and sections, + or alternatively they can stand alone. + properties: + statistics: + nullable: true + "$ref": "#/components/schemas/article_statistics" + allOf: + - "$ref": "#/components/schemas/article_list_item" + article_content: + title: Article Content + type: object + description: The Content of an Article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_content` . + enum: + - + - article_content + example: article_content + nullable: true + title: + type: string + description: The title of the article. + example: How to create a new article + description: + type: string + description: The description of the article. + example: This article will show you how to create a new article. + body: + type: string + description: The body of the article. + example: This is the body of the article. + author_id: + type: integer + description: The ID of the author of the article. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft` . + enum: + - published + - draft + example: draft + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). + example: 1663597260 + url: + type: string + description: The URL of the article. + example: http://intercom.test/help/en/articles/3-default-language + article_list: + title: Articles + type: object + description: This will return a list of articles for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of articles. + example: 1 + data: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article_list_item" + article_list_item: + title: Articles + type: object + x-tags: + - Articles + description: The data returned about your articles when you list them. + properties: + type: + type: string + description: The type of object - `article`. + enum: + - article + default: article + example: article + id: + type: string + description: The unique identifier for the article which is given by Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the article belongs to. + example: hfi1bx4l + title: + type: string + description: The title of the article. For multilingual articles, this will + be the title of the default language's content. + example: Default language title + description: + type: string + nullable: true + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Default language description + body: + type: string + nullable: true + description: The body of the article in HTML. For multilingual articles, + this will be the body of the default language's content. + example: Default language body in html + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: '5017691' + state: + type: string + description: Whether the article is `published` or is a `draft`. For multilingual + articles, this will be the state of the default language's content. + enum: + - published + - draft + default: draft + example: published + created_at: + type: integer + format: date-time + description: The time when the article was created. For multilingual articles, + this will be the timestamp of creation of the default language's content + in seconds. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated. For multilingual + articles, this will be the timestamp of last update of the default language's + content in seconds. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the article. For multilingual articles, this will + be the URL of the default language's content. + example: http://intercom.test/help/en/articles/3-default-language + parent_id: + type: integer + nullable: true + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '125685' + parent_ids: + type: array + description: The ids of the article's parent collections or sections. An + article without this field stands alone. + items: + type: integer + example: + - 18 + - 19 + parent_type: + type: string + nullable: true + description: The type of parent, which can either be a `collection` or `section`. + example: collection + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/article_translated_content" + article_search_highlights: + title: Article Search Highlights + type: object + x-tags: + - Articles + description: The highlighted results of an Article search. In the examples provided + my search query is always "my query". + properties: + article_id: + type: string + description: The ID of the corresponding article. + example: '123' + highlighted_title: + type: array + description: An Article title highlighted. + items: + type: object + description: A highlighted article title. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'The highlight is ' + text: + type: string + description: The text of the title. + example: my query + highlighted_summary: + type: array + description: An Article description and body text highlighted. + items: + type: array + description: An array containing the highlighted summary text split into + chunks of plain and highlighted text. + items: + type: object + description: An instance of highlighted summary text. + properties: + type: + type: string + description: The type of text - `highlight` or `plain`. + enum: + - highlight + - plain + example: 'How to highlight ' + text: + type: string + description: The text of the title. + example: my query + article_search_response: + title: Article Search Response + type: object + x-tags: + - Articles + description: The results of an Article search + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + total_count: + type: integer + description: The total number of Articles matching the search query + example: 5 + data: + type: object + description: An object containing the results of the search. + properties: + articles: + type: array + description: An array of Article objects + items: + "$ref": "#/components/schemas/article" + highlights: + type: array + description: A corresponding array of highlighted Article content + items: + "$ref": "#/components/schemas/article_search_highlights" + pages: + "$ref": "#/components/schemas/cursor_pages" + article_statistics: + title: Article Statistics + type: object + description: The statistics of an article. + nullable: true + properties: + type: + type: string + description: The type of object - `article_statistics`. + enum: + - article_statistics + default: article_statistics + example: article_statistics + views: + type: integer + description: The number of total views the article has received. + example: 10 + conversions: + type: integer + description: The number of conversations started from the article. + example: 0 + reactions: + type: integer + description: The number of total reactions the article has received. + example: 10 + happy_reaction_percentage: + type: number + format: float + description: The percentage of happy reactions the article has received + against other types of reaction. + example: 40.0 + neutral_reaction_percentage: + type: number + format: float + description: The percentage of neutral reactions the article has received + against other types of reaction. + example: 40.0 + sad_reaction_percentage: + type: number + format: float + description: The percentage of sad reactions the article has received against + other types of reaction. + example: 20.0 + article_translated_content: + title: Article Translated Content + type: object + description: The Translated Content of an Article. The keys are the locale codes + and the values are the translated content of the article. + nullable: true + properties: + type: + type: string + description: The type of object - article_translated_content. + enum: + - + - article_translated_content + example: article_translated_content + nullable: true + ar: + description: The content of the article in Arabic + "$ref": "#/components/schemas/article_content" + bg: + description: The content of the article in Bulgarian + "$ref": "#/components/schemas/article_content" + bs: + description: The content of the article in Bosnian + "$ref": "#/components/schemas/article_content" + ca: + description: The content of the article in Catalan + "$ref": "#/components/schemas/article_content" + cs: + description: The content of the article in Czech + "$ref": "#/components/schemas/article_content" + da: + description: The content of the article in Danish + "$ref": "#/components/schemas/article_content" + de: + description: The content of the article in German + "$ref": "#/components/schemas/article_content" + el: + description: The content of the article in Greek + "$ref": "#/components/schemas/article_content" + en: + description: The content of the article in English + "$ref": "#/components/schemas/article_content" + es: + description: The content of the article in Spanish + "$ref": "#/components/schemas/article_content" + et: + description: The content of the article in Estonian + "$ref": "#/components/schemas/article_content" + fi: + description: The content of the article in Finnish + "$ref": "#/components/schemas/article_content" + fr: + description: The content of the article in French + "$ref": "#/components/schemas/article_content" + he: + description: The content of the article in Hebrew + "$ref": "#/components/schemas/article_content" + hr: + description: The content of the article in Croatian + "$ref": "#/components/schemas/article_content" + hu: + description: The content of the article in Hungarian + "$ref": "#/components/schemas/article_content" + id: + description: The content of the article in Indonesian + "$ref": "#/components/schemas/article_content" + it: + description: The content of the article in Italian + "$ref": "#/components/schemas/article_content" + ja: + description: The content of the article in Japanese + "$ref": "#/components/schemas/article_content" + ko: + description: The content of the article in Korean + "$ref": "#/components/schemas/article_content" + lt: + description: The content of the article in Lithuanian + "$ref": "#/components/schemas/article_content" + lv: + description: The content of the article in Latvian + "$ref": "#/components/schemas/article_content" + mn: + description: The content of the article in Mongolian + "$ref": "#/components/schemas/article_content" + nb: + description: The content of the article in Norwegian + "$ref": "#/components/schemas/article_content" + nl: + description: The content of the article in Dutch + "$ref": "#/components/schemas/article_content" + pl: + description: The content of the article in Polish + "$ref": "#/components/schemas/article_content" + pt: + description: The content of the article in Portuguese (Portugal) + "$ref": "#/components/schemas/article_content" + ro: + description: The content of the article in Romanian + "$ref": "#/components/schemas/article_content" + ru: + description: The content of the article in Russian + "$ref": "#/components/schemas/article_content" + sl: + description: The content of the article in Slovenian + "$ref": "#/components/schemas/article_content" + sr: + description: The content of the article in Serbian + "$ref": "#/components/schemas/article_content" + sv: + description: The content of the article in Swedish + "$ref": "#/components/schemas/article_content" + tr: + description: The content of the article in Turkish + "$ref": "#/components/schemas/article_content" + vi: + description: The content of the article in Vietnamese + "$ref": "#/components/schemas/article_content" + pt-BR: + description: The content of the article in Portuguese (Brazil) + "$ref": "#/components/schemas/article_content" + zh-CN: + description: The content of the article in Chinese (China) + "$ref": "#/components/schemas/article_content" + zh-TW: + description: The content of the article in Chinese (Taiwan) + "$ref": "#/components/schemas/article_content" + assign_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + message_type: + type: string + enum: + - assignment + example: assignment + type: + type: string + enum: + - admin + - team + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + assignee_id: + type: string + description: The `id` of the `admin` or `team` which will be assigned the + conversation. A conversation can be assigned both an admin and a team.\nSet + `0` if you want this assign to no admin or team (ie. Unassigned). + example: '4324241' + body: + type: string + description: Optionally you can send a response in the conversation when + it is assigned. + example: Let me pass you over to one of my colleagues. + required: + - message_type + - type + - admin_id + - assignee_id + attach_contact_to_conversation_request: + title: Assign Conversation Request + type: object + description: Payload of the request to assign a conversation + properties: + admin_id: + type: string + description: The `id` of the admin who is adding the new participant. + example: '12345' + customer: + type: object + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + example: 6329bd9ffe4e2e91dac76188 + customer: + "$ref": "#/components/schemas/customer_request" + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. + example: winstonsmith@truth.org + customer: + "$ref": "#/components/schemas/customer_request" + required: + - email + close_conversation_request: + title: Close Conversation Request + type: object + description: Payload of the request to close a conversation + properties: + message_type: + type: string + enum: + - close + example: close + type: + type: string + enum: + - admin + example: admin + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '12345' + body: + type: string + description: Optionally you can leave a message in the conversation to provide + additional context to the user and other teammates. + example: " This conversation is now closed!" + required: + - message_type + - type + - admin_id + collection: + title: Collection + type: object + x-tags: + - Help Center + description: Collections are top level containers for Articles within the Help + Center. + properties: + id: + type: string + description: The unique identifier for the collection which is given by + Intercom. + example: '6871119' + workspace_id: + type: string + description: The id of the workspace which the collection belongs to. + example: hfi1bx4l + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: Default language name + description: + type: string + nullable: true + description: The description of the collection. For multilingual help centers, + this will be the description of the collection for the default language. + example: Default language description + created_at: + type: integer + format: date-time + description: The time when the article was created (seconds). For multilingual + articles, this will be the timestamp of creation of the default language's + content. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the article was last updated (seconds). For multilingual + articles, this will be the timestamp of last update of the default language's + content. + example: 1672928610 + url: + type: string + nullable: true + description: The URL of the collection. For multilingual help centers, this + will be the URL of the collection for the default language. + example: http://intercom.test/help/collection/name + icon: + type: string + nullable: true + description: The icon of the collection. + example: book-bookmark + order: + type: integer + description: The order of the section in relation to others sections within + a collection. Values go from `0` upwards. `0` is the default if there's + no order. + example: '1' + default_locale: + type: string + description: The default locale of the help center. This field is only returned + for multilingual help centers. + example: en + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it is the first + level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center the collection is in. + example: '123' + collection_list: + title: Collections + type: object + description: This will return a list of Collections for the App. + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of collections. + example: 1 + data: + type: array + description: An array of collection objects + items: + "$ref": "#/components/schemas/collection" + company: + title: Company + type: object + x-tags: + - Companies + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + properties: + type: + type: string + description: Value is `company` + enum: + - company + example: company + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + name: + type: string + description: The name of the company. + example: Blue Sun + app_id: + type: string + description: The Intercom defined code of the workspace the company is associated + to. + example: ecahpwf5 + plan: + type: object + properties: + type: + type: string + description: Value is always "plan" + example: plan + id: + type: string + description: The id of the plan + example: '269315' + name: + type: string + description: The name of the plan + example: Pro + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1663597223 + created_at: + type: integer + description: The time the company was added in Intercom. + example: 1663597223 + updated_at: + type: integer + description: The last time the company was updated. + example: 1663597223 + last_request_at: + type: integer + description: The time the company last recorded making a request. + example: 1663597223 + size: + type: integer + description: The number of employees in the company. + example: 100 + website: + type: string + description: The URL for the company website. + example: https://www.intercom.com + industry: + type: string + description: The industry that the company operates in. + example: Software + monthly_spend: + type: integer + description: How much revenue the company generates for your business. + example: 100 + session_count: + type: integer + description: How many sessions the company has recorded. + example: 100 + user_count: + type: integer + description: The number of users in the company. + example: 100 + custom_attributes: + type: object + description: The custom attributes you have set on the company. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + tags: + type: object + description: The list of tags associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + tags: + type: array + items: + items: + "$ref": "#/components/schemas/tag" + segments: + type: object + description: The list of segments associated with the company + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + segments: + type: array + items: + "$ref": "#/components/schemas/segment" + company_attached_contacts: + title: Company Attached Contacts + type: object + description: A list of Contact Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Contact Objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: The total number of contacts + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + company_attached_segments: + title: Company Attached Segments + type: object + description: A list of Segment Objects + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + description: An array containing Segment Objects + items: + "$ref": "#/components/schemas/segment" + company_list: + title: Companies + type: object + description: This will return a list of companies for the App. + properties: + type: + type: string + description: The type of object - `list`. + enum: + - list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies. + example: 100 + data: + type: array + description: An array containing Company Objects. + items: + "$ref": "#/components/schemas/company" + company_scroll: + title: Company Scroll + type: object + description: Companies allow you to represent organizations using your product. + Each company will have its own description and be associated with contacts. + You can fetch, create, update and list companies. + nullable: true + properties: + type: + type: string + description: The type of object - `list` + enum: + - list + example: list + data: + type: array + items: + "$ref": "#/components/schemas/company" + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: The total number of companies + nullable: true + example: 100 + scroll_param: + type: string + description: The scroll parameter to use in the next request to fetch the + next page of results. + example: 25b649f7-4d33-4ef6-88f5-60e5b8244309 + contact: + title: Contact + type: object + x-tags: + - Contacts + description: Contact are the objects that represent your leads and users in + Intercom. + properties: + type: + type: string + description: The type of object. + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + workspace_id: + type: string + description: The id of the workspace which the contact belongs to. + example: ecahpwf5 + role: + type: string + description: The role of the contact. + example: user + email: + type: string + description: The contact's email. + example: joe@example.com + email_domain: + type: string + description: The contact's email domain. + example: example.com + phone: + type: string + nullable: true + description: The contacts phone. + example: "+1123456789" + formatted_phone: + type: string + nullable: true + description: The contacts phone number normalized to the E164 format + example: "+1123456789" + name: + type: string + nullable: true + description: The contacts name. + example: John Doe + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact. + example: 123 + has_hard_bounced: + type: boolean + description: Whether the contact has had an email sent to them hard bounce. + example: true + marked_email_as_spam: + type: boolean + description: Whether the contact has marked an email sent to them as spam. + example: true + unsubscribed_from_emails: + type: boolean + description: Whether the contact is unsubscribed from emails. + example: true + created_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was created." + example: 1571672154 + updated_at: + type: integer + format: date-time + description: "(UNIX timestamp) The time when the contact was last updated." + example: 1571672154 + signed_up_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time specified for when a contact signed + up." + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last seen (either + where the Intercom Messenger was installed or when specified manually)." + example: 1571672154 + last_replied_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last messaged in." + example: 1571672154 + last_contacted_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact was last messaged." + example: 1571672154 + last_email_opened_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last opened an + email." + example: 1571672154 + last_email_clicked_at: + type: integer + format: date-time + nullable: true + description: "(UNIX timestamp) The time when the contact last clicked a + link in an email." + example: 1571672154 + language_override: + type: string + nullable: true + description: A preferred language setting for the contact, used by the Intercom + Messenger even if their browser settings change. + example: en + browser: + type: string + nullable: true + description: The name of the browser which the contact is using. + example: Chrome + browser_version: + type: string + nullable: true + description: The version of the browser which the contact is using. + example: 80.0.3987.132 + browser_language: + type: string + nullable: true + description: The language set by the browser which the contact is using. + example: en-US + os: + type: string + nullable: true + description: The operating system which the contact is using. + example: Mac OS X + android_app_name: + type: string + nullable: true + description: The name of the Android app which the contact is using. + example: Intercom + android_app_version: + type: string + nullable: true + description: The version of the Android app which the contact is using. + example: 5.0.0 + android_device: + type: string + nullable: true + description: The Android device which the contact is using. + example: Pixel 3 + android_os_version: + type: string + nullable: true + description: The version of the Android OS which the contact is using. + example: '10' + android_sdk_version: + type: string + nullable: true + description: The version of the Android SDK which the contact is using. + example: '28' + android_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The time when the contact was last seen on + an Android device." + example: 1571672154 + ios_app_name: + type: string + nullable: true + description: The name of the iOS app which the contact is using. + example: Intercom + ios_app_version: + type: string + nullable: true + description: The version of the iOS app which the contact is using. + example: 5.0.0 + ios_device: + type: string + nullable: true + description: The iOS device which the contact is using. + example: iPhone 11 + ios_os_version: + type: string + nullable: true + description: The version of iOS which the contact is using. + example: 13.3.1 + ios_sdk_version: + type: string + nullable: true + description: The version of the iOS SDK which the contact is using. + example: 13.3.1 + ios_last_seen_at: + type: integer + nullable: true + format: date-time + description: "(UNIX timestamp) The last time the contact used the iOS app." + example: 1571672154 + custom_attributes: + type: object + description: The custom attributes which are set for the contact. + avatar: + type: object + nullable: true + properties: + type: + type: string + description: The type of object + example: avatar + image_url: + type: string + format: uri + nullable: true + description: An image URL containing the avatar of a contact. + example: https://example.org/128Wash.jpg + tags: + "$ref": "#/components/schemas/contact_tags" + notes: + "$ref": "#/components/schemas/contact_notes" + companies: + "$ref": "#/components/schemas/contact_companies" + location: + "$ref": "#/components/schemas/contact_location" + social_profiles: + "$ref": "#/components/schemas/contact_social_profiles" + contact_archived: + title: Contact Archived + type: object + description: archived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: true + contact_attached_companies: + title: Contact Attached Companies + type: object + description: A list of Company Objects + properties: + type: + type: string + description: The type of object + enum: + - list + example: list + companies: + type: array + description: An array containing Company Objects + items: + "$ref": "#/components/schemas/company" + total_count: + type: integer + description: The total number of companies associated to this contact + example: 100 + pages: + "$ref": "#/components/schemas/pages_link" + contact_companies: + title: Contact companies + type: object + nullable: false + description: An object containing companies meta data about the companies that + a contact has. Up to 10 will be displayed here. Use the url to get more. + properties: + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/companies" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_deleted: + title: Contact Deleted + type: object + description: deleted contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + deleted: + type: boolean + description: Whether the contact is deleted or not. + example: true + contact_list: + title: Contact List + type: object + description: Contacts are your users in Intercom. + properties: + type: + type: string + description: Always list + enum: + - list + example: list + data: + type: array + description: The list of contact objects + items: + "$ref": "#/components/schemas/contact" + total_count: + type: integer + description: A count of the total number of objects. + example: 100 + pages: + "$ref": "#/components/schemas/cursor_pages" + contact_location: + title: Contact Location + type: object + nullable: false + description: An object containing location meta data about a Intercom contact. + properties: + type: + type: string + nullable: true + description: Always location + example: location + country: + type: string + nullable: true + description: The country that the contact is located in + example: Ireland + region: + type: string + nullable: true + description: The overal region that the contact is located in + example: Dublin + city: + type: string + nullable: true + description: The city that the contact is located in + example: Dublin + contact_notes: + title: Contact notes + type: object + nullable: false + description: An object containing notes meta data about the notes that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the notes attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more company resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/notes" + total_count: + type: integer + description: Int representing the total number of companyies attached to + this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_reference: + title: Contact Reference + type: object + description: reference to contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + contact_reply_base_request: + title: Contact Reply Base Object + type: object + properties: + message_type: + type: string + enum: + - comment + type: + type: string + enum: + - user + body: + type: string + description: The text body of the comment. + created_at: + type: integer + description: The time the reply was created. If not provided, the current + time will be used. + example: 1590000000 + attachment_urls: + title: Attachment URLs + type: array + description: A list of image URLs that will be added as attachments. You + can include up to 10 URLs. + items: + type: string + format: uri + maxItems: 10 + required: + - message_type + - type + - body + contact_reply_conversation_request: + title: Contact Reply + oneOf: + - "$ref": "#/components/schemas/contact_reply_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_email_request" + - "$ref": "#/components/schemas/contact_reply_user_id_request" + contact_reply_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + attachment_files: + type: array + description: A list of files that will be added as attachments. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + required: + - intercom_user_id + contact_reply_ticket_email_request: + title: Email + type: object + description: Payload of the request to reply on behalf of a contact using their + `email` + properties: + email: + type: string + description: The email you have defined for the user. + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + required: + - email + contact_reply_ticket_intercom_user_id_request: + title: Intercom User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `intercom_user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - intercom_user_id + contact_reply_ticket_request: + title: Contact Reply on ticket + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_intercom_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_user_id_request" + - "$ref": "#/components/schemas/contact_reply_ticket_email_request" + contact_reply_ticket_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + required: + - user_id + contact_reply_user_id_request: + title: User ID + type: object + description: Payload of the request to reply on behalf of a contact using their + `user_id` + allOf: + - "$ref": "#/components/schemas/contact_reply_base_request" + properties: + user_id: + type: string + description: The external_id you have defined for the contact. + attachment_files: + type: array + description: A list of files that will be added as attachments. You can + include up to 10 files. + items: + "$ref": "#/components/schemas/conversation_attachment_files" + maxItems: 10 + required: + - user_id + contact_segments: + title: Segments + type: object + description: A list of segments objects attached to a specific contact. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: Segment objects associated with the contact. + items: + "$ref": "#/components/schemas/segment" + contact_social_profiles: + title: Social Profile + type: object + nullable: false + description: An object containing social profiles that a contact has. + properties: + data: + type: array + description: A list of social profiles objects associated with the contact. + items: + "$ref": "#/components/schemas/social_profile" + contact_subscription_types: + title: Contact Subscription Types + type: object + nullable: false + description: An object containing Subscription Types meta data about the SubscriptionTypes + that a contact has. + properties: + data: + type: array + description: This object represents the subscriptions attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: Url to get more subscription type resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/subscriptions" + total_count: + type: integer + description: Int representing the total number of subscription types attached + to this contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_tags: + title: Contact Tags + type: object + nullable: true + description: An object containing tags meta data about the tags that a contact + has. Up to 10 will be displayed here. Use the url to get more. + properties: + data: + type: array + description: This object represents the tags attached to a contact. + items: + "$ref": "#/components/schemas/addressable_list" + url: + type: string + format: uri + description: url to get more tag resources for this contact + example: "/contacts/5ba682d23d7cf92bef87bfd4/tags" + total_count: + type: integer + description: Int representing the total number of tags attached to this + contact + example: 100 + has_more: + type: boolean + description: Whether there's more Addressable Objects to be viewed. If true, + use the url to view all + example: true + contact_unarchived: + title: Contact Unarchived + type: object + description: unarchived contact object + properties: + type: + type: string + description: always contact + enum: + - contact + example: contact + id: + type: string + description: The unique identifier for the contact which is given by Intercom. + example: 5ba682d23d7cf92bef87bfd4 + external_id: + type: string + nullable: true + description: The unique identifier for the contact which is provided by + the Client. + example: f3b87a2e09d514c6c2e79b9a + archived: + type: boolean + description: Whether the contact is archived or not. + example: false + content_source: + title: Content Source + type: object + x-tags: + - AI Content Source + description: The content source used by AI Agent in the conversation. + properties: + content_type: + type: string + description: The type of the content source. + example: content_snippet + enum: + - file + - article + - external_content + - content_snippet + - workflow_connector_action + url: + type: string + description: The internal URL linking to the content source for teammates. + example: "/fin-ai-agent/content?content=content_snippet&id=3234924" + title: + type: string + description: The title of the content source. + example: My internal content snippet + locale: + type: string + description: The ISO 639 language code of the content source. + example: en + content_sources_list: + title: Content Source List + nullable: false + properties: + type: + type: string + enum: + - content_source.list + example: content_source.list + total_count: + type: integer + description: The total number of content sources used by AI Agent in the + conversation. + example: 1 + content_sources: + type: array + description: The content sources used by AI Agent in the conversation. + items: + "$ref": "#/components/schemas/content_source" + conversation: + title: Conversation + type: object + x-tags: + - Conversations + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation. + example: conversation + id: + type: string + description: The id representing the conversation. + example: '1295' + title: + type: string + nullable: true + description: The title given to the conversation. + example: Conversation Title + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation was updated. + example: 1663597260 + waiting_since: + type: integer + format: date-time + nullable: true + description: The last time a Contact responded to an Admin. In other words, + the time a customer started waiting for a response. Set to null if last + reply is from an Admin. + example: 1663597260 + snoozed_until: + type: integer + format: date-time + nullable: true + description: If set this is the time in the future when this conversation + will be marked as open. i.e. it will be in a snoozed state until this + time. i.e. it will be in a snoozed state until this time. + example: 1663597260 + open: + type: boolean + description: Indicates whether a conversation is open (true) or closed (false). + example: true + state: + type: string + enum: + - open + - closed + - snoozed + description: Can be set to "open", "closed" or "snoozed". + example: open + read: + type: boolean + description: Indicates whether a conversation has been read. + example: true + priority: + type: string + enum: + - priority + - not_priority + description: If marked as priority, it will return priority or else not_priority. + example: priority + admin_assignee_id: + type: integer + nullable: true + description: The id of the admin assigned to the conversation. If it's not + assigned to an admin it will return null. + example: 0 + team_assignee_id: + type: string + nullable: true + description: The id of the team assigned to the conversation. If it's not + assigned to a team it will return null. + example: '5017691' + tags: + "$ref": "#/components/schemas/tags" + conversation_rating: + "$ref": "#/components/schemas/conversation_rating" + source: + "$ref": "#/components/schemas/conversation_source" + contacts: + "$ref": "#/components/schemas/conversation_contacts" + teammates: + "$ref": "#/components/schemas/conversation_teammates" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + first_contact_reply: + "$ref": "#/components/schemas/conversation_first_contact_reply" + sla_applied: + "$ref": "#/components/schemas/sla_applied" + statistics: + "$ref": "#/components/schemas/conversation_statistics" + conversation_parts: + "$ref": "#/components/schemas/conversation_parts" + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ai_agent_participated: + type: boolean + description: Indicates whether the AI Agent participated in the conversation. + example: true + ai_agent: + "$ref": "#/components/schemas/ai_agent" + nullable: true + conversation_attachment_files: + title: Conversation attachment files + type: object + description: Properties of the attachment files in a conversation part + properties: + content_type: + type: string + description: The content type of the file + example: application/json + data: + type: string + description: The base64 encoded file data. + example: ewogICJ0ZXN0IjogMQp9 + name: + type: string + description: The name of the file. + example: test.json + conversation_contacts: + title: Contacts + type: object + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group conversation + feature. + properties: + type: + type: string + description: '' + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts (users or leads) involved in this conversation. + This will only contain one customer unless more were added via the group + conversation feature. + items: + "$ref": "#/components/schemas/contact_reference" + conversation_first_contact_reply: + title: First contact reply + type: object + nullable: true + description: An object containing information on the first users message. For + a contact initiated message this will represent the users original message. + properties: + created_at: + type: integer + format: date-time + description: '' + example: 1663597223 + type: + type: string + description: '' + example: conversation + url: + type: string + nullable: true + description: '' + example: https://developers.intercom.com/ + conversation_list: + title: Conversation List + type: object + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + properties: + type: + type: string + description: Always conversation.list + enum: + - conversation.list + example: conversation.list + conversations: + type: array + description: The list of conversation objects + items: + "$ref": "#/components/schemas/conversation" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + conversation_part: + title: Conversation Part + type: object + description: A Conversation Part represents a message in the conversation. + properties: + type: + type: string + description: Always conversation_part + example: conversation_part + id: + type: string + description: The id representing the conversation part. + example: '3' + part_type: + type: string + description: The type of conversation part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the conversation part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the conversation part was updated. + example: 1663597260 + notified_at: + type: integer + format: date-time + description: The time the user was notified with the conversation part. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the conversation by this + conversation_part (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + title: Conversation part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the conversation part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the conversation part has been redacted. + example: false + conversation_part_author: + title: Conversation part author + type: object + description: The object who initiated the conversation, which can be a Contact, + Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. + For Twitter, this will be blank. + properties: + type: + type: string + description: The type of the author + example: admin + id: + type: string + description: The id of the author + example: '274' + name: + type: string + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + conversation_parts: + title: Conversation Parts + type: object + description: A list of Conversation Part objects for each part message in the + conversation. This is only returned when Retrieving a Conversation, and ignored + when Listing all Conversations. There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - conversation_part.list + example: conversation_part.list + conversation_parts: + title: Conversation Parts + type: array + description: A list of Conversation Part objects for each part message in + the conversation. This is only returned when Retrieving a Conversation, + and ignored when Listing all Conversations. There is a limit of 500 parts. + items: + "$ref": "#/components/schemas/conversation_part" + total_count: + type: integer + description: '' + example: 2 + conversation_rating: + title: Conversation Rating + type: object + nullable: true + description: The Conversation Rating object which contains information on the + rating and/or remark added by a Contact and the Admin assigned to the conversation. + properties: + rating: + type: integer + description: The rating, between 1 and 5, for the conversation. + example: 5 + remark: + type: string + description: An optional field to add a remark to correspond to the number + rating + example: '' + created_at: + type: integer + format: date-time + description: The time the rating was requested in the conversation being + rated. + example: 1671028894 + contact: + "$ref": "#/components/schemas/contact_reference" + teammate: + "$ref": "#/components/schemas/reference" + conversation_source: + title: Conversation source + type: object + description: The Conversation Part that originated this conversation, which + can be Contact, Admin, Campaign, Automated or Operator initiated. + properties: + type: + type: string + description: This includes conversation, email, facebook, instagram, phone_call, + phone_switch, push, sms, twitter and whatsapp. + example: conversation + id: + type: string + description: The id representing the message. + example: '3' + delivered_as: + type: string + description: The conversation's initiation type. Possible values are customer_initiated, + campaigns_initiated (legacy campaigns), operator_initiated (Custom bot), + automated (Series and other outbounds with dynamic audience message) and + admin_initiated (fixed audience message, ticket initiated by an admin, + group email). + example: operator_initiated + subject: + type: string + description: Optional. The message subject. For Twitter, this will show + a generic message regarding why the subject is obscured. + example: '' + body: + type: string + description: The message body, which may contain HTML. For Twitter, this + will show a generic message regarding why the body is obscured. + example: "

Hey there!

" + author: + "$ref": "#/components/schemas/conversation_part_author" + attachments: + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + url: + type: string + nullable: true + description: The URL where the conversation was started. For Twitter, Email, + and Bots, this will be blank. + example: + redacted: + type: boolean + description: Whether or not the source message has been redacted. Only applicable + for contact initiated messages. + example: false + conversation_statistics: + title: Conversation statistics + type: object + nullable: true + description: A Statistics object containing all information required for reporting, + with timestamps and calculated metrics. + properties: + type: + type: string + description: '' + example: conversation_statistics + time_to_assignment: + type: integer + description: Duration until last assignment before first admin reply. In + seconds. + example: 2310 + time_to_admin_reply: + type: integer + description: Duration until first admin reply. Subtracts out of business + hours. In seconds. + example: 2310 + time_to_first_close: + type: integer + description: Duration until conversation was closed first time. Subtracts + out of business hours. In seconds. + example: 2310 + time_to_last_close: + type: integer + description: Duration until conversation was closed last time. Subtracts + out of business hours. In seconds. + example: 2310 + median_time_to_reply: + type: integer + description: Median based on all admin replies after a contact reply. Subtracts + out of business hours. In seconds. + example: 2310 + first_contact_reply_at: + type: integer + format: date-time + description: Time of first text conversation part from a contact. + example: 1663597233 + first_assignment_at: + type: integer + format: date-time + description: Time of first assignment after first_contact_reply_at. + example: 1663597233 + first_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply after first_contact_reply_at. + example: 1663597233 + first_close_at: + type: integer + format: date-time + description: Time of first close after first_contact_reply_at. + example: 1663597233 + last_assignment_at: + type: integer + format: date-time + description: Time of last assignment after first_contact_reply_at. + example: 1663597233 + last_assignment_admin_reply_at: + type: integer + format: date-time + description: Time of first admin reply since most recent assignment. + example: 1663597233 + last_contact_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from a contact. + example: 1663597233 + last_admin_reply_at: + type: integer + format: date-time + description: Time of the last conversation part from an admin. + example: 1663597233 + last_close_at: + type: integer + format: date-time + description: Time of the last conversation close. + example: 1663597233 + last_closed_by_id: + type: string + description: The last admin who closed the conversation. Returns a reference + to an Admin object. + example: c3po + count_reopens: + type: integer + description: Number of reopens after first_contact_reply_at. + example: 1 + count_assignments: + type: integer + description: Number of assignments after first_contact_reply_at. + example: 1 + count_conversation_parts: + type: integer + description: Total number of conversation parts. + example: 1 + conversation_teammates: + title: Conversation teammates + type: object + nullable: true + description: The list of teammates who participated in the conversation (wrote + at least one conversation part). + properties: + type: + type: string + description: The type of the object - `admin.list`. + example: admin.list + teammates: + type: array + description: The list of teammates who participated in the conversation + (wrote at least one conversation part). + items: + "$ref": "#/components/schemas/reference" + convert_conversation_to_ticket_request: + description: You can convert a Conversation to a Ticket + type: object + title: Convert Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to convert the conversation + to + example: '1234' + attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + convert_visitor_request: + description: You can merge a Visitor to a Contact of role type lead or user. + type: object + title: Convert Visitor Request Payload + properties: + type: + type: string + description: Represents the role of the Contact model. Accepts `lead` or + `user`. + example: user + user: + type: object + description: The unique identifiers retained after converting or merging. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom, + which will be represented as external_id. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The contact's email, retained by default if one is present. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + visitor: + type: object + description: The unique identifiers to convert a single Visitor. + properties: + id: + type: string + description: The unique identifier for the contact which is given by + Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + user_id: + type: string + description: A unique identifier for the contact which is given to Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: The visitor's email. + example: winstonsmith@truth.org + anyOf: + - required: + - id + - required: + - user_id + - required: + - email + required: + - type + - user + - visitor + create_article_request: + description: You can create an Article + type: object + title: Create Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: integer + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: 18 + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + required: + - title + - author_id + create_collection_request: + description: You can create a collection + type: object + title: Create Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + created as the first level collection. + example: '6871118' + help_center_id: + type: integer + nullable: true + description: The id of the help center where the collection will be created. + If `null` then it will be created in the default help center. + example: '123' + required: + - name + create_contact_request: + description: Payload to create a contact + type: object + title: Create Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + anyOf: + - required: + - email + title: Create contact with email + - required: + - external_id + title: Create contact with external_id + - required: + - role + title: Create contact with role + create_conversation_request: + description: Conversations are how you can communicate with users in Intercom. + They are created when a contact replies to an outbound message, or when one + admin directly sends a message to a single contact. + type: object + title: Create Conversation Request Payload + properties: + from: + type: object + properties: + type: + type: string + enum: + - lead + - user + - contact + description: The role associated to the contact - user or lead. + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + format: uuid + minLength: 24 + maxLength: 24 + example: 536e564f316c83104c000020 + required: + - type + - id + body: + type: string + description: The content of the message. HTML is not supported. + example: Hello + required: + - from + - body + create_data_attribute_request: + description: '' + type: object + title: Create Data Attribute Request + properties: + name: + type: string + description: The name of the data attribute. + example: My Data Attribute + model: + type: string + description: The model that the data attribute belongs to. + enum: + - contact + - company + example: contact + data_type: + type: string + description: The type of data stored for this attribute. + enum: + - string + - integer + - float + - boolean + - datetime + - date + example: string + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + required: + - name + - model + - data_type + create_data_event_request: + description: '' + type: object + title: Create Data Event Request + properties: + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: The unique identifier for the contact (lead or user) which + is given by Intercom. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + anyOf: + - title: id required + required: + - event_name + - created_at + - id + - title: user_id required + required: + - event_name + - created_at + - user_id + - title: email required + required: + - event_name + - created_at + - email + create_data_event_summaries_request: + description: You can send a list of event summaries for a user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense "verb-noun" + combination, to improve readability, for example `updated-plan`. + type: object + title: Create Data Event Summaries Request + properties: + user_id: + type: string + description: Your identifier for the user. + example: '314159' + event_summaries: + type: object + description: A list of event summaries for the user. Each event summary + should contain the event name, the time the event occurred, and the number + of times the event occurred. The event name should be a past tense 'verb-noun' + combination, to improve readability, for example `updated-plan`. + properties: + event_name: + type: string + description: The name of the event that occurred. A good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + count: + type: integer + description: The number of times the event occurred. + example: 1 + first: + type: integer + format: date-time + description: The first time the event was sent + example: 1671028894 + last: + type: integer + format: date-time + description: The last time the event was sent + example: 1671028894 + create_data_exports_request: + description: Request for creating a data export + type: object + title: Create Data Export Request + properties: + created_at_after: + type: integer + description: The start date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + created_at_before: + type: integer + description: The end date that you request data for. It must be formatted + as a unix timestamp. + example: 1527811200 + required: + - created_at_after + - created_at_before + create_message_request: + description: You can create a message + type: object + title: Create Message Request Payload + nullable: true + properties: + message_type: + type: string + description: 'The kind of message being created. Values: `in_app` or `email`.' + enum: + - in_app + - email + example: in_app + subject: + type: string + description: The title of the email. + example: Thanks for everything + body: + type: string + description: The content of the message. HTML and plaintext are supported. + example: Hello there + template: + type: string + description: The style of the outgoing message. Possible values `plain` + or `personal`. + example: plain + from: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: Always `admin`. + enum: + - admin + example: admin + id: + type: integer + description: The identifier for the admin which is given by Intercom. + example: 394051 + required: + - type + - id + to: + type: object + description: The sender of the message. If not provided, the default sender + will be used. + properties: + type: + type: string + description: The role associated to the contact - `user` or `lead`. + enum: + - user + - lead + example: user + id: + type: string + description: The identifier for the contact which is given by Intercom. + example: 536e564f316c83104c000020 + required: + - type + - id + created_at: + type: integer + description: The time the message was created. If not provided, the current + time will be used. + example: 1590000000 + create_conversation_without_contact_reply: + type: boolean + description: Whether a conversation should be opened in the inbox for the + message without the contact replying. Defaults to false if not provided. + default: false + example: true + anyOf: + - title: 'message_type: `email`.' + required: + - message_type + - subject + - body + - template + - from + - to + - title: 'message_type: `inapp`.' + required: + - message_type + - body + - from + - to + create_or_update_company_request: + type: object + title: Create Or Update Company Request Payload + description: You can create or update a Company + nullable: true + properties: + name: + type: string + description: The name of the Company + example: Intercom + company_id: + type: string + description: The company id you have defined for the company. Can't be updated + example: 625e90fc55ab113b6d92175f + plan: + type: string + description: The name of the plan you have associated with the company. + example: Enterprise + size: + type: integer + description: The number of employees in this company. + example: '100' + website: + type: string + description: The URL for this company's website. Please note that the value + specified here is not validated. Accepts any string. + example: https://www.example.com + industry: + type: string + description: The industry that this company operates in. + example: Manufacturing + custom_attributes: + type: object + description: A hash of key/value pairs containing any other data about the + company you want Intercom to store. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + remote_created_at: + type: integer + description: The time the company was created by you. + example: 1394531169 + monthly_spend: + type: integer + description: How much revenue the company generates for your business. Note + that this will truncate floats. i.e. it only allow for whole integers, + 155.98 will be truncated to 155. Note that this has an upper limit of + 2**31-1 or 2147483647.. + example: 1000 + create_or_update_tag_request: + description: You can create or update an existing tag. + type: object + title: Create or Update Tag Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found, or + the new name for the tag if this is an update request. Names are case + insensitive. + example: Independent + id: + type: string + description: The id of tag to updates. + example: '656452352' + required: + - name + create_phone_switch_request: + description: You can create an phone switch + type: object + title: Create Phone Switch Request Payload + nullable: true + properties: + phone: + type: string + description: Phone number in E.164 format, that will receive the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + required: + - phone + create_ticket_reply_with_comment_request: + title: Create Ticket Reply Request Payload + oneOf: + - "$ref": "#/components/schemas/contact_reply_ticket_request" + - "$ref": "#/components/schemas/admin_reply_ticket_request" + create_ticket_request: + description: You can create a Ticket + type: object + title: Create Ticket Request Payload + properties: + ticket_type_id: + type: string + description: The ID of the type of ticket you want to create + example: '1234' + contacts: + type: array + description: The list of contacts (users or leads) affected by this ticket. + Currently only one is allowed + items: + type: object + oneOf: + - title: ID + properties: + id: + type: string + description: The identifier for the contact as given by Intercom. + required: + - id + - title: External ID + properties: + external_id: + type: string + description: The external_id you have defined for the contact who + is being added as a participant. + required: + - external_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being + added as a participant. If a contact with this email does not + exist, one will be created. + required: + - email + example: + - id: '1234' + company_id: + type: string + description: The ID of the company that the ticket is associated with. The + ID that you set upon company creation. + example: '1234' + created_at: + type: integer + description: The time the ticket was created. If not provided, the current + time will be used. + example: 1590000000 + ticket_attributes: + "$ref": "#/components/schemas/ticket_request_custom_attributes" + required: + - ticket_type_id + - contacts + create_ticket_type_attribute_request: + description: You can create a Ticket Type Attribute + type: object + title: Create Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + data_type: + type: string + description: The data type of the attribute + enum: + - string + - list + - integer + - decimal + - boolean + - datetime + - files + example: string + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + required: + - name + - description + - data_type + create_ticket_type_request: + description: | + The request payload for creating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Create Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: Used for tracking bugs + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + required: + - name + cursor_pages: + title: Cursor based pages + type: object + description: | + Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. + A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. + nullable: true + properties: + type: + type: string + description: the type of object `pages`. + example: pages + enum: + - pages + page: + type: integer + description: The current page + example: 1 + next: + "$ref": "#/components/schemas/starting_after_paging" + per_page: + type: integer + description: Number of results per page + example: 2 + total_pages: + type: integer + description: Total number of pages + example: 13 + custom_attributes: + title: Custom Attributes + type: object + description: An object containing the different custom attributes associated + to the conversation as key-value pairs. For relationship attributes the value + will be a list of custom object instance models. + additionalProperties: + anyOf: + - type: string + - "$ref": "#/components/schemas/custom_object_instance" + custom_object_instance: + title: Custom Object Instance + type: object + x-tags: + - Custom Object Instances + nullable: true + description: A Custom Object Instance represents an instance of a custom object + type. This allows you to create and set custom attributes to store data about + your customers that is not already captured by Intercom. The parent object + includes recommended default attributes and you can add your own custom attributes. + properties: + id: + type: string + description: The Intercom defined id representing the custom object instance. + example: 5a7a19e9f59ae20001d1c1e6 + external_id: + type: string + description: The id you have defined for the custom object instance. + example: 0001d1c1e65a7a19e9f59ae2 + type: + type: string + description: The identifier of the custom object type that defines the structure + of the custom object instance. + example: Order + custom_attributes: + type: object + description: The custom attributes you have set on the custom object instance. + additionalProperties: + type: string + customer_request: + type: object + nullable: true + oneOf: + - title: Intercom User ID + properties: + intercom_user_id: + type: string + description: The identifier for the contact as given by Intercom. + example: 6329bd9ffe4e2e91dac76188 + required: + - intercom_user_id + - title: User ID + properties: + user_id: + type: string + description: The external_id you have defined for the contact who is being + added as a participant. + example: 2e91dac761886329bd9ffe4e + required: + - user_id + - title: Email + properties: + email: + type: string + description: The email you have defined for the contact who is being added + as a participant. + example: sam.sung@example.com + required: + - email + data_attribute: + title: Data Attribute + type: object + x-tags: + - Data Attributes + description: Data Attributes are metadata used to describe your contact, company + and conversation models. These include standard and custom attributes. By + using the data attributes endpoint, you can get the global list of attributes + for your workspace, as well as create and archive custom attributes. + properties: + type: + type: string + description: Value is `data_attribute`. + enum: + - data_attribute + example: data_attribute + id: + type: integer + description: The unique identifier for the data attribute which is given + by Intercom. Only available for custom attributes. + example: 12878 + model: + type: string + description: Value is `contact` for user/lead attributes and `company` for + company attributes. + enum: + - contact + - company + example: contact + name: + type: string + description: Name of the attribute. + example: paid_subscriber + full_name: + type: string + description: Full name of the attribute. Should match the name unless it's + a nested attribute. We can split full_name on `.` to access nested user + object values. + example: custom_attributes.paid_subscriber + label: + type: string + description: Readable name of the attribute (i.e. name you see in the UI) + example: Paid Subscriber + description: + type: string + description: Readable description of the attribute. + example: Whether the user is a paid subscriber. + data_type: + type: string + description: The data type of the attribute. + enum: + - string + - integer + - float + - boolean + - date + example: boolean + options: + type: array + description: List of predefined options for attribute value. + items: + type: string + example: + - 'true' + - 'false' + api_writable: + type: boolean + description: Can this attribute be updated through API + example: true + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + ui_writable: + type: boolean + description: Can this attribute be updated in the UI + example: true + custom: + type: boolean + description: Set to true if this is a CDA + example: true + archived: + type: boolean + description: Is this attribute archived. (Only applicable to CDAs) + example: false + created_at: + type: integer + format: date-time + description: The time the attribute was created as a UTC Unix timestamp + example: 1671028894 + updated_at: + type: integer + format: date-time + description: The time the attribute was last updated as a UTC Unix timestamp + example: 1671028894 + admin_id: + type: string + description: Teammate who created the attribute. Only applicable to CDAs + example: '5712945' + data_attribute_list: + title: Data Attribute List + type: object + description: A list of all data attributes belonging to a workspace for contacts, + companies or conversations. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of data attributes + items: + "$ref": "#/components/schemas/data_attribute" + data_event: + title: Data Event + type: object + x-tags: + - Data Events + description: Data events are used to notify Intercom of changes to your data. + properties: + type: + type: string + description: The type of the object + enum: + - event + example: event + event_name: + type: string + description: The name of the event that occurred. This is presented to your + App's admins when filtering and creating segments - a good event name + is typically a past tense 'verb-noun' combination, to improve readability, + for example `updated-plan`. + example: invited-friend + created_at: + type: integer + format: date-time + description: The time the event occurred as a UTC Unix timestamp + example: 1671028894 + user_id: + type: string + description: Your identifier for the user. + example: '314159' + id: + type: string + description: Your identifier for a lead or a user. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + intercom_user_id: + type: string + description: The Intercom identifier for the user. + example: 63a0979a5eeebeaf28dd56ba + email: + type: string + description: An email address for your user. An email should only be used + where your application uses email to uniquely identify users. + example: frodo.baggins@example.com + metadata: + type: object + description: Optional metadata about the event. + additionalProperties: + type: string + example: + invite_code: ADDAFRIEND + required: + - event_name + - created_at + data_event_list: + title: Data Event List + type: object + description: This will return a list of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.list + example: event.list + events: + type: array + description: A list of data events + items: + "$ref": "#/components/schemas/data_event" + pages: + type: object + description: Pagination + properties: + next: + type: string + example: https://api.intercom.io/events?per_page=2&before=1389913941064&intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user" + since: + type: string + example: https://api.intercom.io/events?intercom_user_id=63a0979a5eeebeaf28dd56ba&type=user&since=1389913941065 + data_event_summary: + title: Data Event Summary + type: object + description: This will return a summary of data events for the App. + properties: + type: + type: string + description: The type of the object + enum: + - event.summary + example: event.summary + email: + type: string + description: The email address of the user + example: Sam.Sung@example.com + intercom_user_id: + type: string + description: The Intercom user ID of the user + example: 63a0979a5eeebeaf28dd56ba + user_id: + type: string + description: The user ID of the user + example: 62b997f288e14803c5006932 + events: + type: array + description: A summary of data events + items: + "$ref": "#/components/schemas/data_event_summary_item" + data_event_summary_item: + title: Data Event Summary Item + type: object + description: This will return a summary of a data event for the App. + nullable: true + properties: + name: + type: string + description: The name of the event + example: placed-order + first: + type: string + description: The first time the event was sent + example: '2014-01-16T23:12:21.000+00:00' + last: + type: string + description: The last time the event was sent + example: '2014-01-16T23:12:21.000+00:00 ' + count: + type: integer + description: The number of times the event was sent + example: 1 + description: + type: string + description: The description of the event + example: A user placed an order + data_export: + title: Data Export + type: object + x-tags: + - Data Export + description: The data export api is used to view all message sent & viewed in + a given timeframe. + properties: + job_identfier: + type: string + description: The identifier for your job. + example: orzzsbd7hk67xyu + status: + type: string + enum: + - pending + - in_progress + - failed + - completed + - no_data + - canceled + description: The current state of your job. + example: pending + download_expires_at: + type: string + description: The time after which you will not be able to access the data. + example: '1674917488' + download_url: + type: string + description: The location where you can download your data. + example: https://api.intercom.test/download/messages/data/example + data_export_csv: + title: Data Export CSV + type: object + description: A CSV output file + properties: + user_id: + type: string + description: The user_id of the user who was sent the message. + user_external_id: + type: string + description: The external_user_id of the user who was sent the message + company_id: + type: string + description: The company ID of the user in relation to the message that + was sent. Will return -1 if no company is present. + email: + type: string + description: The users email who was sent the message. + name: + type: string + description: The full name of the user receiving the message + ruleset_id: + type: string + description: The id of the message. + content_id: + type: string + description: The specific content that was received. In an A/B test each + version has its own Content ID. + content_type: + type: string + description: Email, Chat, Post etc. + content_title: + type: string + description: The title of the content you see in your Intercom workspace. + ruleset_version_id: + type: string + description: As you edit content we record new versions. This ID can help + you determine which version of a piece of content that was received. + receipt_id: + type: string + description: ID for this receipt. Will be included with any related stats + in other files to identify this specific delivery of a message. + received_at: + type: integer + description: Timestamp for when the receipt was recorded. + series_id: + type: string + description: The id of the series that this content is part of. Will return + -1 if not part of a series. + series_title: + type: string + description: The title of the series that this content is part of. + node_id: + type: string + description: The id of the series node that this ruleset is associated with. + Each block in a series has a corresponding node_id. + first_reply: + type: integer + description: The first time a user replied to this message if the content + was able to receive replies. + first_completion: + type: integer + description: The first time a user completed this message if the content + was able to be completed e.g. Tours, Surveys. + first_series_completion: + type: integer + description: The first time the series this message was a part of was completed + by the user. + first_series_disengagement: + type: integer + description: The first time the series this message was a part of was disengaged + by the user. + first_series_exit: + type: integer + description: The first time the series this message was a part of was exited + by the user. + first_goal_success: + type: integer + description: The first time the user met this messages associated goal if + one exists. + first_open: + type: integer + description: The first time the user opened this message. + first_click: + type: integer + description: The first time the series the user clicked on a link within + this message. + first_dismisall: + type: integer + description: The first time the series the user dismissed this message. + first_unsubscribe: + type: integer + description: The first time the user unsubscribed from this message. + first_hard_bounce: + type: integer + description: The first time this message hard bounced for this user + deleted_article_object: + title: Deleted Article Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the article which you provided in + the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - article + enum: + - article + example: article + deleted: + type: boolean + description: Whether the article was deleted successfully or not. + example: true + deleted_collection_object: + title: Deleted Collection Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the collection which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted. - `collection` + enum: + - collection + example: collection + deleted: + type: boolean + description: Whether the collection was deleted successfully or not. + example: true + deleted_company_object: + title: Deleted Company Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the company which is given by Intercom. + example: 5b7e8b2f-7a1a-4e6c-8e1b-4f9d4f4c4d4f + object: + type: string + description: The type of object which was deleted. - `company` + enum: + - company + example: company + deleted: + type: boolean + description: Whether the company was deleted successfully or not. + example: true + deleted_object: + title: Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the news item which you provided + in the URL. + example: '6890762' + object: + type: string + description: The type of object which was deleted - news-item. + enum: + - news-item + example: news-item + deleted: + type: boolean + description: Whether the news item was deleted successfully or not. + example: true + detach_contact_from_conversation_request: + properties: + admin_id: + type: string + description: The `id` of the admin who is performing the action. + example: '5017690' + required: + - admin_id + error: + type: object + title: Error + description: The API will return an Error List for a failed request, which will + contain one or more Error objects. + properties: + type: + type: string + description: The type is error.list + example: error.list + request_id: + type: string + nullable: true + format: uuid + description: '' + example: f93ecfa8-d08a-4325-8694-89aeb89c8f85 + errors: + type: array + description: An array of one or more error objects + items: + properties: + code: + type: string + description: A string indicating the kind of error, used to further + qualify the HTTP response code + example: unauthorized + message: + type: string + nullable: true + description: Optional. Human readable description of the error. + example: Access Token Invalid + field: + type: string + nullable: true + description: Optional. Used to identify a particular field or query + parameter that was in error. + example: email + required: + - code + required: + - type + - errors + file_attribute: + title: File + type: object + description: The value describing a file upload set for a custom attribute + properties: + type: + type: string + example: upload + name: + type: string + description: The name of the file + example: Screenshot.png + url: + type: string + description: The url of the file. This is a temporary URL and will expire + after 30 minutes. + example: https://intercom-attachments-1.com/.../Screenshot.png + content_type: + type: string + description: The type of file + example: image/png + filesize: + type: integer + description: The size of the file in bytes + example: 11308309 + width: + type: integer + description: The width of the file in pixels, if applicable + example: 3024 + height: + type: integer + description: The height of the file in pixels, if applicable + example: 1964 + group_content: + title: Group Content + type: object + description: The Content of a Group. + nullable: true + properties: + type: + type: string + description: The type of object - `group_content` . + enum: + - + - group_content + example: group_content + nullable: true + name: + type: string + description: The name of the collection or section. + example: Collection name + description: + type: string + description: The description of the collection. Only available for collections. + example: " Collection description" + group_translated_content: + title: Group Translated Content + type: object + description: The Translated Content of an Group. The keys are the locale codes + and the values are the translated content of the Group. + nullable: true + properties: + type: + type: string + description: The type of object - group_translated_content. + nullable: true + enum: + - + - group_translated_content + example: group_translated_content + ar: + description: The content of the group in Arabic + "$ref": "#/components/schemas/group_content" + bg: + description: The content of the group in Bulgarian + "$ref": "#/components/schemas/group_content" + bs: + description: The content of the group in Bosnian + "$ref": "#/components/schemas/group_content" + ca: + description: The content of the group in Catalan + "$ref": "#/components/schemas/group_content" + cs: + description: The content of the group in Czech + "$ref": "#/components/schemas/group_content" + da: + description: The content of the group in Danish + "$ref": "#/components/schemas/group_content" + de: + description: The content of the group in German + "$ref": "#/components/schemas/group_content" + el: + description: The content of the group in Greek + "$ref": "#/components/schemas/group_content" + en: + description: The content of the group in English + "$ref": "#/components/schemas/group_content" + es: + description: The content of the group in Spanish + "$ref": "#/components/schemas/group_content" + et: + description: The content of the group in Estonian + "$ref": "#/components/schemas/group_content" + fi: + description: The content of the group in Finnish + "$ref": "#/components/schemas/group_content" + fr: + description: The content of the group in French + "$ref": "#/components/schemas/group_content" + he: + description: The content of the group in Hebrew + "$ref": "#/components/schemas/group_content" + hr: + description: The content of the group in Croatian + "$ref": "#/components/schemas/group_content" + hu: + description: The content of the group in Hungarian + "$ref": "#/components/schemas/group_content" + id: + description: The content of the group in Indonesian + "$ref": "#/components/schemas/group_content" + it: + description: The content of the group in Italian + "$ref": "#/components/schemas/group_content" + ja: + description: The content of the group in Japanese + "$ref": "#/components/schemas/group_content" + ko: + description: The content of the group in Korean + "$ref": "#/components/schemas/group_content" + lt: + description: The content of the group in Lithuanian + "$ref": "#/components/schemas/group_content" + lv: + description: The content of the group in Latvian + "$ref": "#/components/schemas/group_content" + mn: + description: The content of the group in Mongolian + "$ref": "#/components/schemas/group_content" + nb: + description: The content of the group in Norwegian + "$ref": "#/components/schemas/group_content" + nl: + description: The content of the group in Dutch + "$ref": "#/components/schemas/group_content" + pl: + description: The content of the group in Polish + "$ref": "#/components/schemas/group_content" + pt: + description: The content of the group in Portuguese (Portugal) + "$ref": "#/components/schemas/group_content" + ro: + description: The content of the group in Romanian + "$ref": "#/components/schemas/group_content" + ru: + description: The content of the group in Russian + "$ref": "#/components/schemas/group_content" + sl: + description: The content of the group in Slovenian + "$ref": "#/components/schemas/group_content" + sr: + description: The content of the group in Serbian + "$ref": "#/components/schemas/group_content" + sv: + description: The content of the group in Swedish + "$ref": "#/components/schemas/group_content" + tr: + description: The content of the group in Turkish + "$ref": "#/components/schemas/group_content" + vi: + description: The content of the group in Vietnamese + "$ref": "#/components/schemas/group_content" + pt-BR: + description: The content of the group in Portuguese (Brazil) + "$ref": "#/components/schemas/group_content" + zh-CN: + description: The content of the group in Chinese (China) + "$ref": "#/components/schemas/group_content" + zh-TW: + description: The content of the group in Chinese (Taiwan) + "$ref": "#/components/schemas/group_content" + help_center: + title: Help Center + type: object + x-tags: + - Help Center + description: Help Centers contain collections + properties: + id: + type: string + description: The unique identifier for the Help Center which is given by + Intercom. + example: '123' + workspace_id: + type: string + description: The id of the workspace which the Help Center belongs to. + example: hfi1bx4l + created_at: + type: integer + format: date-time + description: The time when the Help Center was created. + example: 1672928359 + updated_at: + type: integer + format: date-time + description: The time when the Help Center was last updated. + example: 1672928610 + identifier: + type: string + description: The identifier of the Help Center. This is used in the URL + of the Help Center. + example: intercom + website_turned_on: + type: boolean + description: Whether the Help Center is turned on or not. This is controlled + in your Help Center settings. + example: true + display_name: + type: string + description: The display name of the Help Center only seen by teammates. + example: Intercom Help Center + help_center_list: + title: Help Centers + type: object + x-tags: + - Help Center + description: A list of Help Centers belonging to the App + properties: + type: + type: string + description: The type of the object - `list`. + enum: + - list + example: list + data: + type: array + description: An array of Help Center objects + items: + "$ref": "#/components/schemas/help_center" + intercom_version: + description: Intercom API version.
By default, it's equal to the version + set in the app package. + type: string + example: '2.11' + default: '2.11' + enum: + - '1.0' + - '1.1' + - '1.2' + - '1.3' + - '1.4' + - '2.0' + - '2.1' + - '2.2' + - '2.3' + - '2.4' + - '2.5' + - '2.6' + - '2.7' + - '2.8' + - '2.9' + - '2.10' + - '2.11' + - Unstable + linked_object: + title: Linked Object + type: object + description: A linked conversation or ticket. + properties: + type: + type: string + description: ticket or conversation + enum: + - ticket + - conversation + example: ticket + id: + type: string + description: The ID of the linked object + example: '7583' + category: + type: string + description: Category of the Linked Ticket Object. + enum: + - Customer + - Back-office + - Tracker + - + example: Customer + nullable: true + linked_object_list: + title: Linked Objects + type: object + description: An object containing metadata about linked conversations and linked + tickets. Up to 1000 can be returned. + properties: + type: + type: string + description: Always list. + enum: + - list + example: list + total_count: + type: integer + description: The total number of linked objects. + example: 100 + has_more: + type: boolean + description: Whether or not there are more linked objects than returned. + example: false + data: + type: array + description: An array containing the linked conversations and linked tickets. + items: + "$ref": "#/components/schemas/linked_object" + merge_contacts_request: + description: Merge contact data. + type: object + title: Merge contact data + properties: + from: + type: string + description: The unique identifier for the contact to merge away from. Must + be a lead. + example: 5d70dd30de4efd54f42fd526 + into: + type: string + description: The unique identifier for the contact to merge into. Must be + a user. + example: 5ba682d23d7cf92bef87bfd4 + message: + type: object + title: Message + x-tags: + - Messages + description: Message are how you reach out to contacts in Intercom. They are + created when an admin sends an outbound message to a contact. + properties: + type: + type: string + description: The type of the message + example: user_message + id: + type: string + description: The id representing the message. + example: '1488971108' + created_at: + type: integer + format: date-time + description: The time the conversation was created. + example: 1667560812 + subject: + type: string + description: 'The subject of the message. Only present if message_type: + email.' + example: Greetings + body: + type: string + description: The message body, which may contain HTML. + example: Hello + message_type: + type: string + enum: + - email + - inapp + - facebook + - twitter + description: The type of message that was sent. Can be email, inapp, facebook + or twitter. + example: inapp + conversation_id: + type: string + description: The associated conversation_id + example: '64619700005570' + required: + - type + - id + - created_at + - body + - message_type + multiple_filter_search_request: + title: Multiple Filter Search Request + description: Search using Intercoms Search APIs with more than one filter. + type: object + properties: + operator: + type: string + enum: + - AND + - OR + description: An operator to allow boolean inspection between multiple fields. + example: AND + value: + oneOf: + - type: array + description: Add mutiple filters. + title: multiple filter search request + items: + "$ref": "#/components/schemas/multiple_filter_search_request" + - type: array + description: Add a single filter field. + title: single filter search request + items: + "$ref": "#/components/schemas/single_filter_search_request" + news_item: + title: News Item + type: object + x-tags: + - News + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + properties: + type: + type: string + description: The type of object. + enum: + - news-item + example: news-item + id: + type: string + description: The unique identifier for the news item which is given by Intercom. + example: '141' + workspace_id: + type: string + description: The id of the workspace which the news item belongs to. + example: t74hdn32 + title: + type: string + description: The title of the news item. + example: 'New feature: News Items' + body: + type: string + description: The news item body, which may contain HTML. + example: We are excited to announce the launch of News Items, a new content + type in Intercom enabling you to announce product updates, company news, + promotions, events and more with your customers. + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + nullable: true + description: The label name. + example: Product Update + cover_image_url: + type: string + format: uri + nullable: true + description: URL of the image used as cover. Must have .jpg or .png extension. + example: https://example.com/cover.jpg + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + description: The emoji reaction to the news item. + example: "\U0001F44D" + deliver_silently: + type: boolean + description: When set to true, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + created_at: + type: integer + format: timestamp + description: Timestamp for when the news item was created. + example: 1610589632 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the news item was last updated. + example: 1610589632 + news_item_request: + description: A News Item is a content type in Intercom enabling you to announce + product updates, company news, promotions, events and more with your customers. + type: object + title: Create News Item Request + properties: + title: + type: string + description: The title of the news item. + example: Halloween is here! + body: + type: string + description: The news item body, which may contain HTML. + example: "

New costumes in store for this spooky season

" + sender_id: + type: integer + description: The id of the sender of the news item. Must be a teammate on + the workspace. + example: 123 + state: + type: string + description: News items will not be visible to your users in the assigned + newsfeeds until they are set live. + enum: + - draft + - live + example: live + deliver_silently: + type: boolean + description: When set to `true`, the news item will appear in the messenger + newsfeed without showing a notification badge. + example: true + labels: + type: array + description: Label names displayed to users to categorize the news item. + items: + type: string + example: + - Product + - Update + - New + reactions: + type: array + description: Ordered list of emoji reactions to the news item. When empty, + reactions are disabled. + items: + type: string + nullable: true + example: + - "\U0001F606" + - "\U0001F605" + newsfeed_assignments: + type: array + description: A list of newsfeed_assignments to assign to the specified newsfeed. + items: + "$ref": "#/components/schemas/newsfeed_assignment" + required: + - title + - sender_id + newsfeed: + title: Newsfeed + type: object + x-tags: + - News + description: | + A newsfeed is a collection of news items, targeted to a specific audience. + + Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. + properties: + id: + type: string + description: The unique identifier for the newsfeed which is given by Intercom. + example: '12312' + type: + type: string + description: The type of object. + enum: + - newsfeed + example: newsfeed + name: + type: string + description: The name of the newsfeed. This name will never be visible to + your users. + example: My Newsfeed + created_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was created. + example: 1674917488 + updated_at: + type: integer + format: timestamp + description: Timestamp for when the newsfeed was last updated. + example: 1674917488 + newsfeed_assignment: + title: Newsfeed Assignment + type: object + x-tags: + - News + description: Assigns a news item to a newsfeed. + properties: + newsfeed_id: + type: integer + description: The unique identifier for the newsfeed which is given by Intercom. + Publish dates cannot be in the future, to schedule news items use the + dedicated feature in app (see this article). + example: 198313 + published_at: + type: integer + format: timestamp + description: Publish date of the news item on the newsfeed, use this field + if you want to set a publish date in the past (e.g. when importing existing + news items). On write, this field will be ignored if the news item state + is "draft". + example: 1674917488 + note: + title: Note + type: object + x-tags: + - Notes + description: Notes allow you to annotate and comment on your contacts. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `note`. + example: note + id: + type: string + description: The id of the note. + example: '17495962' + created_at: + type: integer + format: timestamp + description: The time the note was created. + example: 1674589321 + contact: + type: object + description: Represents the contact that the note was created about. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `contact`. + id: + type: string + description: The id of the contact. + example: 214656d0c743eafcfde7f248 + author: + "$ref": "#/components/schemas/admin" + description: Optional. Represents the Admin that created the note. + body: + type: string + description: The body text of the note. + example: "

Text for the note.

" + note_list: + title: Paginated Response + type: object + description: A paginated list of notes associated with a contact. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `list`. + example: list + data: + type: array + description: An array of notes. + items: + "$ref": "#/components/schemas/note" + total_count: + type: integer + description: A count of the total number of notes. + example: 1 + pages: + "$ref": "#/components/schemas/cursor_pages" + open_conversation_request: + title: Open Conversation Request + type: object + description: Payload of the request to open a conversation + properties: + message_type: + type: string + enum: + - open + example: open + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017690' + required: + - message_type + - admin_id + pages_link: + title: Pagination Object + type: object + description: | + The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests. + + Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. + properties: + type: + type: string + example: pages + enum: + - pages + page: + type: integer + example: 1 + next: + type: string + format: uri + description: A link to the next page of results. A response that does not + contain a next link does not have further data to fetch. + nullable: true + per_page: + type: integer + example: 50 + total_pages: + type: integer + example: 1 + paginated_response: + title: Paginated Response + type: object + description: Paginated Response + properties: + type: + type: string + description: The type of object + enum: + - list + - conversation.list + example: list + pages: + "$ref": "#/components/schemas/cursor_pages" + total_count: + type: integer + description: A count of the total number of objects. + example: 1 + data: + type: array + description: An array of Objects + items: + anyOf: + - "$ref": "#/components/schemas/news_item" + - "$ref": "#/components/schemas/newsfeed" + part_attachment: + title: Part attachment + type: object + description: The file attached to a part + properties: + type: + type: string + description: The type of attachment + example: upload + name: + type: string + description: The name of the attachment + example: example.png + url: + type: string + description: The URL of the attachment + example: https://picsum.photos/200/300 + content_type: + type: string + description: The content type of the attachment + example: image/png + filesize: + type: integer + description: The size of the attachment + example: 100 + width: + type: integer + description: The width of the attachment + example: 100 + height: + type: integer + description: The height of the attachment + example: 100 + phone_switch: + title: Phone Switch + type: object + description: Phone Switch Response + nullable: true + properties: + type: + type: string + description: '' + enum: + - phone_call_redirect + default: phone_call_redirect + example: phone_call_redirect + phone: + type: string + description: Phone number in E.164 format, that has received the SMS to + continue the conversation in the Messenger. + example: "+1 1234567890" + redact_conversation_request: + oneOf: + - title: Redact Conversation Part Request + type: object + description: Payload of the request to redact a conversation part + properties: + type: + type: string + enum: + - conversation_part + description: The type of resource being redacted. + example: conversation_part + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + conversation_part_id: + type: string + description: The id of the conversation_part. + example: '19381789428' + required: + - type + - conversation_id + - conversation_part_id + - title: Redact Conversation Source Request + type: object + description: Payload of the request to redact a conversation source + properties: + type: + type: string + enum: + - source + description: The type of resource being redacted. + example: source + conversation_id: + type: string + description: The id of the conversation. + example: '19894788788' + source_id: + type: string + description: The id of the source. + example: '19894781231' + required: + - type + - conversation_id + - source_id + reference: + title: Reference + type: object + description: reference to another object + properties: + type: + type: string + description: '' + example: contact + id: + type: string + nullable: true + description: '' + example: 1a2b3c + reply_conversation_request: + oneOf: + - "$ref": "#/components/schemas/contact_reply_conversation_request" + - "$ref": "#/components/schemas/admin_reply_conversation_request" + search_request: + description: Search using Intercoms Search APIs. + type: object + title: Search data + properties: + query: + oneOf: + - "$ref": "#/components/schemas/single_filter_search_request" + title: Single filter search request + - "$ref": "#/components/schemas/multiple_filter_search_request" + title: multiple filter search request + pagination: + "$ref": "#/components/schemas/starting_after_paging" + required: + - query + segment: + title: Segment + type: object + x-tags: + - Segments + description: A segment is a group of your contacts defined by the rules that + you set. + properties: + type: + type: string + description: The type of object. + enum: + - segment + example: segment + id: + type: string + description: The unique identifier representing the segment. + example: 56203d253cba154d39010062 + name: + type: string + description: The name of the segment. + example: Active + created_at: + type: integer + description: The time the segment was created. + example: 1394621988 + updated_at: + type: integer + description: The time the segment was updated. + example: 1394622004 + person_type: + type: string + description: 'Type of the contact: contact (lead) or user.' + enum: + - contact + - user + example: contact + count: + type: integer + description: The number of items in the user segment. It's returned when + `include_count=true` is included in the request. + example: 3 + nullable: true + segment_list: + title: Segment List + type: object + description: This will return a list of Segment Objects. The result may also + have a pages object if the response is paginated. + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + description: A list of Segment objects + items: + "$ref": "#/components/schemas/segment" + pages: + type: object + description: A pagination object, which may be empty, indicating no further + pages to fetch. + single_filter_search_request: + title: Single Filter Search Request + description: Search using Intercoms Search APIs with a single filter. + type: object + properties: + field: + type: string + description: The accepted field that you want to search on. + example: created_at + operator: + type: string + enum: + - "=" + - "!=" + - IN + - NIN + - "<" + - ">" + - "~" + - "!~" + - "^" + - "$" + description: The accepted operators you can use to define how you want to + search for the value. + example: ">" + value: + type: string + description: The value that you want to search on. + example: '73732934' + sla_applied: + title: Applied SLA + type: object + nullable: true + description: | + The SLA Applied object contains the details for which SLA has been applied to this conversation. + Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. + properties: + type: + type: string + description: object type + example: conversation_sla_summary + sla_name: + type: string + description: The name of the SLA as given by the teammate when it was created. + example: '' + sla_status: + type: string + enum: + - hit + - missed + - cancelled + - active + description: |- + SLA statuses: + - `hit`: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation. + - `missed`: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies. + - `active`: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events. + example: hit + snooze_conversation_request: + title: Snooze Conversation Request + type: object + description: Payload of the request to snooze a conversation + properties: + message_type: + type: string + enum: + - snoozed + example: snoozed + admin_id: + type: string + description: The id of the admin who is performing the action. + example: '5017691' + snoozed_until: + type: integer + format: timestamp + description: The time you want the conversation to reopen. + example: 1673609604 + required: + - message_type + - admin_id + - snoozed_until + social_profile: + title: Social Profile + type: object + description: A Social Profile allows you to label your contacts, companies, + and conversations and list them using that Social Profile. + properties: + type: + type: string + description: value is "social_profile" + example: social_profile + name: + type: string + description: The name of the Social media profile + example: Facebook + url: + type: string + format: uri + description: The name of the Social media profile + example: http://twitter.com/th1sland + starting_after_paging: + title: 'Pagination: Starting After' + type: object + nullable: true + properties: + per_page: + type: integer + description: The number of results to fetch per page. + example: 2 + starting_after: + type: string + description: The cursor to use in the next request to get the next page + of results. + nullable: true + example: your-cursor-from-response + subscription_type: + title: Subscription Types + type: object + x-tags: + - Subscription Types + description: A subscription type lets customers easily opt out of non-essential + communications without missing what's important to them. + properties: + type: + type: string + description: The type of the object - subscription + example: subscription + id: + type: string + description: The unique identifier representing the subscription type. + example: '123456' + state: + type: string + description: The state of the subscription type. + enum: + - live + - draft + - archived + example: live + default_translation: + "$ref": "#/components/schemas/translation" + translations: + type: array + description: An array of translations objects with the localised version + of the subscription type in each available locale within your translation + settings. + items: + "$ref": "#/components/schemas/translation" + consent_type: + type: string + description: Describes the type of consent. + enum: + - opt_out + - opt_in + example: opt_in + content_types: + type: array + description: The message types that this subscription supports - can contain + `email` or `sms_message`. + items: + type: string + enum: + - email + - sms_message + example: email + subscription_type_list: + title: Subscription Types + type: object + description: A list of subscription type objects. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of subscription type objects associated with the workspace + . + items: + "$ref": "#/components/schemas/subscription_type" + tag: + title: Tag + type: object + x-tags: + - Tags + description: A tag allows you to label your contacts, companies, and conversations + and list them using that tag. + properties: + type: + type: string + description: value is "tag" + example: tag + id: + type: string + description: The id of the tag + example: '123456' + name: + type: string + description: The name of the tag + example: Test tag + applied_at: + type: integer + format: date-time + description: The time when the tag was applied to the object + example: 1663597223 + applied_by: + "$ref": "#/components/schemas/reference" + tag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Tag Company Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + tag_list: + title: Tags + type: object + description: A list of tags objects in the workspace. + properties: + type: + type: string + description: The type of the object + enum: + - list + example: list + data: + type: array + description: A list of tags objects associated with the workspace . + items: + "$ref": "#/components/schemas/tag" + tag_multiple_users_request: + description: You can tag a list of users. + type: object + title: Tag Users Request Payload + properties: + name: + type: string + description: The name of the tag, which will be created if not found. + example: Independent + users: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the user. + example: 5f7f0d217289f8d2f4262080 + required: + - name + - users + tags: + title: Tags + type: object + description: A list of tags objects associated with a conversation + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + description: A list of tags objects associated with the conversation. + items: + "$ref": "#/components/schemas/tag" + team: + title: Team + type: object + x-tags: + - Teams + description: Teams are groups of admins in Intercom. + properties: + type: + type: string + description: Value is always "team" + example: team + id: + type: string + description: The id of the team + example: '814865' + name: + type: string + description: The name of the team + example: Example Team + admin_ids: + type: array + description: The list of admin IDs that are a part of the team. + example: + - 493881 + items: + type: integer + admin_priority_level: + "$ref": "#/components/schemas/admin_priority_level" + team_list: + title: Team List + type: object + description: This will return a list of team objects for the App. + properties: + type: + type: string + description: The type of the object + enum: + - team.list + example: team.list + teams: + type: array + description: A list of team objects + items: + "$ref": "#/components/schemas/team" + team_priority_level: + title: Team Priority Level + type: object + nullable: true + description: Admin priority levels for teams + properties: + primary_team_ids: + type: array + description: The primary team ids for the team + nullable: true + example: + - 814865 + items: + type: integer + secondary_team_ids: + type: array + description: The secondary team ids for the team + nullable: true + example: + - 493881 + items: + type: integer + ticket: + title: Ticket + type: object + x-tags: + - Tickets + description: Tickets are how you track requests from your users. + nullable: true + properties: + type: + type: string + description: Always ticket + enum: + - ticket + default: ticket + example: ticket + id: + type: string + description: The unique identifier for the ticket which is given by Intercom. + example: '1295' + ticket_id: + type: string + description: The ID of the Ticket used in the Intercom Inbox and Messenger. + Do not use ticket_id for API queries. + example: '1390' + category: + type: string + description: Category of the Ticket. + enum: + - Customer + - Back-office + - Tracker + example: Customer + ticket_attributes: + "$ref": "#/components/schemas/ticket_custom_attributes" + ticket_state: + type: string + description: The state the ticket is currently in + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + example: submitted + ticket_type: + "$ref": "#/components/schemas/ticket_type" + contacts: + "$ref": "#/components/schemas/ticket_contacts" + admin_assignee_id: + type: string + description: The id representing the admin assigned to the ticket. + example: '1295' + team_assignee_id: + type: string + description: The id representing the team assigned to the ticket. + example: '1295' + created_at: + type: integer + format: date-time + description: The time the ticket was created as a UTC Unix timestamp. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket was updated as a UTC Unix timestamp. + example: 1663597260 + open: + type: boolean + description: Whether or not the ticket is open. If false, the ticket is + closed. + example: true + snoozed_until: + type: integer + format: date-time + description: The time the ticket will be snoozed until as a UTC Unix timestamp. + If null, the ticket is not currently snoozed. + example: 1663597260 + linked_objects: + "$ref": "#/components/schemas/linked_object_list" + ticket_parts: + "$ref": "#/components/schemas/ticket_parts" + is_shared: + type: boolean + description: Whether or not the ticket is shared with the customer. + example: true + ticket_state_internal_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible in Intercom + ticket_state_external_label: + type: string + description: The state the ticket is currently in, in a human readable form + - visible to customers, in the messenger, email and tickets portal. + ticket_contacts: + title: Contacts + type: object + x-tags: + - Tickets + description: The list of contacts affected by a ticket. + properties: + type: + type: string + description: always contact.list + enum: + - contact.list + example: contact.list + contacts: + type: array + description: The list of contacts affected by this ticket. + items: + "$ref": "#/components/schemas/contact_reference" + ticket_custom_attributes: + title: Ticket Attributes + type: object + description: An object containing the different attributes associated to the + ticket as key-value pairs. For the default title and description attributes, + the keys are `_default_title_` and `_default_description_`. + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + - "$ref": "#/components/schemas/file_attribute" + example: + _default_title_: Found a bug + _default_description_: The button's not working + ticket_list: + title: Ticket List + type: object + description: Tickets are how you track requests from your users. + properties: + type: + type: string + description: Always ticket.list + enum: + - ticket.list + example: ticket.list + tickets: + type: array + description: The list of ticket objects + items: + "$ref": "#/components/schemas/ticket" + total_count: + type: integer + description: A count of the total number of objects. + example: 12345 + pages: + "$ref": "#/components/schemas/cursor_pages" + ticket_part: + title: Ticket Part + type: object + x-tags: + - Tickets + description: A Ticket Part represents a message in the ticket. + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + id: + type: string + description: The id representing the ticket part. + example: '3' + part_type: + type: string + description: The type of ticket part. + example: comment + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + previous_ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The previous state of the ticket. + example: submitted + ticket_state: + type: string + enum: + - submitted + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + created_at: + type: integer + format: date-time + description: The time the ticket part was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the ticket part was updated. + example: 1663597260 + assigned_to: + "$ref": "#/components/schemas/reference" + nullable: true + description: The id of the admin that was assigned the ticket by this ticket_part + (null if there has been no change in assignment.) + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + external_id: + type: string + nullable: true + description: The external id of the ticket part + example: abcd1234 + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_part_author: + title: Ticket part author + type: object + description: The author that wrote or triggered the part. Can be a bot, admin, + team or user. + properties: + type: + type: string + description: The type of the author + example: admin + enum: + - admin + - bot + - team + - user + id: + type: string + description: The id of the author + example: '274' + name: + type: string + nullable: true + description: The name of the author + example: Operator + email: + type: string + format: email + description: The email of the author + example: operator+abcd1234@intercom.io + ticket_parts: + title: Ticket Parts + type: object + description: A list of Ticket Part objects for each note and event in the ticket. + There is a limit of 500 parts. + properties: + type: + type: string + description: '' + enum: + - ticket_part.list + example: ticket_part.list + ticket_parts: + title: Tickt Parts + type: array + description: A list of Ticket Part objects for each ticket. There is a limit + of 500 parts. + items: + "$ref": "#/components/schemas/ticket_part" + total_count: + type: integer + description: '' + example: 2 + ticket_reply: + title: A Ticket Part representing a note, comment, or quick_reply on a ticket + type: object + description: A Ticket Part representing a note, comment, or quick_reply on a + ticket + properties: + type: + type: string + description: Always ticket_part + example: ticket_part + enum: + - ticket_part + id: + type: string + description: The id representing the part. + example: '3' + part_type: + type: string + description: Type of the part + example: note + enum: + - note + - comment + - quick_reply + body: + type: string + nullable: true + description: The message body, which may contain HTML. + example: "

Okay!

" + created_at: + type: integer + format: date-time + description: The time the note was created. + example: 1663597223 + updated_at: + type: integer + format: date-time + description: The last time the note was updated. + example: 1663597260 + author: + "$ref": "#/components/schemas/ticket_part_author" + attachments: + title: Ticket part attachments + type: array + description: A list of attachments for the part. + items: + "$ref": "#/components/schemas/part_attachment" + redacted: + type: boolean + description: Whether or not the ticket part has been redacted. + example: false + ticket_request_custom_attributes: + title: Ticket Attributes + type: object + description: The attributes set on the ticket. When setting the default title + and description attributes, the attribute keys that should be used are `_default_title_` + and `_default_description_`. When setting ticket type attributes of the list + attribute type, the key should be the attribute name and the value of the + attribute should be the list item id, obtainable by [listing the ticket type](ref:get_ticket-types). + For example, if the ticket type has an attribute called `priority` of type + `list`, the key should be `priority` and the value of the attribute should + be the guid of the list item (e.g. `de1825a0-0164-4070-8ca6-13e22462fa7e`). + additionalProperties: + anyOf: + - type: string + nullable: true + - type: number + - type: boolean + - type: array + example: + _default_title_: Found a bug + _default_description_: The button is not working + ticket_type: + title: Ticket Type + type: object + x-tags: + - Tickets + description: A ticket type, used to define the data fields to be captured in + a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type`. + example: ticket_type + id: + type: string + description: The id representing the ticket type. + example: '1295' + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + name: + type: string + description: The name of the ticket type + example: Bug + description: + type: string + description: The description of the ticket type + example: A bug that has been reported. + icon: + type: string + description: The icon of the ticket type + example: "\U0001F41E" + workspace_id: + type: string + description: The id of the workspace that the ticket type belongs to. + example: ecahpwf5 + ticket_type_attributes: + "$ref": "#/components/schemas/ticket_type_attribute_list" + archived: + type: boolean + description: Whether the ticket type is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type was last updated. + ticket_type_attribute: + title: Ticket Type Attribute + type: object + description: Ticket type attribute, used to define each data field to be captured + in a ticket. + nullable: true + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attribute`. + example: ticket_type_attribute + id: + type: string + description: The id representing the ticket type attribute. + example: '1' + workspace_id: + type: string + description: The id of the workspace that the ticket type attribute belongs + to. + example: ecahpwf5 + name: + type: string + description: The name of the ticket type attribute + example: Title + description: + type: string + description: The description of the ticket type attribute + example: Bug title. + data_type: + type: string + description: 'The type of the data attribute (allowed values: "string list + integer decimal boolean datetime files")' + example: string + input_options: + type: object + description: Input options for the attribute + example: 'multiline: true' + order: + type: integer + description: The order of the attribute against other attributes + example: 1 + required_to_create: + type: boolean + description: Whether the attribute is required or not for teammates. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required or not for contacts. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible or not to teammates. + default: true + example: false + visible_to_contacts: + type: boolean + description: Whether the attribute is visible or not to contacts. + default: true + example: false + default: + type: boolean + description: Whether the attribute is built in or not. + example: true + ticket_type_id: + type: integer + description: The id of the ticket type that the attribute belongs to. + example: 42 + archived: + type: boolean + description: Whether the ticket type attribute is archived or not. + example: false + created_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was created. + updated_at: + type: integer + format: timestamp + description: The date and time the ticket type attribute was last updated. + ticket_type_attribute_list: + title: Ticket Type Attributes + type: object + description: A list of attributes associated with a given ticket type. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type_attributes.list`. + ticket_type_attributes: + type: array + description: A list of ticket type attributes associated with a given ticket + type. + items: + "$ref": "#/components/schemas/ticket_type_attribute" + ticket_type_list: + title: Ticket Types + type: object + description: A list of ticket types associated with a given workspace. + properties: + type: + type: string + description: String representing the object's type. Always has the value + `ticket_type.list`. + ticket_types: + type: array + description: A list of ticket_types associated with a given workspace. + items: + "$ref": "#/components/schemas/ticket_type" + translation: + title: Translation + type: object + description: A translation object contains the localised details of a subscription + type. + properties: + name: + type: string + description: The localised name of the subscription type. + example: Announcements + description: + type: string + description: The localised description of the subscription type. + example: Offers, product and feature announcements + locale: + type: string + description: The two character identifier for the language of the translation + object. + example: en + untag_company_request: + description: You can tag a single company or a list of companies. + type: object + title: Untag Company Request Payload + properties: + name: + type: string + description: The name of the tag which will be untagged from the company + example: Independent + companies: + type: array + items: + properties: + id: + type: string + description: The Intercom defined id representing the company. + example: 531ee472cce572a6ec000006 + company_id: + type: string + description: The company id you have defined for the company. + example: '6' + untag: + type: boolean + description: Always set to true + example: 'true' + description: The id or company_id of the company can be passed as input + parameters. + required: + - name + - companies + update_article_request: + description: You can Update an Article + type: object + title: Update Article Request Payload + nullable: true + properties: + title: + type: string + description: The title of the article.For multilingual articles, this will + be the title of the default language's content. + example: Thanks for everything + description: + type: string + description: The description of the article. For multilingual articles, + this will be the description of the default language's content. + example: Description of the Article + body: + type: string + description: The content of the article. For multilingual articles, this + will be the body of the default language's content. + example: "

This is the body in html

" + author_id: + type: integer + description: The id of the author of the article. For multilingual articles, + this will be the id of the author of the default language's content. Must + be a teammate on the help center's workspace. + example: 1295 + state: + type: string + description: Whether the article will be `published` or will be a `draft`. + Defaults to draft. For multilingual articles, this will be the state of + the default language's content. + enum: + - published + - draft + example: draft + parent_id: + type: string + description: The id of the article's parent collection or section. An article + without this field stands alone. + example: '18' + parent_type: + type: string + description: The type of parent, which can either be a `collection` or `section`. + example: collection + translated_content: + "$ref": "#/components/schemas/article_translated_content" + update_collection_request: + description: You can update a collection + type: object + title: Update Collection Request Payload + properties: + name: + type: string + description: The name of the collection. For multilingual collections, this + will be the name of the default language's content. + example: collection 51 + description: + type: string + description: The description of the collection. For multilingual collections, + this will be the description of the default language's content. + example: English description + translated_content: + nullable: true + "$ref": "#/components/schemas/group_translated_content" + parent_id: + type: string + nullable: true + description: The id of the parent collection. If `null` then it will be + updated as the first level collection. + example: '6871118' + update_contact_request: + description: You can update a contact + type: object + title: Update Contact Request Payload + properties: + role: + type: string + description: The role of the contact. + external_id: + type: string + description: A unique identifier for the contact which is given to Intercom + email: + type: string + description: The contacts email + example: jdoe@example.com + phone: + type: string + nullable: true + description: The contacts phone + example: "+353871234567" + name: + type: string + nullable: true + description: The contacts name + example: John Doe + avatar: + type: string + nullable: true + description: An image URL containing the avatar of a contact + example: https://www.example.com/avatar_image.jpg + signed_up_at: + type: integer + format: date-time + nullable: true + description: The time specified for when a contact signed up + example: 1571672154 + last_seen_at: + type: integer + format: date-time + nullable: true + description: The time when the contact was last seen (either where the Intercom + Messenger was installed or when specified manually) + example: 1571672154 + owner_id: + type: integer + nullable: true + description: The id of an admin that has been assigned account ownership + of the contact + example: 123 + unsubscribed_from_emails: + type: boolean + nullable: true + description: Whether the contact is unsubscribed from emails + example: true + custom_attributes: + type: object + nullable: true + description: The custom attributes which are set for the contact + update_conversation_request: + title: Update Conversation Request + type: object + description: Payload of the request to update a conversation + properties: + read: + type: boolean + description: Mark a conversation as read within Intercom. + example: true + custom_attributes: + "$ref": "#/components/schemas/custom_attributes" + update_data_attribute_request: + description: '' + type: object + title: Update Data Attribute Request + properties: + archived: + type: boolean + description: Whether the attribute is to be archived or not. + example: false + description: + type: string + description: The readable description you see in the UI for the attribute. + example: My Data Attribute Description + options: + type: array + description: To create list attributes. Provide a set of hashes with `value` + as the key of the options you want to make. `data_type` must be `string`. + items: + type: string + example: + - option1 + - option2 + messenger_writable: + type: boolean + description: Can this attribute be updated by the Messenger + example: false + update_ticket_request: + description: You can update a Ticket + type: object + title: Update Ticket Request Payload + properties: + ticket_attributes: + type: object + description: The attributes set on the ticket. + example: + _default_title_: example + _default_description_: having a problem + state: + type: string + enum: + - in_progress + - waiting_on_customer + - resolved + description: The state of the ticket. + example: submitted + open: + type: boolean + description: Specify if a ticket is open. Set to false to close a ticket. + Closing a ticket will also unsnooze it. + example: true + is_shared: + type: boolean + description: Specify whether the ticket is visible to users. + example: true + snoozed_until: + type: integer + format: timestamp + description: The time you want the ticket to reopen. + example: 1673609604 + assignment: + type: object + properties: + admin_id: + type: string + description: The ID of the admin performing the action. + example: '123' + assignee_id: + type: string + description: The ID of the admin or team to which the ticket is assigned. + Set this 0 to unassign it. + example: '123' + update_ticket_type_attribute_request: + description: You can update a Ticket Type Attribute + type: object + title: Update Ticket Type Attribute Request Payload + properties: + name: + type: string + description: The name of the ticket type attribute + example: Bug Priority + description: + type: string + description: The description of the attribute presented to the teammate + or contact + example: Priority level of the bug + required_to_create: + type: boolean + description: Whether the attribute is required to be filled in when teammates + are creating the ticket in Inbox. + default: false + example: false + required_to_create_for_contacts: + type: boolean + description: Whether the attribute is required to be filled in when contacts + are creating the ticket in Messenger. + default: false + example: false + visible_on_create: + type: boolean + description: Whether the attribute is visible to teammates when creating + a ticket in Inbox. + default: true + example: true + visible_to_contacts: + type: boolean + description: Whether the attribute is visible to contacts when creating + a ticket in Messenger. + default: true + example: true + multiline: + type: boolean + description: Whether the attribute allows multiple lines of text (only applicable + to string attributes) + example: false + list_items: + type: string + description: A comma delimited list of items for the attribute value (only + applicable to list attributes) + example: Low Priority,Medium Priority,High Priority + allow_multiple_values: + type: boolean + description: Whether the attribute allows multiple files to be attached + to it (only applicable to file attributes) + example: false + archived: + type: boolean + description: Whether the attribute should be archived and not shown during + creation of the ticket (it will still be present on previously created + tickets) + example: false + update_ticket_type_request: + description: | + The request payload for updating a ticket type. + You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) + type: object + title: Update Ticket Type Request Payload + nullable: true + properties: + name: + type: string + description: The name of the ticket type. + example: Bug + description: + type: string + description: The description of the ticket type. + example: A bug has been occured + category: + type: string + description: Category of the Ticket Type. + enum: + - Customer + - Back-office + - Tracker + example: Customer + icon: + type: string + description: The icon of the ticket type. + example: "\U0001F41E" + default: "\U0001F39F️" + archived: + type: boolean + description: The archived status of the ticket type. + example: false + is_internal: + type: boolean + description: Whether the tickets associated with this ticket type are intended + for internal use only or will be shared with customers. This is currently + a limited attribute. + example: false + default: false + update_visitor_request: + description: Update an existing visitor. + type: object + title: Update Visitor Request Payload + properties: + id: + type: string + description: A unique identified for the visitor which is given by Intercom. + example: 8a88a590-e + user_id: + type: string + description: A unique identified for the visitor which is given by you. + example: '123' + name: + type: string + description: The visitor's name. + example: Christian Bale + custom_attributes: + type: object + description: The custom attributes which are set for the visitor. + additionalProperties: + type: string + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 9 + anyOf: + - required: + - id + - required: + - user_id + visitor: + title: Visitor + type: object + description: Visitors are useful for representing anonymous people that have + not yet been identified. They usually represent website visitors. Visitors + are not visible in Intercom platform. The Visitors resource provides methods + to fetch, update, convert and delete. + nullable: true + properties: + type: + type: string + description: Value is 'visitor' + default: visitor + example: visitor + id: + type: string + description: The Intercom defined id representing the Visitor. + example: 530370b477ad7120001d + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + anonymous: + type: boolean + description: Identifies if this visitor is anonymous. + example: false + email: + type: string + format: email + description: The email of the visitor. + example: jane.doe@example.com + phone: + type: string + nullable: true + description: The phone number of the visitor. + example: 555-555-5555 + name: + type: string + nullable: true + description: The name of the visitor. + example: Jane Doe + pseudonym: + type: string + nullable: true + description: The pseudonym of the visitor. + example: Red Duck from Dublin + avatar: + type: object + properties: + type: + type: string + description: '' + default: avatar + example: avatar + image_url: + type: string + format: uri + nullable: true + description: This object represents the avatar associated with the visitor. + example: https://example.com/avatar.png + app_id: + type: string + description: The id of the app the visitor is associated with. + example: hfi1bx4l + companies: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - company.list + example: company.list + companies: + type: array + items: + "$ref": "#/components/schemas/company" + location_data: + type: object + properties: + type: + type: string + description: '' + default: location_data + example: location_data + city_name: + type: string + description: The city name of the visitor. + example: Dublin + continent_code: + type: string + description: The continent code of the visitor. + example: EU + country_code: + type: string + description: The country code of the visitor. + example: IRL + country_name: + type: string + description: The country name of the visitor. + example: Ireland + postal_code: + type: string + description: The postal code of the visitor. + example: D02 N960 + region_name: + type: string + description: The region name of the visitor. + example: Leinster + timezone: + type: string + description: The timezone of the visitor. + example: Europe/Dublin + las_request_at: + type: integer + description: The time the Lead last recorded making a request. + example: 1663597260 + created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + remote_created_at: + type: integer + description: The time the Visitor was added to Intercom. + example: 1663597223 + signed_up_at: + type: integer + description: The time the Visitor signed up for your product. + example: 1663597223 + updated_at: + type: integer + description: The last time the Visitor was updated. + example: 1663597260 + session_count: + type: integer + description: The number of sessions the Visitor has had. + example: 1 + social_profiles: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - social_profile.list + example: social_profile.list + social_profiles: + type: array + items: + type: string + owner_id: + type: string + nullable: true + description: The id of the admin that owns the Visitor. + example: '5169261' + unsubscribed_from_emails: + type: boolean + description: Whether the Visitor is unsubscribed from emails. + example: false + marked_email_as_spam: + type: boolean + description: Identifies if this visitor has marked an email as spam. + example: false + has_hard_bounced: + type: boolean + description: Identifies if this visitor has had a hard bounce. + example: false + tags: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - tag.list + example: tag.list + tags: + type: array + items: + properties: + type: + type: string + description: The type of the object + enum: + - tag + example: tag + id: + type: string + description: The id of the tag. + example: '8482' + name: + type: string + description: The name of the tag. + example: tag_name + segments: + type: object + properties: + type: + type: string + description: The type of the object + enum: + - segment.list + example: segment.list + segments: + type: array + items: + type: string + custom_attributes: + type: object + description: The custom attributes you have set on the Visitor. + additionalProperties: + type: string + referrer: + type: string + nullable: true + description: The referer of the visitor. + example: https://www.google.com/ + utm_campaign: + type: string + nullable: true + description: The utm_campaign of the visitor. + example: intercom-link + utm_content: + type: string + nullable: true + description: The utm_content of the visitor. + example: banner + utm_medium: + type: string + nullable: true + description: The utm_medium of the visitor. + example: email + utm_source: + type: string + nullable: true + description: The utm_source of the visitor. + example: Intercom + utm_term: + type: string + nullable: true + description: The utm_term of the visitor. + example: messenger + do_not_track: + type: boolean + nullable: true + description: Identifies if this visitor has do not track enabled. + example: false + visitor_deleted_object: + title: Visitor Deleted Object + type: object + description: Response returned when an object is deleted + properties: + id: + type: string + description: The unique identifier for the visitor which is given by Intercom. + example: 530370b477ad7120001d + type: + type: string + description: The type of object which was deleted + enum: + - visitor + example: visitor + user_id: + type: string + description: Automatically generated identifier for the Visitor. + example: 8a88a590-e1c3-41e2-a502-e0649dbf721c + securitySchemes: + bearerAuth: + type: http + scheme: bearer +servers: +- url: https://api.intercom.io + description: The production API server +- url: https://api.eu.intercom.io + description: The european API server +- url: https://api.au.intercom.io + description: The australian API server +security: +- bearerAuth: [] +tags: +- name: Admins + description: Everything about your Admins +- name: Articles + description: Everything about your Articles +- name: Companies + description: Everything about your Companies +- name: Contacts + description: Everything about your contacts +- name: Conversations + description: Everything about your Conversations + externalDocs: + description: What is a conversation? + url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation +- name: Data Attributes + description: Everything about your Data Attributes +- name: Data Events + description: Everything about your Data Events +- name: Data Export + description: Everything about your Data Exports +- name: Help Center + description: Everything about your Help Center +- name: Messages + description: Everything about your messages +- name: News + description: Everything about your News + externalDocs: + description: News explained + url: https://www.intercom.com/help/en/articles/6362251-news-explained +- name: Notes + description: Everything about your Notes +- name: Segments + description: Everything about your Segments +- name: Subscription Types + description: Everything about subscription types +- name: Switch + description: Everything about Switch + externalDocs: + description: 'Meet Switch: from on hold to messaging in just a few taps' + url: https://www.intercom.com/switch +- name: Tags + description: Everything about tags +- name: Teams + description: Everything about your Teams +- name: Ticket Type Attributes + description: Everything about your ticket type attributes +- name: Ticket Types + description: Everything about your ticket types +- name: Tickets + description: Everything about your tickets +- name: Visitors + description: Everything about your Visitors \ No newline at end of file From f0b1aa6101d2a80c26812f32516030bf17eb4e4c Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Tue, 12 Nov 2024 18:26:47 -0500 Subject: [PATCH 4/8] Update only-include-referenced-schemas snapshot --- .../only-include-referenced-schemas.json | 582 ------------------ .../only-include-referenced-schemas.json | 582 ------------------ .../fern/generators.yml | 2 + .../src/OpenApiIrConverterContext.ts | 93 ++- .../src/buildTypeReference.ts | 7 +- 5 files changed, 90 insertions(+), 1176 deletions(-) diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json index 1c760a22c7e..236fbdfc267 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json @@ -3930,7 +3930,6 @@ "conversations": "conversations.yml", "customObjectInstances": "customObjectInstances.yml", "dataAttributes": "dataAttributes.yml", - "dataEvents": "dataEvents.yml", "helpCenter": "helpCenter.yml", "news": "news.yml", "notes": "notes.yml", @@ -5178,36 +5177,6 @@ "openapi": "../openapi.yml", }, }, - "ContactSubscriptionTypes": { - "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", - "properties": { - "data": { - "docs": "This object represents the subscriptions attached to a contact.", - "type": "optional>", - }, - "has_more": { - "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", - "type": "optional", - }, - "total_count": { - "docs": "Int representing the total number of subscription types attached to this contact", - "type": "optional", - }, - "url": { - "docs": "Url to get more subscription type resources for this contact", - "type": "optional", - "validation": { - "format": "uri", - "maxLength": undefined, - "minLength": undefined, - "pattern": undefined, - }, - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", "properties": { @@ -5761,22 +5730,6 @@ "openapi": "../openapi.yml", }, }, - "CreateTicketReplyWithCommentRequest": { - "discriminated": false, - "docs": undefined, - "encoding": undefined, - "source": { - "openapi": "../openapi.yml", - }, - "union": [ - { - "type": "ContactReplyTicketRequest", - }, - { - "type": "AdminReplyTicketRequest", - }, - ], - }, "CreateTicketTypeRequest": { "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) @@ -5929,36 +5882,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "DataEventList": { - "docs": "This will return a list of data events for the App.", - "properties": { - "events": { - "docs": "A list of data events", - "type": "optional>", - }, - "pages": { - "docs": "Pagination", - "type": "optional", - }, - "type": { - "docs": "The type of the object", - "type": "optional>", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, - "DataEventListPages": { - "docs": "Pagination", - "properties": { - "next": "optional", - "since": "optional", - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", "properties": { @@ -6015,118 +5938,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "DataExportCsv": { - "docs": "A CSV output file", - "properties": { - "company_id": { - "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", - "type": "optional", - }, - "content_id": { - "docs": "The specific content that was received. In an A/B test each version has its own Content ID.", - "type": "optional", - }, - "content_title": { - "docs": "The title of the content you see in your Intercom workspace.", - "type": "optional", - }, - "content_type": { - "docs": "Email, Chat, Post etc.", - "type": "optional", - }, - "email": { - "docs": "The users email who was sent the message.", - "type": "optional", - }, - "first_click": { - "docs": "The first time the series the user clicked on a link within this message.", - "type": "optional", - }, - "first_completion": { - "docs": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.", - "type": "optional", - }, - "first_dismisall": { - "docs": "The first time the series the user dismissed this message.", - "type": "optional", - }, - "first_goal_success": { - "docs": "The first time the user met this messages associated goal if one exists.", - "type": "optional", - }, - "first_hard_bounce": { - "docs": "The first time this message hard bounced for this user", - "type": "optional", - }, - "first_open": { - "docs": "The first time the user opened this message.", - "type": "optional", - }, - "first_reply": { - "docs": "The first time a user replied to this message if the content was able to receive replies.", - "type": "optional", - }, - "first_series_completion": { - "docs": "The first time the series this message was a part of was completed by the user.", - "type": "optional", - }, - "first_series_disengagement": { - "docs": "The first time the series this message was a part of was disengaged by the user.", - "type": "optional", - }, - "first_series_exit": { - "docs": "The first time the series this message was a part of was exited by the user.", - "type": "optional", - }, - "first_unsubscribe": { - "docs": "The first time the user unsubscribed from this message.", - "type": "optional", - }, - "name": { - "docs": "The full name of the user receiving the message", - "type": "optional", - }, - "node_id": { - "docs": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.", - "type": "optional", - }, - "receipt_id": { - "docs": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.", - "type": "optional", - }, - "received_at": { - "docs": "Timestamp for when the receipt was recorded.", - "type": "optional", - }, - "ruleset_id": { - "docs": "The id of the message.", - "type": "optional", - }, - "ruleset_version_id": { - "docs": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.", - "type": "optional", - }, - "series_id": { - "docs": "The id of the series that this content is part of. Will return -1 if not part of a series.", - "type": "optional", - }, - "series_title": { - "docs": "The title of the series that this content is part of.", - "type": "optional", - }, - "user_external_id": { - "docs": "The external_user_id of the user who was sent the message", - "type": "optional", - }, - "user_id": { - "docs": "The user_id of the user who was sent the message.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", "properties": { @@ -6480,84 +6291,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "IntercomVersion": { - "default": "2.11", - "docs": "Intercom API version.
By default, it's equal to the version set in the app package.", - "enum": [ - { - "name": "One0", - "value": "1.0", - }, - { - "name": "One1", - "value": "1.1", - }, - { - "name": "One2", - "value": "1.2", - }, - { - "name": "One3", - "value": "1.3", - }, - { - "name": "One4", - "value": "1.4", - }, - { - "name": "Two0", - "value": "2.0", - }, - { - "name": "Two1", - "value": "2.1", - }, - { - "name": "Two2", - "value": "2.2", - }, - { - "name": "Two3", - "value": "2.3", - }, - { - "name": "Two4", - "value": "2.4", - }, - { - "name": "Two5", - "value": "2.5", - }, - { - "name": "Two6", - "value": "2.6", - }, - { - "name": "Two7", - "value": "2.7", - }, - { - "name": "Two8", - "value": "2.8", - }, - { - "name": "Two9", - "value": "2.9", - }, - { - "name": "Two10", - "value": "2.10", - }, - { - "name": "Two11", - "value": "2.11", - }, - "Unstable", - ], - "source": { - "openapi": "../openapi.yml", - }, - }, "LinkedObject": { "docs": "A linked conversation or ticket.", "properties": { @@ -7919,26 +7652,6 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "openapi": "../openapi.yml", }, }, - "VisitorDeletedObject": { - "docs": "Response returned when an object is deleted", - "properties": { - "id": { - "docs": "The unique identifier for the visitor which is given by Intercom.", - "type": "optional", - }, - "type": { - "docs": "The type of object which was deleted", - "type": "optional>", - }, - "user_id": { - "docs": "Automatically generated identifier for the Visitor.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "VisitorLocationData": { "docs": undefined, "properties": { @@ -11245,31 +10958,6 @@ types: docs: A list of social profiles objects associated with the contact. source: openapi: ../openapi.yml - ContactSubscriptionTypes: - docs: >- - An object containing Subscription Types meta data about the - SubscriptionTypes that a contact has. - properties: - data: - type: optional> - docs: This object represents the subscriptions attached to a contact. - url: - type: optional - docs: Url to get more subscription type resources for this contact - validation: - format: uri - total_count: - type: optional - docs: >- - Int representing the total number of subscription types attached to - this contact - has_more: - type: optional - docs: >- - Whether there's more Addressable Objects to be viewed. If true, use - the url to view all - source: - openapi: ../openapi.yml ContactTags: docs: >- An object containing tags meta data about the tags that a contact has. Up @@ -11756,13 +11444,6 @@ types: type: optional source: openapi: ../openapi.yml - CreateTicketReplyWithCommentRequest: - discriminated: false - union: - - type: ContactReplyTicketRequest - - type: AdminReplyTicketRequest - source: - openapi: ../openapi.yml CreateTicketTypeRequestCategory: enum: - Customer @@ -11874,27 +11555,6 @@ types: docs: A list of data attributes source: openapi: ../openapi.yml - DataEventListPages: - docs: Pagination - properties: - next: optional - since: optional - source: - openapi: ../openapi.yml - DataEventList: - docs: This will return a list of data events for the App. - properties: - type: - type: optional> - docs: The type of the object - events: - type: optional> - docs: A list of data events - pages: - type: optional - docs: Pagination - source: - openapi: ../openapi.yml DataEventSummary: docs: This will return a summary of data events for the App. properties: @@ -11935,115 +11595,6 @@ types: docs: The description of the event source: openapi: ../openapi.yml - DataExportCsv: - docs: A CSV output file - properties: - user_id: - type: optional - docs: The user_id of the user who was sent the message. - user_external_id: - type: optional - docs: The external_user_id of the user who was sent the message - company_id: - type: optional - docs: >- - The company ID of the user in relation to the message that was sent. - Will return -1 if no company is present. - email: - type: optional - docs: The users email who was sent the message. - name: - type: optional - docs: The full name of the user receiving the message - ruleset_id: - type: optional - docs: The id of the message. - content_id: - type: optional - docs: >- - The specific content that was received. In an A/B test each version - has its own Content ID. - content_type: - type: optional - docs: Email, Chat, Post etc. - content_title: - type: optional - docs: The title of the content you see in your Intercom workspace. - ruleset_version_id: - type: optional - docs: >- - As you edit content we record new versions. This ID can help you - determine which version of a piece of content that was received. - receipt_id: - type: optional - docs: >- - ID for this receipt. Will be included with any related stats in other - files to identify this specific delivery of a message. - received_at: - type: optional - docs: Timestamp for when the receipt was recorded. - series_id: - type: optional - docs: >- - The id of the series that this content is part of. Will return -1 if - not part of a series. - series_title: - type: optional - docs: The title of the series that this content is part of. - node_id: - type: optional - docs: >- - The id of the series node that this ruleset is associated with. Each - block in a series has a corresponding node_id. - first_reply: - type: optional - docs: >- - The first time a user replied to this message if the content was able - to receive replies. - first_completion: - type: optional - docs: >- - The first time a user completed this message if the content was able - to be completed e.g. Tours, Surveys. - first_series_completion: - type: optional - docs: >- - The first time the series this message was a part of was completed by - the user. - first_series_disengagement: - type: optional - docs: >- - The first time the series this message was a part of was disengaged by - the user. - first_series_exit: - type: optional - docs: >- - The first time the series this message was a part of was exited by the - user. - first_goal_success: - type: optional - docs: >- - The first time the user met this messages associated goal if one - exists. - first_open: - type: optional - docs: The first time the user opened this message. - first_click: - type: optional - docs: >- - The first time the series the user clicked on a link within this - message. - first_dismisall: - type: optional - docs: The first time the series the user dismissed this message. - first_unsubscribe: - type: optional - docs: The first time the user unsubscribed from this message. - first_hard_bounce: - type: optional - docs: The first time this message hard bounced for this user - source: - openapi: ../openapi.yml DeletedArticleObject: docs: Response returned when an object is deleted properties: @@ -12299,49 +11850,6 @@ types: docs: The content of the group in Chinese (Taiwan) source: openapi: ../openapi.yml - IntercomVersion: - enum: - - value: '1.0' - name: One0 - - value: '1.1' - name: One1 - - value: '1.2' - name: One2 - - value: '1.3' - name: One3 - - value: '1.4' - name: One4 - - value: '2.0' - name: Two0 - - value: '2.1' - name: Two1 - - value: '2.2' - name: Two2 - - value: '2.3' - name: Two3 - - value: '2.4' - name: Two4 - - value: '2.5' - name: Two5 - - value: '2.6' - name: Two6 - - value: '2.7' - name: Two7 - - value: '2.8' - name: Two8 - - value: '2.9' - name: Two9 - - value: '2.10' - name: Two10 - - value: '2.11' - name: Two11 - - Unstable - docs: >- - Intercom API version.
By default, it's equal to the version set in the - app package. - default: '2.11' - source: - openapi: ../openapi.yml LinkedObjectType: enum: - ticket @@ -13418,20 +12926,6 @@ types: docs: Identifies if this visitor has do not track enabled. source: openapi: ../openapi.yml - VisitorDeletedObject: - docs: Response returned when an object is deleted - properties: - id: - type: optional - docs: The unique identifier for the visitor which is given by Intercom. - type: - type: optional> - docs: The type of object which was deleted - user_id: - type: optional - docs: Automatically generated identifier for the Visitor. - source: - openapi: ../openapi.yml imports: admins: admins.yml articles: articles.yml @@ -13443,7 +12937,6 @@ imports: conversations: conversations.yml customObjectInstances: customObjectInstances.yml dataAttributes: dataAttributes.yml - dataEvents: dataEvents.yml news: news.yml notes: notes.yml subscriptionTypes: subscriptionTypes.yml @@ -36425,46 +35918,6 @@ You can optionally define the result page size as well with the `per_page` param "openapi": "../openapi.yml", }, }, - "DataEvent": { - "docs": "Data events are used to notify Intercom of changes to your data.", - "properties": { - "created_at": { - "docs": "The time the event occurred as a UTC Unix timestamp", - "type": "integer", - }, - "email": { - "docs": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", - "type": "optional", - }, - "event_name": { - "docs": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", - "type": "string", - }, - "id": { - "docs": "Your identifier for a lead or a user.", - "type": "optional", - }, - "intercom_user_id": { - "docs": "The Intercom identifier for the user.", - "type": "optional", - }, - "metadata": { - "docs": "Optional metadata about the event.", - "type": "optional>", - }, - "type": { - "docs": "The type of the object", - "type": "optional>", - }, - "user_id": { - "docs": "Your identifier for the user.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "LisDataEventsRequestFilter": { "discriminated": false, "docs": undefined, @@ -36561,41 +36014,6 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml - DataEvent: - docs: Data events are used to notify Intercom of changes to your data. - properties: - type: - type: optional> - docs: The type of the object - event_name: - type: string - docs: >- - The name of the event that occurred. This is presented to your App's - admins when filtering and creating segments - a good event name is - typically a past tense 'verb-noun' combination, to improve - readability, for example `updated-plan`. - created_at: - type: integer - docs: The time the event occurred as a UTC Unix timestamp - user_id: - type: optional - docs: Your identifier for the user. - id: - type: optional - docs: Your identifier for a lead or a user. - intercom_user_id: - type: optional - docs: The Intercom identifier for the user. - email: - type: optional - docs: >- - An email address for your user. An email should only be used where - your application uses email to uniquely identify users. - metadata: - type: optional> - docs: Optional metadata about the event. - source: - openapi: ../openapi.yml imports: root: __package__.yml service: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json index 2c3ecc545a3..aff511b225d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json @@ -2733,7 +2733,6 @@ "conversations": "conversations.yml", "customObjectInstances": "customObjectInstances.yml", "dataAttributes": "dataAttributes.yml", - "dataEvents": "dataEvents.yml", "helpCenter": "helpCenter.yml", "news": "news.yml", "notes": "notes.yml", @@ -3981,36 +3980,6 @@ "openapi": "../openapi.yml", }, }, - "ContactSubscriptionTypes": { - "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", - "properties": { - "data": { - "docs": "This object represents the subscriptions attached to a contact.", - "type": "optional>", - }, - "has_more": { - "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", - "type": "optional", - }, - "total_count": { - "docs": "Int representing the total number of subscription types attached to this contact", - "type": "optional", - }, - "url": { - "docs": "Url to get more subscription type resources for this contact", - "type": "optional", - "validation": { - "format": "uri", - "maxLength": undefined, - "minLength": undefined, - "pattern": undefined, - }, - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", "properties": { @@ -4564,22 +4533,6 @@ "openapi": "../openapi.yml", }, }, - "CreateTicketReplyWithCommentRequest": { - "discriminated": false, - "docs": undefined, - "encoding": undefined, - "source": { - "openapi": "../openapi.yml", - }, - "union": [ - { - "type": "ContactReplyTicketRequest", - }, - { - "type": "AdminReplyTicketRequest", - }, - ], - }, "CreateTicketTypeRequest": { "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) @@ -4732,36 +4685,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "DataEventList": { - "docs": "This will return a list of data events for the App.", - "properties": { - "events": { - "docs": "A list of data events", - "type": "optional>", - }, - "pages": { - "docs": "Pagination", - "type": "optional", - }, - "type": { - "docs": "The type of the object", - "type": "optional>", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, - "DataEventListPages": { - "docs": "Pagination", - "properties": { - "next": "optional", - "since": "optional", - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", "properties": { @@ -4818,118 +4741,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "DataExportCsv": { - "docs": "A CSV output file", - "properties": { - "company_id": { - "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", - "type": "optional", - }, - "content_id": { - "docs": "The specific content that was received. In an A/B test each version has its own Content ID.", - "type": "optional", - }, - "content_title": { - "docs": "The title of the content you see in your Intercom workspace.", - "type": "optional", - }, - "content_type": { - "docs": "Email, Chat, Post etc.", - "type": "optional", - }, - "email": { - "docs": "The users email who was sent the message.", - "type": "optional", - }, - "first_click": { - "docs": "The first time the series the user clicked on a link within this message.", - "type": "optional", - }, - "first_completion": { - "docs": "The first time a user completed this message if the content was able to be completed e.g. Tours, Surveys.", - "type": "optional", - }, - "first_dismisall": { - "docs": "The first time the series the user dismissed this message.", - "type": "optional", - }, - "first_goal_success": { - "docs": "The first time the user met this messages associated goal if one exists.", - "type": "optional", - }, - "first_hard_bounce": { - "docs": "The first time this message hard bounced for this user", - "type": "optional", - }, - "first_open": { - "docs": "The first time the user opened this message.", - "type": "optional", - }, - "first_reply": { - "docs": "The first time a user replied to this message if the content was able to receive replies.", - "type": "optional", - }, - "first_series_completion": { - "docs": "The first time the series this message was a part of was completed by the user.", - "type": "optional", - }, - "first_series_disengagement": { - "docs": "The first time the series this message was a part of was disengaged by the user.", - "type": "optional", - }, - "first_series_exit": { - "docs": "The first time the series this message was a part of was exited by the user.", - "type": "optional", - }, - "first_unsubscribe": { - "docs": "The first time the user unsubscribed from this message.", - "type": "optional", - }, - "name": { - "docs": "The full name of the user receiving the message", - "type": "optional", - }, - "node_id": { - "docs": "The id of the series node that this ruleset is associated with. Each block in a series has a corresponding node_id.", - "type": "optional", - }, - "receipt_id": { - "docs": "ID for this receipt. Will be included with any related stats in other files to identify this specific delivery of a message.", - "type": "optional", - }, - "received_at": { - "docs": "Timestamp for when the receipt was recorded.", - "type": "optional", - }, - "ruleset_id": { - "docs": "The id of the message.", - "type": "optional", - }, - "ruleset_version_id": { - "docs": "As you edit content we record new versions. This ID can help you determine which version of a piece of content that was received.", - "type": "optional", - }, - "series_id": { - "docs": "The id of the series that this content is part of. Will return -1 if not part of a series.", - "type": "optional", - }, - "series_title": { - "docs": "The title of the series that this content is part of.", - "type": "optional", - }, - "user_external_id": { - "docs": "The external_user_id of the user who was sent the message", - "type": "optional", - }, - "user_id": { - "docs": "The user_id of the user who was sent the message.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", "properties": { @@ -5283,84 +5094,6 @@ A "cursor" or pointer is used to keep track of the current position in the resul "openapi": "../openapi.yml", }, }, - "IntercomVersion": { - "default": "2.11", - "docs": "Intercom API version.
By default, it's equal to the version set in the app package.", - "enum": [ - { - "name": "One0", - "value": "1.0", - }, - { - "name": "One1", - "value": "1.1", - }, - { - "name": "One2", - "value": "1.2", - }, - { - "name": "One3", - "value": "1.3", - }, - { - "name": "One4", - "value": "1.4", - }, - { - "name": "Two0", - "value": "2.0", - }, - { - "name": "Two1", - "value": "2.1", - }, - { - "name": "Two2", - "value": "2.2", - }, - { - "name": "Two3", - "value": "2.3", - }, - { - "name": "Two4", - "value": "2.4", - }, - { - "name": "Two5", - "value": "2.5", - }, - { - "name": "Two6", - "value": "2.6", - }, - { - "name": "Two7", - "value": "2.7", - }, - { - "name": "Two8", - "value": "2.8", - }, - { - "name": "Two9", - "value": "2.9", - }, - { - "name": "Two10", - "value": "2.10", - }, - { - "name": "Two11", - "value": "2.11", - }, - "Unstable", - ], - "source": { - "openapi": "../openapi.yml", - }, - }, "LinkedObject": { "docs": "A linked conversation or ticket.", "properties": { @@ -6722,26 +6455,6 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "openapi": "../openapi.yml", }, }, - "VisitorDeletedObject": { - "docs": "Response returned when an object is deleted", - "properties": { - "id": { - "docs": "The unique identifier for the visitor which is given by Intercom.", - "type": "optional", - }, - "type": { - "docs": "The type of object which was deleted", - "type": "optional>", - }, - "user_id": { - "docs": "Automatically generated identifier for the Visitor.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "VisitorLocationData": { "docs": undefined, "properties": { @@ -9193,31 +8906,6 @@ types: docs: A list of social profiles objects associated with the contact. source: openapi: ../openapi.yml - ContactSubscriptionTypes: - docs: >- - An object containing Subscription Types meta data about the - SubscriptionTypes that a contact has. - properties: - data: - type: optional> - docs: This object represents the subscriptions attached to a contact. - url: - type: optional - docs: Url to get more subscription type resources for this contact - validation: - format: uri - total_count: - type: optional - docs: >- - Int representing the total number of subscription types attached to - this contact - has_more: - type: optional - docs: >- - Whether there's more Addressable Objects to be viewed. If true, use - the url to view all - source: - openapi: ../openapi.yml ContactTags: docs: >- An object containing tags meta data about the tags that a contact has. Up @@ -9704,13 +9392,6 @@ types: type: optional source: openapi: ../openapi.yml - CreateTicketReplyWithCommentRequest: - discriminated: false - union: - - type: ContactReplyTicketRequest - - type: AdminReplyTicketRequest - source: - openapi: ../openapi.yml CreateTicketTypeRequestCategory: enum: - Customer @@ -9822,27 +9503,6 @@ types: docs: A list of data attributes source: openapi: ../openapi.yml - DataEventListPages: - docs: Pagination - properties: - next: optional - since: optional - source: - openapi: ../openapi.yml - DataEventList: - docs: This will return a list of data events for the App. - properties: - type: - type: optional> - docs: The type of the object - events: - type: optional> - docs: A list of data events - pages: - type: optional - docs: Pagination - source: - openapi: ../openapi.yml DataEventSummary: docs: This will return a summary of data events for the App. properties: @@ -9883,115 +9543,6 @@ types: docs: The description of the event source: openapi: ../openapi.yml - DataExportCsv: - docs: A CSV output file - properties: - user_id: - type: optional - docs: The user_id of the user who was sent the message. - user_external_id: - type: optional - docs: The external_user_id of the user who was sent the message - company_id: - type: optional - docs: >- - The company ID of the user in relation to the message that was sent. - Will return -1 if no company is present. - email: - type: optional - docs: The users email who was sent the message. - name: - type: optional - docs: The full name of the user receiving the message - ruleset_id: - type: optional - docs: The id of the message. - content_id: - type: optional - docs: >- - The specific content that was received. In an A/B test each version - has its own Content ID. - content_type: - type: optional - docs: Email, Chat, Post etc. - content_title: - type: optional - docs: The title of the content you see in your Intercom workspace. - ruleset_version_id: - type: optional - docs: >- - As you edit content we record new versions. This ID can help you - determine which version of a piece of content that was received. - receipt_id: - type: optional - docs: >- - ID for this receipt. Will be included with any related stats in other - files to identify this specific delivery of a message. - received_at: - type: optional - docs: Timestamp for when the receipt was recorded. - series_id: - type: optional - docs: >- - The id of the series that this content is part of. Will return -1 if - not part of a series. - series_title: - type: optional - docs: The title of the series that this content is part of. - node_id: - type: optional - docs: >- - The id of the series node that this ruleset is associated with. Each - block in a series has a corresponding node_id. - first_reply: - type: optional - docs: >- - The first time a user replied to this message if the content was able - to receive replies. - first_completion: - type: optional - docs: >- - The first time a user completed this message if the content was able - to be completed e.g. Tours, Surveys. - first_series_completion: - type: optional - docs: >- - The first time the series this message was a part of was completed by - the user. - first_series_disengagement: - type: optional - docs: >- - The first time the series this message was a part of was disengaged by - the user. - first_series_exit: - type: optional - docs: >- - The first time the series this message was a part of was exited by the - user. - first_goal_success: - type: optional - docs: >- - The first time the user met this messages associated goal if one - exists. - first_open: - type: optional - docs: The first time the user opened this message. - first_click: - type: optional - docs: >- - The first time the series the user clicked on a link within this - message. - first_dismisall: - type: optional - docs: The first time the series the user dismissed this message. - first_unsubscribe: - type: optional - docs: The first time the user unsubscribed from this message. - first_hard_bounce: - type: optional - docs: The first time this message hard bounced for this user - source: - openapi: ../openapi.yml DeletedArticleObject: docs: Response returned when an object is deleted properties: @@ -10247,49 +9798,6 @@ types: docs: The content of the group in Chinese (Taiwan) source: openapi: ../openapi.yml - IntercomVersion: - enum: - - value: '1.0' - name: One0 - - value: '1.1' - name: One1 - - value: '1.2' - name: One2 - - value: '1.3' - name: One3 - - value: '1.4' - name: One4 - - value: '2.0' - name: Two0 - - value: '2.1' - name: Two1 - - value: '2.2' - name: Two2 - - value: '2.3' - name: Two3 - - value: '2.4' - name: Two4 - - value: '2.5' - name: Two5 - - value: '2.6' - name: Two6 - - value: '2.7' - name: Two7 - - value: '2.8' - name: Two8 - - value: '2.9' - name: Two9 - - value: '2.10' - name: Two10 - - value: '2.11' - name: Two11 - - Unstable - docs: >- - Intercom API version.
By default, it's equal to the version set in the - app package. - default: '2.11' - source: - openapi: ../openapi.yml LinkedObjectType: enum: - ticket @@ -11366,20 +10874,6 @@ types: docs: Identifies if this visitor has do not track enabled. source: openapi: ../openapi.yml - VisitorDeletedObject: - docs: Response returned when an object is deleted - properties: - id: - type: optional - docs: The unique identifier for the visitor which is given by Intercom. - type: - type: optional> - docs: The type of object which was deleted - user_id: - type: optional - docs: Automatically generated identifier for the Visitor. - source: - openapi: ../openapi.yml imports: admins: admins.yml articles: articles.yml @@ -11391,7 +10885,6 @@ imports: conversations: conversations.yml customObjectInstances: customObjectInstances.yml dataAttributes: dataAttributes.yml - dataEvents: dataEvents.yml news: news.yml notes: notes.yml subscriptionTypes: subscriptionTypes.yml @@ -34373,46 +33866,6 @@ You can optionally define the result page size as well with the `per_page` param "openapi": "../openapi.yml", }, }, - "DataEvent": { - "docs": "Data events are used to notify Intercom of changes to your data.", - "properties": { - "created_at": { - "docs": "The time the event occurred as a UTC Unix timestamp", - "type": "integer", - }, - "email": { - "docs": "An email address for your user. An email should only be used where your application uses email to uniquely identify users.", - "type": "optional", - }, - "event_name": { - "docs": "The name of the event that occurred. This is presented to your App's admins when filtering and creating segments - a good event name is typically a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", - "type": "string", - }, - "id": { - "docs": "Your identifier for a lead or a user.", - "type": "optional", - }, - "intercom_user_id": { - "docs": "The Intercom identifier for the user.", - "type": "optional", - }, - "metadata": { - "docs": "Optional metadata about the event.", - "type": "optional>", - }, - "type": { - "docs": "The type of the object", - "type": "optional>", - }, - "user_id": { - "docs": "Your identifier for the user.", - "type": "optional", - }, - }, - "source": { - "openapi": "../openapi.yml", - }, - }, "LisDataEventsRequestFilter": { "discriminated": false, "docs": undefined, @@ -34509,41 +33962,6 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml - DataEvent: - docs: Data events are used to notify Intercom of changes to your data. - properties: - type: - type: optional> - docs: The type of the object - event_name: - type: string - docs: >- - The name of the event that occurred. This is presented to your App's - admins when filtering and creating segments - a good event name is - typically a past tense 'verb-noun' combination, to improve - readability, for example `updated-plan`. - created_at: - type: integer - docs: The time the event occurred as a UTC Unix timestamp - user_id: - type: optional - docs: Your identifier for the user. - id: - type: optional - docs: Your identifier for a lead or a user. - intercom_user_id: - type: optional - docs: The Intercom identifier for the user. - email: - type: optional - docs: >- - An email address for your user. An email should only be used where - your application uses email to uniquely identify users. - metadata: - type: optional> - docs: Optional metadata about the event. - source: - openapi: ../openapi.yml imports: root: __package__.yml service: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml index 602118874c2..6c4a1634deb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/fixtures/only-include-referenced-schemas/fern/generators.yml @@ -1,3 +1,5 @@ api: specs: - openapi: ../openapi.yml + settings: + only-include-referenced-schemas: true diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts index d39acbf2545..52ff8157ea0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts @@ -1,6 +1,14 @@ +import { assertNever } from "@fern-api/core-utils"; import { RawSchemas } from "@fern-api/fern-definition-schema"; import { Logger } from "@fern-api/logger"; -import { OpenApiIntermediateRepresentation, Schema, SchemaId, HttpMethod } from "@fern-api/openapi-ir"; +import { + OpenApiIntermediateRepresentation, + Schema, + SchemaId, + HttpMethod, + ObjectSchema, + OneOfSchema +} from "@fern-api/openapi-ir"; import { TaskContext } from "@fern-api/task-context"; import { FernDefinitionBuilder, FernDefinitionBuilderImpl } from "@fern-api/importer-commons"; import { isSchemaEqual } from "@fern-api/openapi-ir-parser"; @@ -139,12 +147,6 @@ export class OpenApiIrConverterContext { } } - public markSchemaAsReferenced(id: SchemaId): void { - if (this.referencedSchemaIds != null) { - this.referencedSchemaIds.add(id); - } - } - public getReferencedSchemaIds(): SchemaId[] | undefined { if (this.referencedSchemaIds == null) { return undefined; @@ -156,7 +158,6 @@ export class OpenApiIrConverterContext { if (namespace == null) { return this.ir.groupedSchemas.rootSchemas[id]; } - return this.ir.groupedSchemas.namespacedSchemas[namespace]?.[id]; } @@ -243,4 +244,80 @@ export class OpenApiIrConverterContext { public unsetInRequest(): void { this.inRequest = false; } + + /** + * Marks a schema as referenced. + */ + public markSchemaAsReferenced(schema: Schema, namespace: string | undefined): void { + switch (schema.type) { + case "primitive": + return; + case "object": + this.markObjectSchemaAsReferenced(schema, namespace); + return; + case "array": + this.markSchemaAsReferenced(schema.value, namespace); + return; + case "map": + this.markSchemaAsReferenced(schema.value, namespace); + return; + case "optional": + this.markSchemaAsReferenced(schema.value, namespace); + return; + case "reference": + this.markSchemaIdAsReferenced(schema.schema, namespace); + return; + case "oneOf": + this.markOneofSchemaAsReferenced(schema.value, namespace); + return; + case "nullable": + this.markSchemaAsReferenced(schema.value, namespace); + return; + case "enum": + return; + case "literal": + return; + case "unknown": + return; + default: + assertNever(schema); + } + } + + private markObjectSchemaAsReferenced(schema: ObjectSchema, namespace: string | undefined): void { + for (const allOf of schema.allOf) { + this.markSchemaIdAsReferenced(allOf.schema, namespace); + } + for (const property of schema.properties) { + this.markSchemaAsReferenced(property.schema, namespace); + } + } + + private markOneofSchemaAsReferenced(schema: OneOfSchema, namespace: string | undefined): void { + switch (schema.type) { + case "discriminated": + for (const oneOf of Object.values(schema.schemas)) { + this.markSchemaAsReferenced(oneOf, namespace); + } + return; + case "undisciminated": + for (const oneOf of schema.schemas) { + this.markSchemaAsReferenced(oneOf, namespace); + } + return; + default: + assertNever(schema); + } + } + + private markSchemaIdAsReferenced(id: SchemaId, namespace: string | undefined): void { + if (this.referencedSchemaIds != null && !this.referencedSchemaIds.has(id)) { + this.referencedSchemaIds.add(id); + + const schema = this.getSchema(id, namespace); + if (schema != null) { + this.markSchemaAsReferenced(schema, namespace); + } + } + } } diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts index ca5804a2bdb..dd705730267 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts @@ -58,6 +58,9 @@ export function buildTypeReference({ context: OpenApiIrConverterContext; namespace: string | undefined; }): RawSchemas.TypeReferenceSchema { + if (context.onlyIncludeReferencedSchemas && context.isInEndpoint()) { + context.markSchemaAsReferenced(schema, namespace); + } switch (schema.type) { case "primitive": { return buildPrimitiveTypeReference(schema); @@ -401,10 +404,6 @@ export function buildReferenceTypeReference({ context: OpenApiIrConverterContext; namespace: string | undefined; }): RawSchemas.TypeReferenceSchema { - if (context.onlyIncludeReferencedSchemas && context.isInEndpoint()) { - context.markSchemaAsReferenced(schema.schema); - } - const resolvedSchema = context.getSchema(schema.schema, namespace); if (resolvedSchema == null) { return "unknown"; From 4b6c52e47d4c6664e96d8f124b3c4dd81d69d8d1 Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Tue, 12 Nov 2024 19:39:40 -0500 Subject: [PATCH 5/8] Add tree-shaking support for webhooks and channels --- .../src/OpenApiIrConverterContext.ts | 80 ++++++++++++++++--- .../src/buildFernDefinition.ts | 4 + .../src/buildTypeReference.ts | 2 +- 3 files changed, 75 insertions(+), 11 deletions(-) diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts index 52ff8157ea0..332d0b1910f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts @@ -71,17 +71,10 @@ export class OpenApiIrConverterContext { /** * The set of referenced schema ids to include in the generated definition. * If this value is undefined, _all_ schemaIds should be treated as referenced, - * and included in the generated definition. + * and therefore included in the generated definition. */ private referencedSchemaIds: Set | undefined; - /** - * Whether the current schema being processed is part of an endpoint. - * This is used to determine whether certain properties should be included - * in the generated definition (e.g. endpoint tree-shaking). - */ - private inEndpoint = false; - /** * The current endpoint method being processed. This is used to determine * whether certain properties should be included in the generated definition @@ -89,6 +82,13 @@ export class OpenApiIrConverterContext { */ private endpointMethod: HttpMethod | undefined; + /** + * Whether the current schema being processed is part of an endpoint. + * This is used to determine whether certain properties should be included + * in the generated definition (e.g. endpoint tree-shaking). + */ + private inEndpoint = false; + /** * Whether the current schema being processed is part of a request body. * This is used to determine whether certain properties should be included @@ -96,6 +96,20 @@ export class OpenApiIrConverterContext { */ private inRequest = false; + /** + * Whether the current schema being processed is part of a webhook. + * This is used to determine whether certain properties should be included + * in the generated definition (e.g. webhook tree-shaking). + */ + private inWebhook = false; + + /** + * Whether the current schema being processed is part of a websocket channel. + * This is used to determine whether certain properties should be included + * in the generated definition (e.g. channel tree-shaking). + */ + private inChannel = false; + constructor({ taskContext, ir, @@ -211,14 +225,14 @@ export class OpenApiIrConverterContext { } /** - * Sets that we're currently processing a request + * Sets that we're currently processing an endpoint */ public setInEndpoint(): void { this.inEndpoint = true; } /** - * Unsets that we're currently processing a request + * Unsets that we're currently processing an endpoint */ public unsetInEndpoint(): void { this.inEndpoint = false; @@ -245,6 +259,52 @@ export class OpenApiIrConverterContext { this.inRequest = false; } + /** + * Returns whether we're currently processing a webhook + */ + public isInWebhook(): boolean { + return this.inWebhook; + } + + /** + * Sets that we're currently processing a webhook + */ + public setInWebhook(): void { + this.inWebhook = true; + } + + /** + * Unsets that we're currently processing a webhook + */ + public unsetInWebhook(): void { + this.inWebhook = false; + } + + /** + * Returns whether we're currently processing a channel + */ + public isInChannel(): boolean { + return this.inChannel; + } + + /** + * Sets that we're currently processing a channel + */ + public setInChannel(): void { + this.inChannel = true; + } + + /** + * Unsets that we're currently processing a channel + */ + public unsetInChannel(): void { + this.inChannel = false; + } + + public shouldMarkSchemaAsReferenced(): boolean { + return this.onlyIncludeReferencedSchemas && (this.inEndpoint || this.inWebhook || this.inChannel); + } + /** * Marks a schema as referenced. */ diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts index 578421a6b95..c758d5af254 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts @@ -76,13 +76,17 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef const sdkGroups = convertedServices.sdkGroups; let schemaIdsToExclude = convertedServices.schemaIdsToExclude; + context.setInWebhook(); buildWebhooks(context); + context.unsetInWebhook(); // Add Channels + context.setInChannel(); for (const channel of context.ir.channel) { const declarationFile = convertSdkGroupNameToFile(channel.groupName); buildChannel({ channel, context, declarationFile }); } + context.unsetInChannel(); const allSchemaIds = new Set(Object.keys(context.ir.groupedSchemas.rootSchemas)); for (const schemas of Object.values(context.ir.groupedSchemas.namespacedSchemas)) { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts index dd705730267..7c00ce49751 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts @@ -58,7 +58,7 @@ export function buildTypeReference({ context: OpenApiIrConverterContext; namespace: string | undefined; }): RawSchemas.TypeReferenceSchema { - if (context.onlyIncludeReferencedSchemas && context.isInEndpoint()) { + if (context.shouldMarkSchemaAsReferenced()) { context.markSchemaAsReferenced(schema, namespace); } switch (schema.type) { From 99860a4c49f0f4817a537d92d2e6c2dcc9e7f3da Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Wed, 13 Nov 2024 09:33:36 -0500 Subject: [PATCH 6/8] Run 'pnpm jsonschema' --- generators-yml.schema.json | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/generators-yml.schema.json b/generators-yml.schema.json index c9ada13b59d..8fa14777043 100644 --- a/generators-yml.schema.json +++ b/generators-yml.schema.json @@ -633,6 +633,16 @@ "type": "null" } ] + }, + "only-include-referenced-schemas": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } }, "additionalProperties": false @@ -1294,6 +1304,16 @@ "type": "null" } ] + }, + "only-include-referenced-schemas": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] } }, "additionalProperties": false From 3de3b6054097becc9e736f44d632cc2ef4115f1f Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Wed, 13 Nov 2024 12:43:48 -0500 Subject: [PATCH 7/8] Refactor with State enum --- .../src/OpenApiIrConverterContext.ts | 117 +++--------------- .../openapi/openapi-ir-to-fern/src/State.ts | 6 + .../openapi-ir-to-fern/src/buildEndpoint.ts | 5 +- .../src/buildFernDefinition.ts | 9 +- .../openapi-ir-to-fern/src/buildServices.ts | 5 +- .../src/buildTypeDeclaration.ts | 3 +- 6 files changed, 38 insertions(+), 107 deletions(-) create mode 100644 packages/cli/api-importers/openapi/openapi-ir-to-fern/src/State.ts diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts index 332d0b1910f..2eee404a724 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/OpenApiIrConverterContext.ts @@ -12,6 +12,7 @@ import { import { TaskContext } from "@fern-api/task-context"; import { FernDefinitionBuilder, FernDefinitionBuilderImpl } from "@fern-api/importer-commons"; import { isSchemaEqual } from "@fern-api/openapi-ir-parser"; +import { State } from "./State"; export interface OpenApiIrConverterContextOpts { taskContext: TaskContext; @@ -83,32 +84,11 @@ export class OpenApiIrConverterContext { private endpointMethod: HttpMethod | undefined; /** - * Whether the current schema being processed is part of an endpoint. - * This is used to determine whether certain properties should be included - * in the generated definition (e.g. endpoint tree-shaking). + * Tracks the state in which a schema is being processed (e.g. endpoint, channel, webhook, + * request). It's possible that a schema is being processed in multiple states (e.g. an + * endpoint and a request). */ - private inEndpoint = false; - - /** - * Whether the current schema being processed is part of a request body. - * This is used to determine whether certain properties should be included - * in the generated definition (e.g. readonly properties are excluded for request bodies). - */ - private inRequest = false; - - /** - * Whether the current schema being processed is part of a webhook. - * This is used to determine whether certain properties should be included - * in the generated definition (e.g. webhook tree-shaking). - */ - private inWebhook = false; - - /** - * Whether the current schema being processed is part of a websocket channel. - * This is used to determine whether certain properties should be included - * in the generated definition (e.g. channel tree-shaking). - */ - private inChannel = false; + private state: Set = new Set(); constructor({ taskContext, @@ -218,91 +198,28 @@ export class OpenApiIrConverterContext { } /** - * Returns whether we're currently processing an endpoint - */ - public isInEndpoint(): boolean { - return this.inEndpoint; - } - - /** - * Sets that we're currently processing an endpoint - */ - public setInEndpoint(): void { - this.inEndpoint = true; - } - - /** - * Unsets that we're currently processing an endpoint - */ - public unsetInEndpoint(): void { - this.inEndpoint = false; - } - - /** - * Returns whether we're currently processing a request + * Returns whether we're currently processing the given state. */ - public isInRequest(): boolean { - return this.inRequest; + public isInState(state: State): boolean { + return this.state.has(state); } /** - * Sets that we're currently processing a request + * Sets that we're currently processing the given state. */ - public setInRequest(): void { - this.inRequest = true; + public setInState(state: State): void { + this.state.add(state); } /** - * Unsets that we're currently processing a request + * Unsets that we're currently processing the given state. */ - public unsetInRequest(): void { - this.inRequest = false; - } - - /** - * Returns whether we're currently processing a webhook - */ - public isInWebhook(): boolean { - return this.inWebhook; - } - - /** - * Sets that we're currently processing a webhook - */ - public setInWebhook(): void { - this.inWebhook = true; - } - - /** - * Unsets that we're currently processing a webhook - */ - public unsetInWebhook(): void { - this.inWebhook = false; - } - - /** - * Returns whether we're currently processing a channel - */ - public isInChannel(): boolean { - return this.inChannel; - } - - /** - * Sets that we're currently processing a channel - */ - public setInChannel(): void { - this.inChannel = true; - } - - /** - * Unsets that we're currently processing a channel - */ - public unsetInChannel(): void { - this.inChannel = false; + public unsetInState(state: State): void { + this.state.delete(state); } public shouldMarkSchemaAsReferenced(): boolean { - return this.onlyIncludeReferencedSchemas && (this.inEndpoint || this.inWebhook || this.inChannel); + return this.onlyIncludeReferencedSchemas && this.isInAnyState(State.Channel, State.Endpoint, State.Webhook); } /** @@ -380,4 +297,8 @@ export class OpenApiIrConverterContext { } } } + + private isInAnyState(...states: State[]): boolean { + return states.some((state) => this.isInState(state)); + } } diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/State.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/State.ts new file mode 100644 index 00000000000..db2b48dc37f --- /dev/null +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/State.ts @@ -0,0 +1,6 @@ +export enum State { + Channel, + Endpoint, + Request, + Webhook +} diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts index 775a59e5551..74688692888 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts @@ -17,6 +17,7 @@ import { getDocsFromTypeReference, getTypeFromTypeReference } from "./utils/getT import { getEndpointNamespace } from "./utils/getNamespaceFromGroup"; import { resolveLocationWithNamespace } from "./utils/convertSdkGroupName"; import { convertToSourceSchema } from "./utils/convertToSourceSchema"; +import { State } from "./State"; export interface ConvertedEndpoint { value: RawSchemas.HttpEndpointSchema; @@ -124,7 +125,7 @@ export function buildEndpoint({ } if (endpoint.request != null) { - context.setInRequest(); + context.setInState(State.Request); const convertedRequest = getRequest({ endpoint, context, @@ -140,7 +141,7 @@ export function buildEndpoint({ }); convertedEndpoint.request = convertedRequest.value; schemaIdsToExclude = [...schemaIdsToExclude, ...(convertedRequest.schemaIdsToExclude ?? [])]; - context.unsetInRequest(); + context.unsetInState(State.Request); } else { const hasQueryParams = Object.keys(queryParameters).length > 0; const hasHeaders = Object.keys(headers).length > 0; diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts index c758d5af254..1ad4bdcbcc3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts @@ -16,6 +16,7 @@ import { getDeclarationFileForSchema } from "./utils/getDeclarationFileForSchema import { getTypeFromTypeReference } from "./utils/getTypeFromTypeReference"; import { convertSdkGroupNameToFile } from "./utils/convertSdkGroupName"; import { Schema } from "@fern-api/openapi-ir"; +import { State } from "./State"; export const ROOT_PREFIX = "root"; export const EXTERNAL_AUDIENCE = "external"; @@ -76,17 +77,17 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef const sdkGroups = convertedServices.sdkGroups; let schemaIdsToExclude = convertedServices.schemaIdsToExclude; - context.setInWebhook(); + context.setInState(State.Webhook); buildWebhooks(context); - context.unsetInWebhook(); + context.unsetInState(State.Webhook); // Add Channels - context.setInChannel(); + context.setInState(State.Channel); for (const channel of context.ir.channel) { const declarationFile = convertSdkGroupNameToFile(channel.groupName); buildChannel({ channel, context, declarationFile }); } - context.unsetInChannel(); + context.unsetInState(State.Channel); const allSchemaIds = new Set(Object.keys(context.ir.groupedSchemas.rootSchemas)); for (const schemas of Object.values(context.ir.groupedSchemas.namespacedSchemas)) { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts index e83ac054859..26c45ce386d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildServices.ts @@ -1,6 +1,7 @@ import { FernOpenapiIr } from "@fern-api/openapi-ir"; import { buildEndpoint } from "./buildEndpoint"; import { OpenApiIrConverterContext } from "./OpenApiIrConverterContext"; +import { State } from "./State"; import { convertToSourceSchema } from "./utils/convertToSourceSchema"; import { getEndpointLocation } from "./utils/getEndpointLocation"; @@ -35,7 +36,7 @@ export function buildServices(context: OpenApiIrConverterContext): ConvertedServ } const irTag = tag == null ? undefined : tags.tagsById[tag]; - context.setInEndpoint(); + context.setInState(State.Endpoint); context.setEndpointMethod(endpoint.method); const convertedEndpoint = buildEndpoint({ context, @@ -43,7 +44,7 @@ export function buildServices(context: OpenApiIrConverterContext): ConvertedServ declarationFile: file }); context.unsetEndpointMethod(); - context.unsetInEndpoint(); + context.unsetInState(State.Endpoint); schemaIdsToExclude = [...schemaIdsToExclude, ...convertedEndpoint.schemaIdsToExclude]; context.builder.addEndpoint(file, { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts index 1b86a4e7389..50f07a344ea 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts @@ -31,6 +31,7 @@ import { convertAvailability } from "./utils/convertAvailability"; import { convertToEncodingSchema } from "./utils/convertToEncodingSchema"; import { convertToSourceSchema } from "./utils/convertToSourceSchema"; import { getTypeFromTypeReference } from "./utils/getTypeFromTypeReference"; +import { State } from "./State"; export interface ConvertedTypeDeclaration { name: string | undefined; @@ -88,7 +89,7 @@ export function buildObjectTypeDeclaration({ namespace: string | undefined; }): ConvertedTypeDeclaration { const shouldSkipReadonly = - context.isInRequest() && + context.isInState(State.Request) && context.respectReadonlySchemas && (context.getEndpointMethod() === "POST" || context.getEndpointMethod() === "PUT" || From 3be530fc5397b3600fbdacc6076dda3d3897006c Mon Sep 17 00:00:00 2001 From: Alex McKinney Date: Wed, 13 Nov 2024 12:55:00 -0500 Subject: [PATCH 8/8] Clear up control flow with getSchemaIdsToExclude helper function --- .../src/buildFernDefinition.ts | 56 ++++++++++++------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts index 1ad4bdcbcc3..b312a42daea 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts @@ -75,7 +75,6 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef const convertedServices = buildServices(context); const sdkGroups = convertedServices.sdkGroups; - let schemaIdsToExclude = convertedServices.schemaIdsToExclude; context.setInState(State.Webhook); buildWebhooks(context); @@ -89,27 +88,11 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef } context.unsetInState(State.Channel); - const allSchemaIds = new Set(Object.keys(context.ir.groupedSchemas.rootSchemas)); - for (const schemas of Object.values(context.ir.groupedSchemas.namespacedSchemas)) { - for (const schemaId of Object.keys(schemas)) { - allSchemaIds.add(schemaId); - } - } - - const referencedSchemaIds = context.getReferencedSchemaIds(); - if (referencedSchemaIds != null) { - // If we're restricting to only referenced schemas, we need to - // exclude all schemas that aren't referenced. - const schemaIdsToExcludeSet = new Set(schemaIdsToExclude); - for (const schemaId of allSchemaIds) { - if (!referencedSchemaIds.includes(schemaId)) { - schemaIdsToExcludeSet.add(schemaId); - } - } - schemaIdsToExclude = Array.from(schemaIdsToExcludeSet); - } - // Add Schemas + const schemaIdsToExclude = getSchemaIdsToExclude({ + context, + schemaIdsToExcludeFromServices: convertedServices.schemaIdsToExclude + }); addSchemas({ schemas: context.ir.groupedSchemas.rootSchemas, schemaIdsToExclude, namespace: undefined, context }); for (const [namespace, schemas] of Object.entries(context.ir.groupedSchemas.namespacedSchemas)) { addSchemas({ schemas, schemaIdsToExclude, namespace, context }); @@ -128,3 +111,34 @@ export function buildFernDefinition(context: OpenApiIrConverterContext): FernDef return context.builder.build(); } + +function getSchemaIdsToExclude({ + context, + schemaIdsToExcludeFromServices +}: { + context: OpenApiIrConverterContext; + schemaIdsToExcludeFromServices: string[]; +}): string[] { + const referencedSchemaIds = context.getReferencedSchemaIds(); + if (referencedSchemaIds == null) { + // No further filtering is required; we can return the + // excluded schemas as-is. + return schemaIdsToExcludeFromServices; + } + + // Retrieve all the schema IDs, then exclude all the schemas that + // aren't explicitly referenced. + const allSchemaIds = new Set([ + ...Object.keys(context.ir.groupedSchemas.rootSchemas), + ...Object.values(context.ir.groupedSchemas.namespacedSchemas).flatMap((schemas) => Object.keys(schemas)) + ]); + + const schemaIdsToExcludeSet = new Set(schemaIdsToExcludeFromServices); + for (const schemaId of allSchemaIds) { + if (!referencedSchemaIds.includes(schemaId)) { + schemaIdsToExcludeSet.add(schemaId); + } + } + + return Array.from(schemaIdsToExcludeSet); +}